public interface AccessLogPublisherCfgClient extends LogPublisherCfgClient
Access Log Publishers are responsible for distributing access log messages from the access logger to a destination.
Modifier and Type | Method and Description |
---|---|
<C extends AccessLogFilteringCriteriaCfgClient> |
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.
|
AccessLogPublisherCfgDefn.FilteringPolicy |
getFilteringPolicy()
Gets the "filtering-policy" property.
|
String |
getJavaClass()
Gets the "java-class" property.
|
boolean |
isSuppressInternalOperations()
Gets the "suppress-internal-operations" property.
|
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(AccessLogPublisherCfgDefn.FilteringPolicy value)
Sets the "filtering-policy" property.
|
void |
setJavaClass(String value)
Sets the "java-class" property.
|
void |
setSuppressInternalOperations(Boolean value)
Sets the "suppress-internal-operations" property.
|
void |
setSuppressSynchronizationOperations(Boolean value)
Sets the "suppress-synchronization-operations" property.
|
isEnabled, setEnabled
commit, properties
ManagedObjectDefinition<? extends AccessLogPublisherCfgClient,? extends AccessLogPublisherCfg> definition()
definition
in interface ConfigurationClient
definition
in interface LogPublisherCfgClient
AccessLogPublisherCfgDefn.FilteringPolicy getFilteringPolicy()
Specifies how filtering criteria should be applied to log records.
void setFilteringPolicy(AccessLogPublisherCfgDefn.FilteringPolicy value) throws PropertyException
Specifies how filtering criteria should be applied to log records.
value
- The value of the "filtering-policy" property.PropertyException
- If the new value is invalid.String getJavaClass()
The fully-qualified name of the Java class that provides the Access Log Publisher implementation.
getJavaClass
in interface LogPublisherCfgClient
void setJavaClass(String value) throws PropertyException
The fully-qualified name of the Java class that provides the Access Log Publisher implementation.
setJavaClass
in interface LogPublisherCfgClient
value
- The value of the "java-class" property.PropertyException
- If the new value is invalid.boolean isSuppressInternalOperations()
Indicates whether internal operations (for example, operations that are initiated by plugins) should be logged along with the operations that are requested by users.
void setSuppressInternalOperations(Boolean value) throws PropertyException
Indicates whether internal operations (for example, operations that are initiated by plugins) should be logged along with the operations that are requested by users.
value
- The value of the "suppress-internal-operations" property.PropertyException
- If the new value is invalid.boolean isSuppressSynchronizationOperations()
Indicates whether access messages that are generated by synchronization operations should be suppressed.
void setSuppressSynchronizationOperations(Boolean value) throws PropertyException
Indicates whether access messages that are generated by synchronization operations should be suppressed.
value
- The value of the "suppress-synchronization-operations" property.PropertyException
- If the new value is invalid.String[] listAccessLogFilteringCriteria() throws ConcurrentModificationException, LdapException
ConcurrentModificationException
- If this Access Log Publisher has been removed from the
server by another client.LdapException
- If any other error occurs.AccessLogFilteringCriteriaCfgClient getAccessLogFilteringCriteria(String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, LdapException
name
- The name of the Access Log Filtering Criteria to
retrieve.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.<C extends AccessLogFilteringCriteriaCfgClient> C createAccessLogFilteringCriteria(ManagedObjectDefinition<C,? extends AccessLogFilteringCriteriaCfg> d, String name, Collection<PropertyException> exceptions) throws IllegalManagedObjectNameException
ConfigurationClient.commit()
method.C
- The type of the Access Log Filtering Criteria being
created.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 PropertyException
s that occurred whilst attempting to
determine the default values of the Access Log Filtering
Criteria. This argument can be null.
IllegalManagedObjectNameException
- If the name of the new Access Log Filtering Criteria is
invalid.void removeAccessLogFilteringCriteria(String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, LdapException
name
- The name of the Access Log Filtering Criteria to remove.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.Copyright 2010-2017 ForgeRock AS.