com.sun.idm.logging.audit
Interface AuditLogPublisher

All Superinterfaces:
LogPublisher
All Known Implementing Classes:
com.sun.idm.logging.audit.AbstractAuditLogPublisher

public interface AuditLogPublisher
extends LogPublisher

Interface used for publishing audit records. 3rd party implementations should extend the AbstractAuditLogPublisher class instead of implementing this class directly.


Field Summary
static java.lang.String code_id
           
 
Method Summary
 void configure(java.util.Map options)
          Configures the publisher with a set of options.
 java.util.Map getConfiguration()
           
 java.util.List getConfigurationOptions()
           
 java.lang.String getDisplayName()
           
 void setFormatter(TextFormatter formatter)
          Sets the formatter object on the publisher.
 
Methods inherited from interface com.sun.idm.logging.LogPublisher
publish, shutdown
 

Field Detail

code_id

public static final java.lang.String code_id
See Also:
Constant Field Values
Method Detail

configure

public void configure(java.util.Map options)
               throws WavesetException
Configures the publisher with a set of options.

Parameters:
options - map of options, where key is the configuration attribute name, and the value is the configuration attribute value
Throws:
WavesetException - if any unrecognized options found or any of the options has invalid value

getConfiguration

public java.util.Map getConfiguration()
Returns:
map of configuration options, where key is the configuration attribute name, and the value is the configuration attribute value

getConfigurationOptions

public java.util.List getConfigurationOptions()
Returns:
list of configuration options available for the publisher implementation Note that configuration options does not return the settings, only the available attributes.

setFormatter

public void setFormatter(TextFormatter formatter)
Sets the formatter object on the publisher. The formatter is used to transform the handled AuditEvent to the desired output format.

Parameters:
formatter - formatter object
See Also:
AuditEvent

getDisplayName

public java.lang.String getDisplayName()
Returns:
the display name string (or the message catalog key to the display name string) of the publisher implementation