Management API Reference for json-formatter

A json formatter for audit log messages.

Attributes (6)

compact - If true will format the JSON on one line. There may still be values containing new lines, so if having the whole record on one line is important, set escape-new-line or escape-control-characters to true.

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?	no-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "If true will format the JSON on one line. There may still be values containing new lines, so if having the whole record on one line is important, set escape-new-line or escape-control-characters to true.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

date-format - The date format to use as understood by java.text.SimpleDateFormat. Will be ignored if include-date="false".

Type	STRING
Default Value	yyyy-MM-dd HH:mm:ss
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The date format to use as understood by java.text.SimpleDateFormat. Will be ignored if include-date=\"false\".", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "yyyy-MM-dd HH:mm:ss", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

date-separator - The separator between the date and the rest of the formatted log message. Will be ignored if include-date="false".

Type	STRING
Default Value	-
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The separator between the date and the rest of the formatted log message. Will be ignored if include-date=\"false\".", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : " - ", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

escape-control-characters - If true will escape all control characters (ascii entries with a decimal value < 32) with the ascii code in octal, e.g.' becomes '#012'. If this is true, it will override escape-new-line="false".

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?	no-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "If true will escape all control characters (ascii entries with a decimal value < 32) with the ascii code in octal, e.g.'\n becomes '#012'. If this is true, it will override escape-new-line=\"false\".", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

escape-new-line - If true will escape all new lines with the ascii code in octal, e.g. "#012".

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?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "If true will escape all new lines with the ascii code in octal, e.g. \"#012\".", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

include-date - Whether or not to include the date in the formatted log record.

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?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Whether or not to include the date in the formatted log record.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

Operations (2)

add - Adds a json formatter for the audit logging.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
compact	BOOLEAN	false	true	false	If true will format the JSON on one line. There may still be values containing new lines, so if having the whole record on one line is important, set escape-new-line or escape-control-characters to true.
date-format	STRING	false	true	yyyy-MM-dd HH:mm:ss	The date format to use as understood by java.text.SimpleDateFormat. Will be ignored if include-date="false".
date-separator	STRING	false	true	-	The separator between the date and the rest of the formatted log message. Will be ignored if include-date="false".
escape-control-characters	BOOLEAN	false	true	false	If true will escape all control characters (ascii entries with a decimal value < 32) with the ascii code in octal, e.g.' becomes '#012'. If this is true, it will override escape-new-line="false".
escape-new-line	BOOLEAN	false	true	false	If true will escape all new lines with the ascii code in octal, e.g. "#012".
include-date	BOOLEAN	false	true	true	Whether or not to include the date in the formatted log record.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Adds a json formatter for the audit logging.",
    "request-properties" : {
        "compact" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "If true will format the JSON on one line. There may still be values containing new lines, so if having the whole record on one line is important, set escape-new-line or escape-control-characters to true.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "date-format" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The date format to use as understood by java.text.SimpleDateFormat. Will be ignored if include-date=\"false\".",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "yyyy-MM-dd HH:mm:ss",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "date-separator" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The separator between the date and the rest of the formatted log message. Will be ignored if include-date=\"false\".",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : " - ",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "escape-control-characters" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "If true will escape all control characters (ascii entries with a decimal value < 32) with the ascii code in octal, e.g.'\n becomes '#012'. If this is true, it will override escape-new-line=\"false\".",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "escape-new-line" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "If true will escape all new lines with the ascii code in octal, e.g. \"#012\".",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "include-date" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Whether or not to include the date in the formatted log record.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove - Removes a json formatter for the audit logging.

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Removes a json formatter for the audit logging.",
    "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.

core-service.management.access.audit.json-formatter

        
<feature spec="core-service.management.access.audit.json-formatter">
  <param name="json-formatter" value="{resource name}"/>
  <param name="compact" value="{value}"/>
  <param name="date-format" value="{value}"/>
  <param name="date-separator" value="{value}"/>
  <param name="escape-control-characters" value="{value}"/>
  <param name="escape-new-line" value="{value}"/>
  <param name="include-date" value="{value}"/>
<feature/>