Management API Reference for size-rotating-file-audit-log

An audit log definition for persisting an audit log to a local file rotating the log after the size of the file grows beyond a certain point and keeping a fixed number of backups.

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.security.security-event-listener	true	/subsystem=elytron/periodic-rotating-file-audit-log=* /subsystem=elytron/aggregate-security-event-listener=* /subsystem=elytron/file-audit-log=* /subsystem=elytron/custom-security-event-listener=* /subsystem=elytron/syslog-audit-log=*

Attributes (10)

autoflush - Whether every event should be immediately flushed to disk.

Type	BOOLEAN
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Whether every event should be immediately flushed to disk.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

encoding - The audit file encoding. Default is UTF_8.

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The audit file encoding. Default is UTF_8.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

format - The format to use to record the audit event.

Type	STRING
Default Value	SIMPLE
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Allowed Values	SIMPLE JSON
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The format to use to record the audit event.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "SIMPLE", "min-length" : 1, "max-length" : 2147483647, "allowed" : [ "SIMPLE", "JSON" ], "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

max-backup-index - The maximum number of files to backup when rotating.

Type	INT
Default Value	1
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Min	1
Max	2147483647
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The maximum number of files to backup when rotating.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 1, "min" : 1, "max" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

path - Path of the file to be written.

Type	STRING
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Path of the file to be written.", "attribute-group" : "file", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

relative-to - The relative path to the audit log.

Type	STRING
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The relative path to the audit log.", "attribute-group" : "file", "expressions-allowed" : false, "required" : false, "nillable" : true, "requires" : ["path"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

rotate-on-boot - Whether the file should be rotated before the a new file is set.

Type	BOOLEAN
Default Value	false
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Whether the file should be rotated before the a new file is set.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

rotate-size - The log file size the file should rotate at.

Type	STRING
Default Value	10m
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The log file size the file should rotate at.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "10m", "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

suffix - Format of date used as suffix of log file names in java.time.format.DateTimeFormatter. The suffix does not play a role in determining when the file should be rotated.

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Format of date used as suffix of log file names in java.time.format.DateTimeFormatter. The suffix does not play a role in determining when the file should be rotated.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

synchronized - Whether every event should be immediately flushed to disk (If undefined will default to the value of synchronized).

Type	BOOLEAN
Default Value	true
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Whether every event should be immediately flushed to disk (If undefined will default to the value of synchronized).", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

Operations (2)

add - Add the audit logger resource.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
autoflush	BOOLEAN	false	true		Whether every event should be immediately flushed to disk.
encoding	STRING	false	true		The audit file encoding. Default is UTF_8.
format	STRING	false	true	SIMPLE	The format to use to record the audit event.
max-backup-index	INT	false	true	1	The maximum number of files to backup when rotating.
rotate-on-boot	BOOLEAN	false	true	false	Whether the file should be rotated before the a new file is set.
rotate-size	STRING	false	true	10m	The log file size the file should rotate at.
suffix	STRING	false	true		Format of date used as suffix of log file names in java.time.format.DateTimeFormatter. The suffix does not play a role in determining when the file should be rotated.
synchronized	BOOLEAN	false	true	true	Whether every event should be immediately flushed to disk (If undefined will default to the value of synchronized).
path	STRING	true	true		Path of the file to be written.
relative-to	STRING	false	false		The relative path to the audit log.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Add the audit logger resource.",
    "request-properties" : {
        "autoflush" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Whether every event should be immediately flushed to disk.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "encoding" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The audit file encoding. Default is UTF_8.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "format" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The format to use to record the audit event.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "SIMPLE",
            "min-length" : 1,
            "max-length" : 2147483647,
            "allowed" : [
                "SIMPLE",
                "JSON"
            ],
            "stability" : "default"
        },
        "max-backup-index" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The maximum number of files to backup when rotating.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 1,
            "min" : 1,
            "max" : 2147483647,
            "stability" : "default"
        },
        "rotate-on-boot" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Whether the file should be rotated before the a new file is set.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "rotate-size" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The log file size the file should rotate at.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "10m",
            "stability" : "default"
        },
        "suffix" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Format of date used as suffix of log file names in java.time.format.DateTimeFormatter. The suffix does not play a role in determining when the file should be rotated.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "synchronized" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Whether every event should be immediately flushed to disk (If undefined will default to the value of synchronized).",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "stability" : "default"
        },
        "path" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Path of the file to be written.",
            "expressions-allowed" : true,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "relative-to" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The relative path to the audit log.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "requires" : ["path"],
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "resource-services",
    "runtime-only" : false
}

remove - Remove the audit logger resource.

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Remove the audit logger resource.",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "resource-services",
    "runtime-only" : false
}

Galleon Features

Galleon features are to be used when creating Galleon feature-packs.

subsystem.elytron.size-rotating-file-audit-log

        
<feature spec="subsystem.elytron.size-rotating-file-audit-log">
  <param name="size-rotating-file-audit-log" value="{resource name}"/>
  <param name="autoflush" value="{value}"/>
  <param name="encoding" value="{value}"/>
  <param name="format" value="{value}"/>
  <param name="max-backup-index" value="{value}"/>
  <param name="path" value="{value}"/>
  <param name="relative-to" value="{value}"/>
  <param name="rotate-on-boot" value="{value}"/>
  <param name="rotate-size" value="{value}"/>
  <param name="suffix" value="{value}"/>
  <param name="synchronized" value="{value}"/>
<feature/>