Jolokia - Reference Documentation

Version 1.2.3

Table of Contents

1. Introduction
2. Architecture
2.1. Agent mode
2.2. Proxy Mode
3. Agents
3.1. JEE Agent (WAR)
3.1.1. Installation and Configuration
3.1.2. Security Setup
3.1.3. Programmatic usage of the Jolokia agent servlet
3.2. OSGi Agents
3.2.1. jolokia-osgi.jar
3.2.2. Running on Glassfish v3 upwards
3.2.3. jolokia-osgi-bundle.jar
3.2.4. Programmatic servlet registration
3.2.5. Restrictor service
3.3. Mule Agent
3.4. JVM Agent
3.4.1. Jolokia as JVM Agent
3.4.2. Attaching a Jolokia agent on the fly
4. Security
4.1. Policy based security
4.1.1. IP based restrictions
4.1.2. Commands
4.1.3. Allow and deny access to certain MBeans
4.1.4. HTTP method restrictions
4.1.5. Cross-Origin Resource Sharing (CORS) restrictions
4.1.6. Example for a security policy
4.1.7. Policy Location
4.2. Jolokia Restrictors
5. Proxy Mode
5.1. Limitations of proxy mode
6. Jolokia Protocol
6.1. Requests and Responses
6.1.1. GET requests
6.1.2. POST requests
6.1.3. Responses
6.1.4. Paths
6.2. Jolokia operations
6.2.1. Reading attributes (read)
6.2.2. Writing attributes (write)
6.2.3. Executing JMX operations (exec)
6.2.4. Searching MBeans (search)
6.2.5. Listing MBeans (list)
6.2.6. Getting the agent version (version)
6.3. Processing parameters
6.4. Object serialization
6.4.1. Response value serialization
6.4.2. Request parameter serialization
6.4.3. Jolokia and MXBeans
6.5. Tracking historical values
6.6. Proxy requests
6.7. Agent Discovery
6.8. Jolokia protocol versions
7. Jolokia MBeans
7.1. Configuration MBean
7.1.1. Debugging
7.1.2. History store
7.2. Server Handler
7.3. Discovery MBean
8. Clients
8.1. Javascript Client Library
8.1.1. Installation
8.1.2. Usage
8.1.3. Simple API
8.1.4. Request scheduler
8.1.5. Jolokia as a Cubism Source
8.1.6. Maven integration
8.2. Java Client Library
8.2.1. Tutorial
8.2.2. J4pClient
8.2.3. Request types
8.2.4. Exceptions
9. Jolokia JMX
9.1. Jolokia MBeanServer
9.1.1. MBeanServer merging
9.2. @JsonMBean
9.3. Spring Support
9.3.1. JVM agent
9.3.2. Jolokia MBeanServer
9.3.3. Jolokia Spring plugin
10. Tools
10.1. Jmx4Perl
10.2. Jolokia Roo Addon

List of Examples

6.1. JSON Request
6.2. JSON Response