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

An audit log definition for persisting an audit log to a local file rotating the log after a time period derived from the given suffix string, which should be in a format understood by java.time.format.DateTimeFormatter.

Provided Capabilities (1)

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

Attributes (7)

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

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 (If undefined will default to the value of synchronized).", "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 }`

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 }`

suffix - The suffix string in a format which can be understood by java.time.format.DateTimeFormatter. The period of the rotation is automatically calculated based on the suffix.

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" : "The suffix string in a format which can be understood by java.time.format.DateTimeFormatter. The period of the rotation is automatically calculated based on the suffix.", "expressions-allowed" : true, "required" : true, "nillable" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

synchronized - Whether every event should be immediately synchronised to disk.

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 synchronised to disk.", "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 (If undefined will default to the value of synchronized).
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.
suffix	STRING	true	true		The suffix string in a format which can be understood by java.time.format.DateTimeFormatter. The period of the rotation is automatically calculated based on the suffix.
synchronized	BOOLEAN	false	true	true	Whether every event should be immediately synchronised to disk.
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 (If undefined will default to the value of synchronized).",
            "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"
        },
        "suffix" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The suffix string in a format which can be understood by java.time.format.DateTimeFormatter. The period of the rotation is automatically calculated based on the suffix.",
            "expressions-allowed" : true,
            "required" : true,
            "nillable" : false,
            "stability" : "default"
        },
        "synchronized" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Whether every event should be immediately synchronised to disk.",
            "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.periodic-rotating-file-audit-log

        
<feature spec="subsystem.elytron.periodic-rotating-file-audit-log">
  <param name="periodic-rotating-file-audit-log" value="{resource name}"/>
  <param name="autoflush" value="{value}"/>
  <param name="encoding" value="{value}"/>
  <param name="format" value="{value}"/>
  <param name="path" value="{value}"/>
  <param name="relative-to" value="{value}"/>
  <param name="suffix" value="{value}"/>
  <param name="synchronized" value="{value}"/>
<feature/>