Package org.forgerock.opendj.server.config.client

Interface AccessLogPublisherCfgClient

All Superinterfaces:

ConfigurationClient, LogPublisherCfgClient

All Known Subinterfaces:

CommonAuditAccessLogPublisherCfgClient, CsvFileAccessLogPublisherCfgClient, ExternalAccessLogPublisherCfgClient, FileBasedAccessLogPublisherCfgClient, FileBasedAuditLogPublisherCfgClient, JsonFileAccessLogPublisherCfgClient

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

Modifier and Type	Method	Description
<C extends AccessLogFilteringCriteriaCfgClient> C	createAccessLogFilteringCriteria(ManagedObjectDefinition<C,? extends AccessLogFilteringCriteriaCfg> d, String name, Collection<PropertyException> exceptions)	Creates a new Access Log Filtering Criteria.
ManagedObjectDefinition<? extends AccessLogPublisherCfgClient,? extends AccessLogPublisherCfg>	definition()	Get the configuration definition associated with this Access Log Publisher.
AccessLogFilteringCriteriaCfgClient	getAccessLogFilteringCriteria(String name)	Gets the named Access Log Filtering Criteria.
ValueOrExpression<AccessLogPublisherCfgDefn.FilteringPolicy>	getFilteringPolicy()	Gets the "filtering-policy" property.
ValueOrExpression<String>	getJavaClass()	Gets the "java-class" property.
ValueOrExpression<Boolean>	isSuppressInternalOperations()	Gets the "suppress-internal-operations" property.
ValueOrExpression<Boolean>	isSuppressSynchronizationOperations()	Gets the "suppress-synchronization-operations" property.
String[]	listAccessLogFilteringCriteria()	Lists the Access Log Filtering Criteria.
void	removeAccessLogFilteringCriteria(String name)	Removes the named Access Log Filtering Criteria.
void	setFilteringPolicy(ValueOrExpression<AccessLogPublisherCfgDefn.FilteringPolicy> value)	Sets the "filtering-policy" property.
void	setJavaClass(ValueOrExpression<String> value)	Sets the "java-class" property.
void	setSuppressInternalOperations(ValueOrExpression<Boolean> value)	Sets the "suppress-internal-operations" property.
void	setSuppressSynchronizationOperations(ValueOrExpression<Boolean> value)	Sets the "suppress-synchronization-operations" property.

Methods inherited from interface org.forgerock.opendj.config.ConfigurationClient

commit, properties

Methods inherited from interface org.forgerock.opendj.server.config.client.LogPublisherCfgClient

isEnabled, setEnabled

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.

getFilteringPolicy

ValueOrExpression<AccessLogPublisherCfgDefn.FilteringPolicy> getFilteringPolicy()

Gets the "filtering-policy" property.

Specifies how filtering criteria should be applied to log records.

Default value: no-filtering

Returns:

Returns the value of the "filtering-policy" property.

setFilteringPolicy

void setFilteringPolicy(ValueOrExpression<AccessLogPublisherCfgDefn.FilteringPolicy> value)
                 throws PropertyException

Sets the "filtering-policy" property.

Specifies how filtering criteria should be applied to log records.

Parameters:

value - The value of the "filtering-policy" property.

Throws:

PropertyException - If the new value is invalid.

getJavaClass

@MandatoryProperty
ValueOrExpression<String> getJavaClass()

Gets the "java-class" property.

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

Default value: org.opends.server.loggers.AccessLogPublisher

Specified by:

getJavaClass in interface LogPublisherCfgClient

Returns:

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

setJavaClass

@MandatoryProperty
void setJavaClass(ValueOrExpression<String> value)
           throws PropertyException

Sets the "java-class" property.

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

Specified by:

setJavaClass in interface LogPublisherCfgClient

Parameters:

value - The value of the "java-class" property.

Throws:

PropertyException - If the new value is invalid.

isSuppressInternalOperations

ValueOrExpression<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.

Default value: true

Returns:

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

setSuppressInternalOperations

void setSuppressInternalOperations(ValueOrExpression<Boolean> value)
                            throws PropertyException

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:

PropertyException - If the new value is invalid.

isSuppressSynchronizationOperations

ValueOrExpression<Boolean> isSuppressSynchronizationOperations()

Gets the "suppress-synchronization-operations" property.

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

Default value: false

Returns:

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

setSuppressSynchronizationOperations

void setSuppressSynchronizationOperations(ValueOrExpression<Boolean> value)
                                   throws PropertyException

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:

PropertyException - If the new value is invalid.

listAccessLogFilteringCriteria

String[] listAccessLogFilteringCriteria()
                                 throws ConcurrentModificationException,
                                        LdapException

Lists the Access Log Filtering Criteria.

Returns:

Returns an array containing the names of the Access Log Filtering Criteria.

Throws:

ConcurrentModificationException - If this Access Log Publisher has been removed from the server by another client.

LdapException - If any other error occurs.

getAccessLogFilteringCriteria

AccessLogFilteringCriteriaCfgClient getAccessLogFilteringCriteria(String name)
                                                           throws DefinitionDecodingException,
                                                                  ManagedObjectDecodingException,
                                                                  ManagedObjectNotFoundException,
                                                                  ConcurrentModificationException,
                                                                  LdapException

Gets the named Access Log Filtering Criteria.

Parameters:

name - The name of the Access Log Filtering Criteria to retrieve.

Returns:

Returns the named Access Log Filtering Criteria.

Throws:

DefinitionDecodingException - If the named Access Log Filtering Criteria was found but its type could not be determined.

ManagedObjectDecodingException - If the named Access Log Filtering Criteria was found but one or more of its properties could not be decoded.

ManagedObjectNotFoundException - If the named Access Log Filtering Criteria was not found on the server.

ConcurrentModificationException - If this Access Log Publisher has been removed from the server by another client.

LdapException - If any other error occurs.

createAccessLogFilteringCriteria

<C extends AccessLogFilteringCriteriaCfgClient> C createAccessLogFilteringCriteria(ManagedObjectDefinition<C,? extends AccessLogFilteringCriteriaCfg> d,
                                                                                   String name,
                                                                                   Collection<PropertyException> exceptions)
                                                                            throws IllegalManagedObjectNameException

Creates a new Access Log Filtering Criteria. The new Access Log Filtering Criteria will initially not contain any property values (including mandatory properties). Once the Access Log Filtering Criteria has been configured it can be added to the server using the ConfigurationClient.commit() method.

Type Parameters:

C - The type of the Access Log Filtering Criteria being created.

Parameters:

d - The definition of the Access Log Filtering Criteria to be created.

name - The name of the new Access Log Filtering Criteria.

exceptions - An optional collection in which to place any PropertyExceptions that occurred whilst attempting to determine the default values of the Access Log Filtering Criteria. This argument can be null.

Returns:

Returns a new Access Log Filtering Criteria configuration instance.

Throws:

IllegalManagedObjectNameException - If the name of the new Access Log Filtering Criteria is invalid.

removeAccessLogFilteringCriteria

void removeAccessLogFilteringCriteria(String name)
                               throws ManagedObjectNotFoundException,
                                      OperationRejectedException,
                                      ConcurrentModificationException,
                                      LdapException

Removes the named Access Log Filtering Criteria.

Parameters:

name - The name of the Access Log Filtering Criteria to remove.

Throws:

ManagedObjectNotFoundException - If the Access Log Filtering Criteria does not exist.

OperationRejectedException - If the server refuses to remove the Access Log Filtering Criteria due to some server-side constraint which cannot be satisfied (for example, if it is referenced by another managed object).

ConcurrentModificationException - If this Access Log Publisher has been removed from the server by another client.

LdapException - If any other error occurs.