Package com.isode.dsapi.config

Class LogConfigObject

java.lang.Object

com.isode.dsapi.config.ManagedObject

com.isode.dsapi.config.LogConfigObject

public class LogConfigObject
extends ManagedObject

Class representing DSA's logging configuration streams

Since:

15.0

Field Summary

Fields inherited from class com.isode.dsapi.config.ManagedObject

logger

Method Summary

Modifier and Type	Method	Description
void	commitLoggingConfiguration()	Commit the logging configuration to the DSA
com.isode.logconfig.stream.FileLogStream	getDefaultAuditStream()	Get the DSA's Default Audits Stream
com.isode.logconfig.stream.FileLogStream	getDefaultEventStream()	Get the DSA's default events stream
com.isode.logconfig.XMLLogConfig	getDsaLogConfig()	Get the DSA's logging configuration
String	getParseError()
void	load(Entry entry)	Load the logging configuration for the dsa from its attribute.

Methods inherited from class com.isode.dsapi.config.ManagedObject

addAttribute, addAttribute, addAttribute, addAttributeValue, addAttributeValue, addEntry, addOC, checkMandatory, checkMandatory, checkMandatory, checkMandatory, commit, commitNoRefresh, createAP, createAttributeType, createDN, createPA, createRDN, createRDN, getAttribute, getAttributeDefaultWhenNull, getDN, getIsodeDirectorySession, getMultiValueBer, getMultiValuedInteger, getMultiValuedInteger, getMultiValuedString, getMultiValuedString, getPA, getValue, getValueAttrTypeFromOID, getValueBer, getValueBoolean, getValueDate, getValueDate, getValueDN, getValueInteger, getValueInteger, getValueString, getValueString, getValueStringFromAttribute, hasAttributeChanged, hasChanges, remove, removeAttr, removeStringValue, reset, reset, updateAttr, updateAttr, updateAttr, updateBoolean, updateDN, updateInteger, updateMultiValuedBER, updateMultiValuedInteger, updateMultiValuedString, updatePA, updatePA, updateString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

load

public void load(Entry entry)
          throws ConfigOpFailedException

Load the logging configuration for the dsa from its attribute. If none is found then attempt to create one and try to commit it.

Specified by:

load in class ManagedObject

Parameters:

entry - Entry representing the object, could be null if the existing entry has to be reloaded

Throws:

ConfigOpFailedException - if mandatory attributes are not loaded

commitLoggingConfiguration

public void commitLoggingConfiguration()
                                throws ReadFailedException,
ConfigOpFailedException

Commit the logging configuration to the DSA

Throws:

ReadFailedException - if there is a problem on reading the committed entry back.

ConfigOpFailedException - if there is an error while updating the log config attribute to the DSA

getDsaLogConfig

public com.isode.logconfig.XMLLogConfig getDsaLogConfig()

Get the DSA's logging configuration

Returns:

logging configuration

getDefaultAuditStream

public com.isode.logconfig.stream.FileLogStream getDefaultAuditStream()

Get the DSA's Default Audits Stream

Returns:

default audits stream

getDefaultEventStream

public com.isode.logconfig.stream.FileLogStream getDefaultEventStream()

Get the DSA's default events stream

Returns:

default events stream

getParseError

public String getParseError()