LogPublisherCfg (OpenDJ Public API Javadoc 7.0.2 Documentation)

All Superinterfaces:

Configuration

All Known Subinterfaces:

AccessLogPublisherCfg, CommonAuditAccessLogPublisherCfg, ConsoleErrorLogPublisherCfg, CsvFileAccessLogPublisherCfg, CsvFileHttpAccessLogPublisherCfg, DebugLogPublisherCfg, ErrorLogPublisherCfg, ExternalAccessLogPublisherCfg, ExternalHttpAccessLogPublisherCfg, FileBasedAccessLogPublisherCfg, FileBasedAuditLogPublisherCfg, FileBasedDebugLogPublisherCfg, FileBasedErrorLogPublisherCfg, FileBasedHttpAccessLogPublisherCfg, HttpAccessLogPublisherCfg, JsonFileAccessLogPublisherCfg, JsonFileHttpAccessLogPublisherCfg
```
public interface LogPublisherCfg
extends Configuration
```
A server-side interface for querying Log Publisher settings.
Log Publishers are responsible for distributing log messages from different loggers to a destination.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`addChangeListener(ConfigurationChangeListener<LogPublisherCfg> listener)`	Register to be notified when this Log Publisher is changed.
`Class<? extends LogPublisherCfg>`	`configurationClass()`	Gets the configuration class associated with this Log Publisher.
`String`	`getJavaClass()`	Gets the "java-class" property.
`boolean`	`isEnabled()`	Gets the "enabled" property.
`void`	`removeChangeListener(ConfigurationChangeListener<LogPublisherCfg> listener)`	Deregister an existing Log Publisher configuration change listener.

Methods inherited from interface org.forgerock.opendj.config.Configuration
dn, name

- Method Detail
  - configurationClass
```
Class<? extends LogPublisherCfg> configurationClass()
```
    Gets the configuration class associated with this Log Publisher.
    
    Specified by:
    
    configurationClass in interface Configuration
    
    Returns:
    
    Returns the configuration class associated with this Log Publisher.
  - addChangeListener
```
void addChangeListener(ConfigurationChangeListener<LogPublisherCfg> listener)
```
    Register to be notified when this Log Publisher is changed.
    
    Parameters:
    
    listener - The Log Publisher configuration change listener.
  - removeChangeListener
```
void removeChangeListener(ConfigurationChangeListener<LogPublisherCfg> listener)
```
    Deregister an existing Log Publisher configuration change listener.
    
    Parameters:
    
    listener - The Log Publisher configuration change listener.
  - isEnabled
```
boolean isEnabled()
```
    Gets the "enabled" property.
    Indicates whether the Log Publisher is enabled for use.
    
    Returns:
    
    Returns the value of the "enabled" property.
  - getJavaClass
```
String getJavaClass()
```
    Gets the "java-class" property.
    The fully-qualified name of the Java class that provides the Log Publisher implementation.
    
    Returns:
    
    Returns the value of the "java-class" property.