Jdbc

Realm Operations

Resource path: /realm-config/services/audit/JDBC

Resource version: 1.0

create

Usage:

am> create Jdbc --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:

{
  "type" : "object",
  "properties" : {
    "jdbcBuffering" : {
      "type" : "object",
      "title" : "Buffering",
      "propertyOrder" : 3,
      "properties" : {
        "bufferingMaxSize" : {
          "title" : "Buffer Size (number of events)",
          "description" : "Size of the queue where events are buffered before they are written to the database.<br><br>This queue has to be big enough to store all incoming events that have not yet been written to the database.<p>If the queue reaches capacity, the process will block until a write occurs.",
          "propertyOrder" : 4400,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        },
        "bufferingWriterThreads" : {
          "title" : "Writer Threads",
          "description" : "Specifies the number of threads used to write the buffered events.",
          "propertyOrder" : 4600,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        },
        "bufferingEnabled" : {
          "title" : "Buffering Enabled",
          "description" : "Enables or disables audit event buffering.",
          "propertyOrder" : 4300,
          "required" : true,
          "type" : "boolean",
          "exampleValue" : ""
        },
        "bufferingMaxBatchedEvents" : {
          "title" : "Max Batched Events",
          "description" : "Specifies the maximum number of batched statements the database can support per connection.",
          "propertyOrder" : 4700,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        },
        "bufferingWriteInterval" : {
          "title" : "Write Interval",
          "description" : "Specifies the interval (seconds) at which buffered events are written to the database.",
          "propertyOrder" : 4500,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        }
      }
    },
    "commonHandler" : {
      "type" : "object",
      "title" : "General Handler Configuration",
      "propertyOrder" : 0,
      "properties" : {
        "enabled" : {
          "title" : "Enabled",
          "description" : "Enables or disables an audit event handler.",
          "propertyOrder" : 3100,
          "required" : true,
          "type" : "boolean",
          "exampleValue" : ""
        },
        "topics" : {
          "title" : "Topics",
          "description" : "List of topics handled by an audit event handler.",
          "propertyOrder" : 3200,
          "required" : true,
          "items" : {
            "type" : "string"
          },
          "type" : "array",
          "exampleValue" : ""
        }
      }
    },
    "jdbcDatabaseConfig" : {
      "type" : "object",
      "title" : "Database Configuration",
      "propertyOrder" : 2,
      "properties" : {
        "connectionTimeout" : {
          "title" : "Connection Timeout (seconds)",
          "description" : "Specifies the maximum wait time before failing the connection, in seconds.",
          "propertyOrder" : 3800,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        },
        "maxPoolSize" : {
          "title" : "Maximum Connections",
          "description" : "Specifies the maximum number of connections in the connection pool.",
          "propertyOrder" : 4200,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        },
        "username" : {
          "title" : "Database Username",
          "description" : "Specifies the username to access the database server.",
          "propertyOrder" : 3600,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        },
        "maxLifetime" : {
          "title" : "Maximum Connection Time (seconds)",
          "description" : "Specifies the maximum time a JDBC connection can be open, in seconds.",
          "propertyOrder" : 4000,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        },
        "idleTimeout" : {
          "title" : "Maximum Connection Idle Timeout (seconds)",
          "description" : "Specifies the maximum idle time before the connection is closed, in seconds.",
          "propertyOrder" : 3900,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        },
        "password" : {
          "title" : "Database Password",
          "description" : "Specifies the password to access the database server.",
          "propertyOrder" : 3700,
          "required" : true,
          "type" : "string",
          "format" : "password",
          "exampleValue" : ""
        },
        "databaseType" : {
          "title" : "Database Type",
          "description" : "Select the database to use for logging audit events.<br><br>Identifies the database in use, for example MySQL, Oracle, or SQL.",
          "propertyOrder" : 3300,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        },
        "jdbcUrl" : {
          "title" : "JDBC Database URL",
          "description" : "URL of the JDBC database.",
          "propertyOrder" : 3400,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        },
        "minIdle" : {
          "title" : "Minimum Idle Connections",
          "description" : "Specifies the minimum number of idle connections in the connection pool.",
          "propertyOrder" : 4100,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        },
        "driverClassName" : {
          "title" : "JDBC Driver",
          "description" : "Fully qualified JDBC driver class name.",
          "propertyOrder" : 3500,
          "required" : true,
          "type" : "string",
          "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 <code>org.forgerock.openam.audit.AuditEventHandlerFactory</code>.",
          "propertyOrder" : 4800,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        }
      }
    }
  }
}

delete

Usage:

am> delete Jdbc --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 Jdbc --realm Realm --actionName getAllTypes

getCreatableTypes

Obtain the collection of secondary configuration types that have yet to be added to the resource.

Usage:

am> action Jdbc --realm Realm --actionName getCreatableTypes

nextdescendents

Obtain the collection of secondary configuration instances that have been added to the resource.

Usage:

am> action Jdbc --realm Realm --actionName nextdescendents

query

Get the full list of instances of this collection. This query only supports `_queryFilter=true` filter.

Usage:

am> query Jdbc --realm Realm --filter filter

Parameters:

--filter

A CREST formatted query filter, where "true" will query all.

read

Usage:

am> read Jdbc --realm Realm --id id

Parameters:

--id

The unique identifier for the resource.

update

Usage:

am> update Jdbc --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:

{
  "type" : "object",
  "properties" : {
    "jdbcBuffering" : {
      "type" : "object",
      "title" : "Buffering",
      "propertyOrder" : 3,
      "properties" : {
        "bufferingMaxSize" : {
          "title" : "Buffer Size (number of events)",
          "description" : "Size of the queue where events are buffered before they are written to the database.<br><br>This queue has to be big enough to store all incoming events that have not yet been written to the database.<p>If the queue reaches capacity, the process will block until a write occurs.",
          "propertyOrder" : 4400,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        },
        "bufferingWriterThreads" : {
          "title" : "Writer Threads",
          "description" : "Specifies the number of threads used to write the buffered events.",
          "propertyOrder" : 4600,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        },
        "bufferingEnabled" : {
          "title" : "Buffering Enabled",
          "description" : "Enables or disables audit event buffering.",
          "propertyOrder" : 4300,
          "required" : true,
          "type" : "boolean",
          "exampleValue" : ""
        },
        "bufferingMaxBatchedEvents" : {
          "title" : "Max Batched Events",
          "description" : "Specifies the maximum number of batched statements the database can support per connection.",
          "propertyOrder" : 4700,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        },
        "bufferingWriteInterval" : {
          "title" : "Write Interval",
          "description" : "Specifies the interval (seconds) at which buffered events are written to the database.",
          "propertyOrder" : 4500,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        }
      }
    },
    "commonHandler" : {
      "type" : "object",
      "title" : "General Handler Configuration",
      "propertyOrder" : 0,
      "properties" : {
        "enabled" : {
          "title" : "Enabled",
          "description" : "Enables or disables an audit event handler.",
          "propertyOrder" : 3100,
          "required" : true,
          "type" : "boolean",
          "exampleValue" : ""
        },
        "topics" : {
          "title" : "Topics",
          "description" : "List of topics handled by an audit event handler.",
          "propertyOrder" : 3200,
          "required" : true,
          "items" : {
            "type" : "string"
          },
          "type" : "array",
          "exampleValue" : ""
        }
      }
    },
    "jdbcDatabaseConfig" : {
      "type" : "object",
      "title" : "Database Configuration",
      "propertyOrder" : 2,
      "properties" : {
        "connectionTimeout" : {
          "title" : "Connection Timeout (seconds)",
          "description" : "Specifies the maximum wait time before failing the connection, in seconds.",
          "propertyOrder" : 3800,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        },
        "maxPoolSize" : {
          "title" : "Maximum Connections",
          "description" : "Specifies the maximum number of connections in the connection pool.",
          "propertyOrder" : 4200,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        },
        "username" : {
          "title" : "Database Username",
          "description" : "Specifies the username to access the database server.",
          "propertyOrder" : 3600,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        },
        "maxLifetime" : {
          "title" : "Maximum Connection Time (seconds)",
          "description" : "Specifies the maximum time a JDBC connection can be open, in seconds.",
          "propertyOrder" : 4000,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        },
        "idleTimeout" : {
          "title" : "Maximum Connection Idle Timeout (seconds)",
          "description" : "Specifies the maximum idle time before the connection is closed, in seconds.",
          "propertyOrder" : 3900,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        },
        "password" : {
          "title" : "Database Password",
          "description" : "Specifies the password to access the database server.",
          "propertyOrder" : 3700,
          "required" : true,
          "type" : "string",
          "format" : "password",
          "exampleValue" : ""
        },
        "databaseType" : {
          "title" : "Database Type",
          "description" : "Select the database to use for logging audit events.<br><br>Identifies the database in use, for example MySQL, Oracle, or SQL.",
          "propertyOrder" : 3300,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        },
        "jdbcUrl" : {
          "title" : "JDBC Database URL",
          "description" : "URL of the JDBC database.",
          "propertyOrder" : 3400,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        },
        "minIdle" : {
          "title" : "Minimum Idle Connections",
          "description" : "Specifies the minimum number of idle connections in the connection pool.",
          "propertyOrder" : 4100,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        },
        "driverClassName" : {
          "title" : "JDBC Driver",
          "description" : "Fully qualified JDBC driver class name.",
          "propertyOrder" : 3500,
          "required" : true,
          "type" : "string",
          "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 <code>org.forgerock.openam.audit.AuditEventHandlerFactory</code>.",
          "propertyOrder" : 4800,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        }
      }
    }
  }
}

Global Operations

Resource path: /global-config/services/audit/JDBC

Resource version: 1.0

create

Usage:

am> create Jdbc --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:

{
  "type" : "object",
  "properties" : {
    "jdbcBuffering" : {
      "type" : "object",
      "title" : "Buffering",
      "propertyOrder" : 3,
      "properties" : {
        "bufferingWriterThreads" : {
          "title" : "Writer Threads",
          "description" : "Specifies the number of threads used to write the buffered events.",
          "propertyOrder" : 4600,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        },
        "bufferingWriteInterval" : {
          "title" : "Write Interval",
          "description" : "Specifies the interval (seconds) at which buffered events are written to the database.",
          "propertyOrder" : 4500,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        },
        "bufferingMaxSize" : {
          "title" : "Buffer Size (number of events)",
          "description" : "Size of the queue where events are buffered before they are written to the database.<br><br>This queue has to be big enough to store all incoming events that have not yet been written to the database.<p>If the queue reaches capacity, the process will block until a write occurs.",
          "propertyOrder" : 4400,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        },
        "bufferingEnabled" : {
          "title" : "Buffering Enabled",
          "description" : "Enables or disables audit event buffering.",
          "propertyOrder" : 4300,
          "required" : true,
          "type" : "boolean",
          "exampleValue" : ""
        },
        "bufferingMaxBatchedEvents" : {
          "title" : "Max Batched Events",
          "description" : "Specifies the maximum number of batched statements the database can support per connection.",
          "propertyOrder" : 4700,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        }
      }
    },
    "jdbcDatabaseConfig" : {
      "type" : "object",
      "title" : "Database Configuration",
      "propertyOrder" : 2,
      "properties" : {
        "idleTimeout" : {
          "title" : "Maximum Connection Idle Timeout (seconds)",
          "description" : "Specifies the maximum idle time before the connection is closed, in seconds.",
          "propertyOrder" : 3900,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        },
        "username" : {
          "title" : "Database Username",
          "description" : "Specifies the username to access the database server.",
          "propertyOrder" : 3600,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        },
        "databaseType" : {
          "title" : "Database Type",
          "description" : "Select the database to use for logging audit events.<br><br>Identifies the database in use, for example MySQL, Oracle, or SQL.",
          "propertyOrder" : 3300,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        },
        "connectionTimeout" : {
          "title" : "Connection Timeout (seconds)",
          "description" : "Specifies the maximum wait time before failing the connection, in seconds.",
          "propertyOrder" : 3800,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        },
        "password" : {
          "title" : "Database Password",
          "description" : "Specifies the password to access the database server.",
          "propertyOrder" : 3700,
          "required" : true,
          "type" : "string",
          "format" : "password",
          "exampleValue" : ""
        },
        "driverClassName" : {
          "title" : "JDBC Driver",
          "description" : "Fully qualified JDBC driver class name.",
          "propertyOrder" : 3500,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        },
        "minIdle" : {
          "title" : "Minimum Idle Connections",
          "description" : "Specifies the minimum number of idle connections in the connection pool.",
          "propertyOrder" : 4100,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        },
        "maxPoolSize" : {
          "title" : "Maximum Connections",
          "description" : "Specifies the maximum number of connections in the connection pool.",
          "propertyOrder" : 4200,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        },
        "jdbcUrl" : {
          "title" : "JDBC Database URL",
          "description" : "URL of the JDBC database.",
          "propertyOrder" : 3400,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        },
        "maxLifetime" : {
          "title" : "Maximum Connection Time (seconds)",
          "description" : "Specifies the maximum time a JDBC connection can be open, in seconds.",
          "propertyOrder" : 4000,
          "required" : true,
          "type" : "string",
          "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 <code>org.forgerock.openam.audit.AuditEventHandlerFactory</code>.",
          "propertyOrder" : 4800,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        }
      }
    },
    "commonHandler" : {
      "type" : "object",
      "title" : "General Handler Configuration",
      "propertyOrder" : 0,
      "properties" : {
        "enabled" : {
          "title" : "Enabled",
          "description" : "Enables or disables an audit event handler.",
          "propertyOrder" : 3100,
          "required" : true,
          "type" : "boolean",
          "exampleValue" : ""
        },
        "topics" : {
          "title" : "Topics",
          "description" : "List of topics handled by an audit event handler.",
          "propertyOrder" : 3200,
          "required" : true,
          "items" : {
            "type" : "string"
          },
          "type" : "array",
          "exampleValue" : ""
        }
      }
    }
  }
}

delete

Usage:

am> delete Jdbc --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 Jdbc --global --actionName getAllTypes

getCreatableTypes

Obtain the collection of secondary configuration types that have yet to be added to the resource.

Usage:

am> action Jdbc --global --actionName getCreatableTypes

nextdescendents

Obtain the collection of secondary configuration instances that have been added to the resource.

Usage:

am> action Jdbc --global --actionName nextdescendents

query

Get the full list of instances of this collection. This query only supports `_queryFilter=true` filter.

Usage:

am> query Jdbc --global --filter filter

Parameters:

--filter

A CREST formatted query filter, where "true" will query all.

read

Usage:

am> read Jdbc --global --id id

Parameters:

--id

The unique identifier for the resource.

update

Usage:

am> update Jdbc --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:

{
  "type" : "object",
  "properties" : {
    "jdbcBuffering" : {
      "type" : "object",
      "title" : "Buffering",
      "propertyOrder" : 3,
      "properties" : {
        "bufferingWriterThreads" : {
          "title" : "Writer Threads",
          "description" : "Specifies the number of threads used to write the buffered events.",
          "propertyOrder" : 4600,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        },
        "bufferingWriteInterval" : {
          "title" : "Write Interval",
          "description" : "Specifies the interval (seconds) at which buffered events are written to the database.",
          "propertyOrder" : 4500,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        },
        "bufferingMaxSize" : {
          "title" : "Buffer Size (number of events)",
          "description" : "Size of the queue where events are buffered before they are written to the database.<br><br>This queue has to be big enough to store all incoming events that have not yet been written to the database.<p>If the queue reaches capacity, the process will block until a write occurs.",
          "propertyOrder" : 4400,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        },
        "bufferingEnabled" : {
          "title" : "Buffering Enabled",
          "description" : "Enables or disables audit event buffering.",
          "propertyOrder" : 4300,
          "required" : true,
          "type" : "boolean",
          "exampleValue" : ""
        },
        "bufferingMaxBatchedEvents" : {
          "title" : "Max Batched Events",
          "description" : "Specifies the maximum number of batched statements the database can support per connection.",
          "propertyOrder" : 4700,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        }
      }
    },
    "jdbcDatabaseConfig" : {
      "type" : "object",
      "title" : "Database Configuration",
      "propertyOrder" : 2,
      "properties" : {
        "idleTimeout" : {
          "title" : "Maximum Connection Idle Timeout (seconds)",
          "description" : "Specifies the maximum idle time before the connection is closed, in seconds.",
          "propertyOrder" : 3900,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        },
        "username" : {
          "title" : "Database Username",
          "description" : "Specifies the username to access the database server.",
          "propertyOrder" : 3600,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        },
        "databaseType" : {
          "title" : "Database Type",
          "description" : "Select the database to use for logging audit events.<br><br>Identifies the database in use, for example MySQL, Oracle, or SQL.",
          "propertyOrder" : 3300,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        },
        "connectionTimeout" : {
          "title" : "Connection Timeout (seconds)",
          "description" : "Specifies the maximum wait time before failing the connection, in seconds.",
          "propertyOrder" : 3800,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        },
        "password" : {
          "title" : "Database Password",
          "description" : "Specifies the password to access the database server.",
          "propertyOrder" : 3700,
          "required" : true,
          "type" : "string",
          "format" : "password",
          "exampleValue" : ""
        },
        "driverClassName" : {
          "title" : "JDBC Driver",
          "description" : "Fully qualified JDBC driver class name.",
          "propertyOrder" : 3500,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        },
        "minIdle" : {
          "title" : "Minimum Idle Connections",
          "description" : "Specifies the minimum number of idle connections in the connection pool.",
          "propertyOrder" : 4100,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        },
        "maxPoolSize" : {
          "title" : "Maximum Connections",
          "description" : "Specifies the maximum number of connections in the connection pool.",
          "propertyOrder" : 4200,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        },
        "jdbcUrl" : {
          "title" : "JDBC Database URL",
          "description" : "URL of the JDBC database.",
          "propertyOrder" : 3400,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        },
        "maxLifetime" : {
          "title" : "Maximum Connection Time (seconds)",
          "description" : "Specifies the maximum time a JDBC connection can be open, in seconds.",
          "propertyOrder" : 4000,
          "required" : true,
          "type" : "string",
          "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 <code>org.forgerock.openam.audit.AuditEventHandlerFactory</code>.",
          "propertyOrder" : 4800,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        }
      }
    },
    "commonHandler" : {
      "type" : "object",
      "title" : "General Handler Configuration",
      "propertyOrder" : 0,
      "properties" : {
        "enabled" : {
          "title" : "Enabled",
          "description" : "Enables or disables an audit event handler.",
          "propertyOrder" : 3100,
          "required" : true,
          "type" : "boolean",
          "exampleValue" : ""
        },
        "topics" : {
          "title" : "Topics",
          "description" : "List of topics handled by an audit event handler.",
          "propertyOrder" : 3200,
          "required" : true,
          "items" : {
            "type" : "string"
          },
          "type" : "array",
          "exampleValue" : ""
        }
      }
    }
  }
}
Read a different version of :