Field Detail

• RULENAME

  public static final java.lang.String RULENAME

  See Also:

  Constant Field Values

• PASSWORD_MASK

  public static final java.lang.String PASSWORD_MASK

  See Also:

  Constant Field Values

• NAME_VALUE_DELIMITER

  public static final java.lang.String NAME_VALUE_DELIMITER

  See Also:

  Constant Field Values

• NAME_VALUE_PAIRS_DELIMITER

  public static final java.lang.String NAME_VALUE_PAIRS_DELIMITER

  See Also:

  Constant Field Values

• attributes

  protected java.util.Map<java.lang.String,​java.lang.Object> attributes

Constructor Detail

• SignedAuditEvent

  public SignedAuditEvent()

• SignedAuditEvent

  public SignedAuditEvent​(java.lang.String msgFormat)

  Constructs a SignedAuditEvent message event.

  Parameters:

  msgFormat - The message string.

• SignedAuditEvent

  public SignedAuditEvent​(java.lang.String msgFormat,
                          java.lang.String param)

  Constructs a message with a parameter. For example,

   new SignedAuditEvent("failed to load {0}", fileName);
   

  Parameters:

  msgFormat - Details in message string format.

  param - Message string parameter.

• SignedAuditEvent

  public SignedAuditEvent​(java.lang.String msgFormat,
                          java.lang.Exception exception)

  Constructs a message from an exception. It can be used to carry a signed audit exception that may contain information about the context. For example,

                  try {
                  ...
                  } catch (IOExeption e) {
                          logHandler.log(new SignedAuditEvent("Encountered Signed Audit Error {0}", e);
        }
   

  Parameters:

  msgFormat - Exception details in message string format.

  exception - System exception.

• SignedAuditEvent

  public SignedAuditEvent​(java.lang.Exception e)

  Constructs a message from a base exception. This will use the msgFormat from the exception itself.

                  try {
                  ...
                  } catch (Exception e) {
                          logHandler.log(new SignedAuditEvent(e));
        }
   

  Parameters:

  e - CMS exception.

• SignedAuditEvent

  public SignedAuditEvent​(java.lang.String msgFormat,
                          java.lang.Object[] params)

  Constructs a message event with a list of parameters that will be substituted into the message format.

  Parameters:

  msgFormat - Message string format.

  params - List of message format parameters.

Method Detail

• setAttribute

  public void setAttribute​(java.lang.String name,
                           java.lang.Object value)

• setAttribute

  public void setAttribute​(java.lang.String name,
                           java.util.Map<java.lang.String,​java.lang.String> params)

• getAttribute

  public java.lang.Object getAttribute​(java.lang.String name)

• getAttributes

  public java.util.Map<java.lang.String,​java.lang.Object> getAttributes()

• getAttributeList

  public java.lang.String getAttributeList()

• getParameters

  public java.lang.Object[] getParameters()

  Description copied from class: LogEvent
  Returns a list of parameters.

  Overrides:

  getParameters in class LogEvent

  Returns:

  list of message format parameters

• encodeMap

  public static void encodeMap​(java.lang.StringBuilder sb,
                               java.util.Map<java.lang.String,​java.lang.String> params)