Configuration Settings for XML File Context Provider

The XML File context provider is an IdAS context provider where identity information is stored in an XML file. Settings for the context provider may be embedded in the [..IdASRegistry IdAS Registry settings]. For more information on how context provider settings are embedded in the IdAS Registry settings, see the ContextIdsList Setting subsection.

Settings for the XML file context provider are described in the following sections.

XmlFileName Setting

The Type for this setting is "xsd:string" (Java String). It contains the name of the XML file that holds the identity data. It should be a full path name. This is illustrated below:

   <Setting Name="ContextIdsList" Type="htf:list">
      <Setting Name="urn:XmlFileProvider" Type="htf:map" >      <!-- The Name of this setting is ignored because the parent setting is a list -->
         <Setting Name="ContextId" Type="xsd:string">urn:XmlFileProvider</Setting>
         <Setting Name="ContextTypes" Type="htf:list">
            <Setting Name="XMLFileContextType" Type="xsd:string">$context+xmlfile</Setting>
         </Setting>
         <Setting Name="ContextUris" Type="htf:list">
            <Setting Name="DefaultContextUri" Type="xsd:anyURI">urn:XmlFileProvider</Setting>
         </Setting>

         <!-- Context provider specific settings go here -->

         <Setting Name="XmlFileName" Type="xsd:string">/data/myIdentities.xml</Setting>

      </Setting>
      ...
   </Setting>

AuditRecordClass Setting

The Type of this setting is "xsd:string" (Java String). It is optional. If present, it contains the name of the class that implements the org.eclipse.higgins.audit.api.AuditRecord interface. Objects of this class are used to log audit events. If this setting is missing, audit events will not be logged. The OTIS SDK provides a class that implements this interface - org.bandit.otis.impl.OtisAuditRecord. This particular implementation formats audit records according to the XDAS record format. Specifying this class as the audit record class is illustrated below:

   <Setting Name="AuditRecordClass" Type="xsd:string">org.bandit.otis.impl.OtisAuditRecord</Setting>

Note that audit event records are logged to a logger named higgins.audit.events. If you are using log4j to do logging, OTIS also provides a log4j appender that will log the audit records to the XDAS Daemon. The appender class is org.bandit.otis.impl.OtisAuditAppender. This appender can be included in your log4j.properties file to cause audit events to be sent to the XDAS Daemon. The log4j settings to do this are illustrated below:

# Specify an appender for audit events.  All audit events are sent to the higgins.audit.events logger.
# We therefore create an appender for that logger.  We also set the additivity property of the
# logger to false, so that audit events will ONLY go to that appender.

log4j.logger.higgins.audit.events=trace, auditappender
log4j.additivity.higgins.audit.events=false
log4j.appender.auditappender=org.bandit.otis.impl.OtisAuditAppender