#224: Added documentation

jolokia · Jan 18, 2016 · 3311265 · 3311265
1 parent 5da7d52
commit 3311265
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 2 deletions.
diff --git a/src/docbkx/agents/jvm.xml b/src/docbkx/agents/jvm.xml
@@ -498,6 +498,7 @@ where <command> is one of
     status    -- Show status of an (potentially) attached agent
     toggle    -- Toggle between start/stop (default when no command is given)
     list      -- List all attachable Java processes (default when no argument is given at all)
+    encrypt   -- Encrypt a password which is given as argument or read from standard input
 
 [options] are used for providing runtime information for attaching the agent:
 
@@ -538,6 +539,7 @@ where <command> is one of
     --maxObjects <nr>              Maximum number of objects to consider for serialization 
                                    (default: maxObjects)
     --policyLocation <url>         Location of a Jolokia policy file
+    --restrictorClass <class>       Classname of an custom restrictor which must be loadable from the classpath
     --mbeanQualifier <qualifier>   Qualifier to use when registering Jolokia internal MBeans
     --canonicalNaming <t|f>        whether to use canonicalName for ObjectNames in 'list' or 'search' 
                                    (default: true)

diff --git a/src/docbkx/agents/war.xml b/src/docbkx/agents/war.xml
@@ -105,14 +105,25 @@
           <literal>classpath:</literal> which is used for looking up
           the policy file in the web application's classpath. See
           <xref linkend="security-policy-location"/> for details about this
-          parameter. 
+          parameter.
         </td>
         <td>
           <filename>file:///home/jolokia/jolokia-access.xml</filename>
-          for a file based access to the policy file. Default is 
+          for a file based access to the policy file. Default is
           <filename>classpath:/jolokia-access.xml</filename>
         </td>
       </tr>
+      <tr>
+        <td><constant>restrictorClass</constant></td>
+        <td>
+          Full classname of an implementation of <literal>org.jolokia.restrictor.Restrictor</literal>
+          which is used as a custom restrictor for securing access via Jolokia.
+        </td>
+        <td>
+          <literal>com.mycompany.jolokia.CustomRestrictor</literal> (which must be included in the
+          war file and must implement <literal>org.jolokia.restrictor.Restrictor</literal>)
+        </td>
+      </tr>
       <tr>
         <td><constant>debug</constant></td>
         <td>