Jolokia - Reference Documentation Version 1.7.1 Copyright © 2010 - 2021 Roland Huß 1. Introduction .............................................................. 1 2. Architecture .............................................................. 2 2.1. Agent mode . 2 2.2. Proxy Mode . 2 3. Agents ................................................................... 4 3.1. Java EE Agent (WAR) . 5 3.1.1. Installation and Configuration . 5 3.1.2. Security Setup . 11 3.1.3. Programmatic usage of the Jolokia agent servlet . 11 3.2. OSGi Agents . 12 3.2.1. jolokia-osgi.jar . 12 3.2.2. Running on Glassfish v3 upwards . 18 3.2.3. jolokia-osgi-bundle.jar . 19 3.2.4. Programmatic servlet registration . 19 3.2.5. Restrictor service . 19 3.3. Mule Agent . 20 3.4. JVM Agent . 22 3.4.1. Jolokia as JVM Agent . 22 3.4.2. Attaching a Jolokia agent on the fly . 30 4. Security ................................................................. 34 4.1. Policy based security . 34 4.1.1. IP based restrictions . 34 4.1.2. Commands . 34 4.1.3. Allow and deny access to certain MBeans . 35 4.1.4. HTTP method restrictions . 35 4.1.5. Cross-Origin Resource Sharing (CORS) restrictions . 36 4.1.6. Example for a security policy . 36 4.1.7. Policy Location . 37 4.2. Jolokia Restrictors . 38 5. Proxy Mode .............................................................. 39 5.1. Limitations of proxy mode . 40 6. Jolokia Protocol .......................................................... 41 6.1. Requests and Responses . 41 6.1.1. GET requests . 41 6.1.2. POST requests . 43 6.1.3. Responses . 44 6.1.4. Paths . 45 6.2. Jolokia operations . 46 6.2.1. Reading attributes (read) . 46 6.2.2. Writing attributes (write) . 50 6.2.3. Executing JMX operations (exec) . 52 6.2.4. Searching MBeans (search) . 54 6.2.5. Listing MBeans (list) . 55 6.2.6. Getting the agent version (version) . 58 6.3. Processing parameters . 59 6.4. Object serialization . 60 6.4.1. Response value serialization . 61 6.4.2. Request parameter serialization . 63 6.4.3. Jolokia and MXBeans . 65 6.5. Tracking historical values . 66 6.6. Proxy requests . 66 Jolokia (1.7.1) ii Jolokia - Reference Documentation 6.7. Agent Discovery . 67 6.8. Jolokia protocol versions . 69 7. Jolokia MBeans .......................................................... 71 7.1. Configuration MBean . 71 7.1.1. Debugging . 71 7.1.2. History store . 71 7.2. Server Handler . 72 7.3. Discovery MBean . 72 8. Clients .................................................................. 74 8.1. Javascript Client Library . 74 8.1.1. Installation . 74 8.1.2. Usage . 75 8.1.3. Simple API . 79 8.1.4. Request scheduler . 81 8.1.5. Jolokia as a Cubism Source . 83 8.1.6. Maven integration . 85 8.2. Java Client Library . 86 8.2.1. Tutorial . 87 8.2.2. J4pClient . 88 8.2.3. Request types . 92 8.2.4. Exceptions . 94 9. Jolokia JMX ............................................................. 95 9.1. Jolokia MBeanServer . 95 9.1.1. MBeanServer merging . 95 9.2. @JsonMBean . 96 9.3. Spring Support . 97 9.3.1. JVM agent . 97 9.3.2. Jolokia MBeanServer . ..