See the documentation for your JMS message broker for the required value.
The default is the connection factory name for Apache ActiveMQ.",
"propertyOrder" : 6800,
"required" : true,
"type" : "string",
"exampleValue" : ""
},
"jndiTopicName" : {
"title" : "JMS Topic Name",
"description" : "JNDI lookup name for the JMS topic",
"propertyOrder" : 6700,
"required" : true,
"type" : "string",
"exampleValue" : ""
},
"sessionMode" : {
"title" : "Session Mode",
"description" : "Specifies the JMS session acknowledgement mode: AUTO, CLIENT, or DUPS_OK.
Use the default setting unless your JMS broker implementation requires otherwise. See your broker documentation for more information.", "propertyOrder" : 6500, "required" : true, "type" : "string", "exampleValue" : "" }, "deliveryMode" : { "title" : "Delivery Mode", "description" : "Specifies whether JMS messages used to transmit audit events use persistent or non-persistent delivery.
With persistent delivery, the JMS provider ensures that messages are not lost in transit in case of a provider failure by logging messages to storage when they are sent.
Specify the delivery mode as persistent if it is unacceptable for delivery of audit events to be lost in JMS transit. If the possible loss of audit events is acceptable, choose non-persistent delivery, which provides better performance.", "propertyOrder" : 6400, "required" : true, "type" : "string", "exampleValue" : "" }, "jndiContextProperties" : { "title" : "JNDI Context Properties", "description" : "Specifies JNDI properties that OpenAM uses to connect to the JMS message broker to which OpenAM will publish audit events.
OpenAM acts as a JMS client, using a JMS connection factory to connect to your JMS message broker. In order for OpenAM to connect to the broker, the JNDI context properties must conform to those needed by the broker. See the documentation for your JMS message broker for required values.
The default properties are example properties for connecting to Apache ActiveMQ.",
"propertyOrder" : 6600,
"required" : true,
"patternProperties" : {
".*" : {
"type" : "string"
}
},
"type" : "object",
"exampleValue" : ""
}
}
},
"commonHandler" : {
"type" : "object",
"title" : "General Handler Configuration",
"propertyOrder" : 0,
"properties" : {
"topics" : {
"title" : "Topics",
"description" : "List of topics handled by an audit event handler.",
"propertyOrder" : 6300,
"required" : true,
"items" : {
"type" : "string"
},
"type" : "array",
"exampleValue" : ""
},
"enabled" : {
"title" : "Enabled",
"description" : "Enables or disables an audit event handler.",
"propertyOrder" : 6200,
"required" : true,
"type" : "boolean",
"exampleValue" : ""
}
}
},
"batchEvents" : {
"type" : "object",
"title" : "Batch Events",
"propertyOrder" : 3,
"properties" : {
"maxBatchedEvents" : {
"title" : "Max Batched",
"description" : "Maximum number of events per batch.",
"propertyOrder" : 7100,
"required" : true,
"type" : "integer",
"exampleValue" : ""
},
"batchCapacity" : {
"title" : "Capacity",
"description" : "Maximum event count in the batch queue; additional events are dropped.",
"propertyOrder" : 7000,
"required" : true,
"type" : "integer",
"exampleValue" : ""
},
"pollTimeoutSec" : {
"title" : "Writing Interval",
"description" : "The interval (in seconds) for reading events from the buffer to transmit via jms.",
"propertyOrder" : 7400,
"required" : true,
"type" : "integer",
"exampleValue" : ""
}
}
},
"commonHandlerPlugin" : {
"type" : "object",
"title" : "Audit Event Handler Factory",
"propertyOrder" : 1,
"properties" : {
"handlerFactory" : {
"title" : "Factory Class Name",
"description" : "The fully qualified class name of the factory responsible for creating the Audit Event Handler. The class must implement org.forgerock.openam.audit.AuditEventHandlerFactory.",
"propertyOrder" : 7600,
"required" : true,
"type" : "string",
"exampleValue" : ""
}
}
}
}
}
```
### delete
**Usage**
```
am> delete Jms --realm Realm --id id
```
**Parameters**
* *\--id*
The unique identifier for the resource.
### getAllTypes
Obtain the collection of all secondary configuration types related to the resource.
**Usage**
```
am> action Jms --realm Realm --actionName getAllTypes
```
### getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
**Usage**
```
am> action Jms --realm Realm --actionName getCreatableTypes
```
### nextdescendents
Obtain the collection of secondary configuration instances that have been added to the resource.
**Usage**
```
am> action Jms --realm Realm --actionName nextdescendents
```
### query
Get the full list of instances of this collection. This query only supports `_queryFilter=true` filter.
**Usage**
```
am> query Jms --realm Realm --filter filter
```
**Parameters**
* *\--filter*
A CREST formatted query filter, where "true" will query all.
### read
**Usage**
```
am> read Jms --realm Realm --id id
```
**Parameters**
* *\--id*
The unique identifier for the resource.
### update
**Usage**
```
am> update Jms --realm Realm --id id --body body
```
**Parameters**
* *\--id*
The unique identifier for the resource.
* *\--body*
The resource in JSON format, described by the following JSON schema:
```json
{
"type" : "object",
"properties" : {
"jmsConfiguration" : {
"type" : "object",
"title" : "JMS Configuration",
"propertyOrder" : 2,
"properties" : {
"jndiConnectionFactoryName" : {
"title" : "JMS Connection Factory Name",
"description" : "Specifies the JNDI lookup name for the connection factory exposed by your JMS message broker. OpenAM performs a JNDI lookup on this name to locate your broker's connection factory.
See the documentation for your JMS message broker for the required value.
The default is the connection factory name for Apache ActiveMQ.",
"propertyOrder" : 6800,
"required" : true,
"type" : "string",
"exampleValue" : ""
},
"jndiTopicName" : {
"title" : "JMS Topic Name",
"description" : "JNDI lookup name for the JMS topic",
"propertyOrder" : 6700,
"required" : true,
"type" : "string",
"exampleValue" : ""
},
"sessionMode" : {
"title" : "Session Mode",
"description" : "Specifies the JMS session acknowledgement mode: AUTO, CLIENT, or DUPS_OK.
Use the default setting unless your JMS broker implementation requires otherwise. See your broker documentation for more information.", "propertyOrder" : 6500, "required" : true, "type" : "string", "exampleValue" : "" }, "deliveryMode" : { "title" : "Delivery Mode", "description" : "Specifies whether JMS messages used to transmit audit events use persistent or non-persistent delivery.
With persistent delivery, the JMS provider ensures that messages are not lost in transit in case of a provider failure by logging messages to storage when they are sent.
Specify the delivery mode as persistent if it is unacceptable for delivery of audit events to be lost in JMS transit. If the possible loss of audit events is acceptable, choose non-persistent delivery, which provides better performance.", "propertyOrder" : 6400, "required" : true, "type" : "string", "exampleValue" : "" }, "jndiContextProperties" : { "title" : "JNDI Context Properties", "description" : "Specifies JNDI properties that OpenAM uses to connect to the JMS message broker to which OpenAM will publish audit events.
OpenAM acts as a JMS client, using a JMS connection factory to connect to your JMS message broker. In order for OpenAM to connect to the broker, the JNDI context properties must conform to those needed by the broker. See the documentation for your JMS message broker for required values.
The default properties are example properties for connecting to Apache ActiveMQ.",
"propertyOrder" : 6600,
"required" : true,
"patternProperties" : {
".*" : {
"type" : "string"
}
},
"type" : "object",
"exampleValue" : ""
}
}
},
"commonHandler" : {
"type" : "object",
"title" : "General Handler Configuration",
"propertyOrder" : 0,
"properties" : {
"topics" : {
"title" : "Topics",
"description" : "List of topics handled by an audit event handler.",
"propertyOrder" : 6300,
"required" : true,
"items" : {
"type" : "string"
},
"type" : "array",
"exampleValue" : ""
},
"enabled" : {
"title" : "Enabled",
"description" : "Enables or disables an audit event handler.",
"propertyOrder" : 6200,
"required" : true,
"type" : "boolean",
"exampleValue" : ""
}
}
},
"batchEvents" : {
"type" : "object",
"title" : "Batch Events",
"propertyOrder" : 3,
"properties" : {
"maxBatchedEvents" : {
"title" : "Max Batched",
"description" : "Maximum number of events per batch.",
"propertyOrder" : 7100,
"required" : true,
"type" : "integer",
"exampleValue" : ""
},
"batchCapacity" : {
"title" : "Capacity",
"description" : "Maximum event count in the batch queue; additional events are dropped.",
"propertyOrder" : 7000,
"required" : true,
"type" : "integer",
"exampleValue" : ""
},
"pollTimeoutSec" : {
"title" : "Writing Interval",
"description" : "The interval (in seconds) for reading events from the buffer to transmit via jms.",
"propertyOrder" : 7400,
"required" : true,
"type" : "integer",
"exampleValue" : ""
}
}
},
"commonHandlerPlugin" : {
"type" : "object",
"title" : "Audit Event Handler Factory",
"propertyOrder" : 1,
"properties" : {
"handlerFactory" : {
"title" : "Factory Class Name",
"description" : "The fully qualified class name of the factory responsible for creating the Audit Event Handler. The class must implement org.forgerock.openam.audit.AuditEventHandlerFactory.",
"propertyOrder" : 7600,
"required" : true,
"type" : "string",
"exampleValue" : ""
}
}
}
}
}
```
## Global Operations
Resource path:
```
/global-config/services/audit/JMS
```
Resource version: `1.0`
### create
**Usage**
```
am> create Jms --global --id id --body body
```
**Parameters**
* *\--id*
The unique identifier for the resource.
* *\--body*
The resource in JSON format, described by the following JSON schema:
```json
{
"type" : "object",
"properties" : {
"jmsConfiguration" : {
"type" : "object",
"title" : "JMS Configuration",
"propertyOrder" : 2,
"properties" : {
"jndiContextProperties" : {
"title" : "JNDI Context Properties",
"description" : "Specifies JNDI properties that OpenAM uses to connect to the JMS message broker to which OpenAM will publish audit events.
OpenAM acts as a JMS client, using a JMS connection factory to connect to your JMS message broker. In order for OpenAM to connect to the broker, the JNDI context properties must conform to those needed by the broker. See the documentation for your JMS message broker for required values.
The default properties are example properties for connecting to Apache ActiveMQ.",
"propertyOrder" : 6600,
"required" : true,
"patternProperties" : {
".*" : {
"type" : "string"
}
},
"type" : "object",
"exampleValue" : ""
},
"jndiTopicName" : {
"title" : "JMS Topic Name",
"description" : "JNDI lookup name for the JMS topic",
"propertyOrder" : 6700,
"required" : true,
"type" : "string",
"exampleValue" : ""
},
"sessionMode" : {
"title" : "Session Mode",
"description" : "Specifies the JMS session acknowledgement mode: AUTO, CLIENT, or DUPS_OK.
Use the default setting unless your JMS broker implementation requires otherwise. See your broker documentation for more information.", "propertyOrder" : 6500, "required" : true, "type" : "string", "exampleValue" : "" }, "deliveryMode" : { "title" : "Delivery Mode", "description" : "Specifies whether JMS messages used to transmit audit events use persistent or non-persistent delivery.
With persistent delivery, the JMS provider ensures that messages are not lost in transit in case of a provider failure by logging messages to storage when they are sent.
Specify the delivery mode as persistent if it is unacceptable for delivery of audit events to be lost in JMS transit. If the possible loss of audit events is acceptable, choose non-persistent delivery, which provides better performance.", "propertyOrder" : 6400, "required" : true, "type" : "string", "exampleValue" : "" }, "jndiConnectionFactoryName" : { "title" : "JMS Connection Factory Name", "description" : "Specifies the JNDI lookup name for the connection factory exposed by your JMS message broker. OpenAM performs a JNDI lookup on this name to locate your broker's connection factory.
See the documentation for your JMS message broker for the required value.
The default is the connection factory name for Apache ActiveMQ.",
"propertyOrder" : 6800,
"required" : true,
"type" : "string",
"exampleValue" : ""
}
}
},
"commonHandler" : {
"type" : "object",
"title" : "General Handler Configuration",
"propertyOrder" : 0,
"properties" : {
"topics" : {
"title" : "Topics",
"description" : "List of topics handled by an audit event handler.",
"propertyOrder" : 6300,
"required" : true,
"items" : {
"type" : "string"
},
"type" : "array",
"exampleValue" : ""
},
"enabled" : {
"title" : "Enabled",
"description" : "Enables or disables an audit event handler.",
"propertyOrder" : 6200,
"required" : true,
"type" : "boolean",
"exampleValue" : ""
}
}
},
"batchEvents" : {
"type" : "object",
"title" : "Batch Events",
"propertyOrder" : 3,
"properties" : {
"batchCapacity" : {
"title" : "Capacity",
"description" : "Maximum event count in the batch queue; additional events are dropped.",
"propertyOrder" : 7000,
"required" : true,
"type" : "integer",
"exampleValue" : ""
},
"pollTimeoutSec" : {
"title" : "Writing Interval",
"description" : "The interval (in seconds) for reading events from the buffer to transmit via jms.",
"propertyOrder" : 7400,
"required" : true,
"type" : "integer",
"exampleValue" : ""
},
"maxBatchedEvents" : {
"title" : "Max Batched",
"description" : "Maximum number of events per batch.",
"propertyOrder" : 7100,
"required" : true,
"type" : "integer",
"exampleValue" : ""
}
}
},
"commonHandlerPlugin" : {
"type" : "object",
"title" : "Audit Event Handler Factory",
"propertyOrder" : 1,
"properties" : {
"handlerFactory" : {
"title" : "Factory Class Name",
"description" : "The fully qualified class name of the factory responsible for creating the Audit Event Handler. The class must implement org.forgerock.openam.audit.AuditEventHandlerFactory.",
"propertyOrder" : 7600,
"required" : true,
"type" : "string",
"exampleValue" : ""
}
}
}
}
}
```
### delete
**Usage**
```
am> delete Jms --global --id id
```
**Parameters**
* *\--id*
The unique identifier for the resource.
### getAllTypes
Obtain the collection of all secondary configuration types related to the resource.
**Usage**
```
am> action Jms --global --actionName getAllTypes
```
### getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
**Usage**
```
am> action Jms --global --actionName getCreatableTypes
```
### nextdescendents
Obtain the collection of secondary configuration instances that have been added to the resource.
**Usage**
```
am> action Jms --global --actionName nextdescendents
```
### query
Get the full list of instances of this collection. This query only supports `_queryFilter=true` filter.
**Usage**
```
am> query Jms --global --filter filter
```
**Parameters**
* *\--filter*
A CREST formatted query filter, where "true" will query all.
### read
**Usage**
```
am> read Jms --global --id id
```
**Parameters**
* *\--id*
The unique identifier for the resource.
### update
**Usage**
```
am> update Jms --global --id id --body body
```
**Parameters**
* *\--id*
The unique identifier for the resource.
* *\--body*
The resource in JSON format, described by the following JSON schema:
```json
{
"type" : "object",
"properties" : {
"jmsConfiguration" : {
"type" : "object",
"title" : "JMS Configuration",
"propertyOrder" : 2,
"properties" : {
"jndiContextProperties" : {
"title" : "JNDI Context Properties",
"description" : "Specifies JNDI properties that OpenAM uses to connect to the JMS message broker to which OpenAM will publish audit events.
OpenAM acts as a JMS client, using a JMS connection factory to connect to your JMS message broker. In order for OpenAM to connect to the broker, the JNDI context properties must conform to those needed by the broker. See the documentation for your JMS message broker for required values.
The default properties are example properties for connecting to Apache ActiveMQ.",
"propertyOrder" : 6600,
"required" : true,
"patternProperties" : {
".*" : {
"type" : "string"
}
},
"type" : "object",
"exampleValue" : ""
},
"jndiTopicName" : {
"title" : "JMS Topic Name",
"description" : "JNDI lookup name for the JMS topic",
"propertyOrder" : 6700,
"required" : true,
"type" : "string",
"exampleValue" : ""
},
"sessionMode" : {
"title" : "Session Mode",
"description" : "Specifies the JMS session acknowledgement mode: AUTO, CLIENT, or DUPS_OK.
Use the default setting unless your JMS broker implementation requires otherwise. See your broker documentation for more information.", "propertyOrder" : 6500, "required" : true, "type" : "string", "exampleValue" : "" }, "deliveryMode" : { "title" : "Delivery Mode", "description" : "Specifies whether JMS messages used to transmit audit events use persistent or non-persistent delivery.
With persistent delivery, the JMS provider ensures that messages are not lost in transit in case of a provider failure by logging messages to storage when they are sent.
Specify the delivery mode as persistent if it is unacceptable for delivery of audit events to be lost in JMS transit. If the possible loss of audit events is acceptable, choose non-persistent delivery, which provides better performance.", "propertyOrder" : 6400, "required" : true, "type" : "string", "exampleValue" : "" }, "jndiConnectionFactoryName" : { "title" : "JMS Connection Factory Name", "description" : "Specifies the JNDI lookup name for the connection factory exposed by your JMS message broker. OpenAM performs a JNDI lookup on this name to locate your broker's connection factory.
See the documentation for your JMS message broker for the required value.
The default is the connection factory name for Apache ActiveMQ.",
"propertyOrder" : 6800,
"required" : true,
"type" : "string",
"exampleValue" : ""
}
}
},
"commonHandler" : {
"type" : "object",
"title" : "General Handler Configuration",
"propertyOrder" : 0,
"properties" : {
"topics" : {
"title" : "Topics",
"description" : "List of topics handled by an audit event handler.",
"propertyOrder" : 6300,
"required" : true,
"items" : {
"type" : "string"
},
"type" : "array",
"exampleValue" : ""
},
"enabled" : {
"title" : "Enabled",
"description" : "Enables or disables an audit event handler.",
"propertyOrder" : 6200,
"required" : true,
"type" : "boolean",
"exampleValue" : ""
}
}
},
"batchEvents" : {
"type" : "object",
"title" : "Batch Events",
"propertyOrder" : 3,
"properties" : {
"batchCapacity" : {
"title" : "Capacity",
"description" : "Maximum event count in the batch queue; additional events are dropped.",
"propertyOrder" : 7000,
"required" : true,
"type" : "integer",
"exampleValue" : ""
},
"pollTimeoutSec" : {
"title" : "Writing Interval",
"description" : "The interval (in seconds) for reading events from the buffer to transmit via jms.",
"propertyOrder" : 7400,
"required" : true,
"type" : "integer",
"exampleValue" : ""
},
"maxBatchedEvents" : {
"title" : "Max Batched",
"description" : "Maximum number of events per batch.",
"propertyOrder" : 7100,
"required" : true,
"type" : "integer",
"exampleValue" : ""
}
}
},
"commonHandlerPlugin" : {
"type" : "object",
"title" : "Audit Event Handler Factory",
"propertyOrder" : 1,
"properties" : {
"handlerFactory" : {
"title" : "Factory Class Name",
"description" : "The fully qualified class name of the factory responsible for creating the Audit Event Handler. The class must implement org.forgerock.openam.audit.AuditEventHandlerFactory.",
"propertyOrder" : 7600,
"required" : true,
"type" : "string",
"exampleValue" : ""
}
}
}
}
}
```