Interface ExternalHttpAccessLogPublisherCfg
-
- All Superinterfaces:
Configuration
,HttpAccessLogPublisherCfg
,LogPublisherCfg
public interface ExternalHttpAccessLogPublisherCfg extends HttpAccessLogPublisherCfg
A server-side interface for querying External HTTP Access Log Publisher settings.External HTTP Access Log Publishers publish HTTP access messages to an external handler.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addExternalHttpAccessChangeListener(ConfigurationChangeListener<ExternalHttpAccessLogPublisherCfg> listener)
Register to be notified when this External HTTP Access Log Publisher is changed.Class<? extends ExternalHttpAccessLogPublisherCfg>
configurationClass()
Gets the configuration class associated with this External HTTP Access Log Publisher.String
getConfigFile()
Gets the "config-file" property.String
getJavaClass()
Gets the "java-class" property.SortedSet<String>
getLogFieldBlacklist()
Gets the "log-field-blacklist" property.SortedSet<String>
getLogFieldWhitelist()
Gets the "log-field-whitelist" property.void
removeExternalHttpAccessChangeListener(ConfigurationChangeListener<ExternalHttpAccessLogPublisherCfg> listener)
Deregister an existing External HTTP Access Log Publisher configuration change listener.-
Methods inherited from interface org.forgerock.opendj.config.Configuration
dn, name
-
Methods inherited from interface org.forgerock.opendj.server.config.server.HttpAccessLogPublisherCfg
addHttpAccessChangeListener, removeHttpAccessChangeListener
-
Methods inherited from interface org.forgerock.opendj.server.config.server.LogPublisherCfg
addChangeListener, isEnabled, removeChangeListener
-
-
-
-
Method Detail
-
configurationClass
Class<? extends ExternalHttpAccessLogPublisherCfg> configurationClass()
Gets the configuration class associated with this External HTTP Access Log Publisher.- Specified by:
configurationClass
in interfaceConfiguration
- Specified by:
configurationClass
in interfaceHttpAccessLogPublisherCfg
- Specified by:
configurationClass
in interfaceLogPublisherCfg
- Returns:
- Returns the configuration class associated with this External HTTP Access Log Publisher.
-
addExternalHttpAccessChangeListener
void addExternalHttpAccessChangeListener(ConfigurationChangeListener<ExternalHttpAccessLogPublisherCfg> listener)
Register to be notified when this External HTTP Access Log Publisher is changed.- Parameters:
listener
- The External HTTP Access Log Publisher configuration change listener.
-
removeExternalHttpAccessChangeListener
void removeExternalHttpAccessChangeListener(ConfigurationChangeListener<ExternalHttpAccessLogPublisherCfg> listener)
Deregister an existing External HTTP Access Log Publisher configuration change listener.- Parameters:
listener
- The External HTTP Access Log Publisher configuration change listener.
-
getConfigFile
String getConfigFile()
Gets the "config-file" property.The JSON configuration file that defines the External HTTP Access Log Publisher. The content of the JSON configuration file depends on the type of external audit event handler. The path to the file is relative to the server root.
Default value is undefined
- Returns:
- Returns the value of the "config-file" property.
-
getJavaClass
String getJavaClass()
Gets the "java-class" property.The fully-qualified name of the Java class that provides the External HTTP Access Log Publisher implementation.
Default value:
org.opends.server.loggers.CommonAuditHTTPAccessLogPublisher
- Specified by:
getJavaClass
in interfaceHttpAccessLogPublisherCfg
- Specified by:
getJavaClass
in interfaceLogPublisherCfg
- Returns:
- Returns the value of the "java-class" property.
-
getLogFieldBlacklist
SortedSet<String> getLogFieldBlacklist()
Gets the "log-field-blacklist" property.List of fields that the server omits from access log messages.
Valid values for this property are JSON paths for fields present in the log file.
- Returns:
- Returns an unmodifiable set containing the values of the "log-field-blacklist" property.
-
getLogFieldWhitelist
SortedSet<String> getLogFieldWhitelist()
Gets the "log-field-whitelist" property.List of fields that the server includes in access log messages.
Valid values for this property are JSON paths for fields present in the log file.
- Returns:
- Returns an unmodifiable set containing the values of the "log-field-whitelist" property.
-
-