Extending Principal Store API (Custom Store Access)

Various components of the Security Model communicate with the Principal Store (user and role store) using the Principal Store API. This API has been written in Java and you can extend this API to communicate with any specific data store of your choice.

Principal Store API architecture

Please refer the diagram to understand the API architecture. Also refer to the JavaDoc for the Principal Store API.

The Security.XML file contains configuration parameters (as key value pairs) for the various stores. The SecurityFactory class used within the manager creates objects of type ArcGISSecurityStore with a particular implementation. The SecurityFactory class calls the init method on the implementation of ArcGISSecurityStore and passes a hash map of all the configuration parameters from the Security.XML. You can implement the 'init' method to read the configuration parameters that your class needs to initialize itself.

How to extend the Principal Store API

1. Implement SecurityStore interface in your custom class.

2. Add/Edit properties in Security.XML file (as key value pairs - using Java Properties Class) required by your custom implementation. The Security.XML is present in \ArcGIS\java\manager\service\lib directory.

3. Copy the jar files containing the custom store implementations to ArcGIS\java\manager\config\security\lib directory.

4. Restart the manager service.