org.opends.server.admin.std.client
Interface AccessLogPublisherCfgClient

All Superinterfaces:
ConfigurationClient, LogPublisherCfgClient
All Known Subinterfaces:
FileBasedAccessLogPublisherCfgClient

public interface AccessLogPublisherCfgClient
extends LogPublisherCfgClient

A client-side interface for reading and modifying Access Log Publisher settings.

Access Log Publishers are responsible for distributing access log messages from the access logger to a destination.


Method Summary
 ManagedObjectDefinition<? extends AccessLogPublisherCfgClient,? extends AccessLogPublisherCfg> definition()
          Get the configuration definition associated with this Access Log Publisher.
 java.lang.String getJavaClass()
          Gets the "java-class" property.
 boolean isSuppressInternalOperations()
          Gets the "suppress-internal-operations" property.
 boolean isSuppressSynchronizationOperations()
          Gets the "suppress-synchronization-operations" property.
 void setJavaClass(java.lang.String value)
          Sets the "java-class" property.
 void setSuppressInternalOperations(java.lang.Boolean value)
          Sets the "suppress-internal-operations" property.
 void setSuppressSynchronizationOperations(java.lang.Boolean value)
          Sets the "suppress-synchronization-operations" property.
 
Methods inherited from interface org.opends.server.admin.std.client.LogPublisherCfgClient
isEnabled, setEnabled
 
Methods inherited from interface org.opends.server.admin.ConfigurationClient
commit, properties
 

Method Detail

definition

ManagedObjectDefinition<? extends AccessLogPublisherCfgClient,? extends AccessLogPublisherCfg> definition()
Get the configuration definition associated with this Access Log Publisher.

Specified by:
definition in interface ConfigurationClient
Specified by:
definition in interface LogPublisherCfgClient
Returns:
Returns the configuration definition associated with this Access Log Publisher.

getJavaClass

java.lang.String getJavaClass()
Gets the "java-class" property.

The fully-qualified name of the Java class that provides the Access Log Publisher implementation.

Returns:
Returns the value of the "java-class" property.

setJavaClass

void setJavaClass(java.lang.String value)
                  throws IllegalPropertyValueException
Sets the "java-class" property.

The fully-qualified name of the Java class that provides the Access Log Publisher implementation.

Parameters:
value - The value of the "java-class" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

isSuppressInternalOperations

boolean isSuppressInternalOperations()
Gets the "suppress-internal-operations" property.

Indicates whether internal operations (for example, operations that are initiated by plugins) should be logged along with the operations that are requested by users.

Returns:
Returns the value of the "suppress-internal-operations" property.

setSuppressInternalOperations

void setSuppressInternalOperations(java.lang.Boolean value)
                                   throws IllegalPropertyValueException
Sets the "suppress-internal-operations" property.

Indicates whether internal operations (for example, operations that are initiated by plugins) should be logged along with the operations that are requested by users.

Parameters:
value - The value of the "suppress-internal-operations" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

isSuppressSynchronizationOperations

boolean isSuppressSynchronizationOperations()
Gets the "suppress-synchronization-operations" property.

Indicates whether access messages that are generated by synchronization operations should be suppressed.

Returns:
Returns the value of the "suppress-synchronization-operations" property.

setSuppressSynchronizationOperations

void setSuppressSynchronizationOperations(java.lang.Boolean value)
                                          throws IllegalPropertyValueException
Sets the "suppress-synchronization-operations" property.

Indicates whether access messages that are generated by synchronization operations should be suppressed.

Parameters:
value - The value of the "suppress-synchronization-operations" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.