Package com.isode.dsapi.config

Class FailoverAgreement

java.lang.Object

com.isode.dsapi.config.ManagedObject

com.isode.dsapi.config.FailoverAgreement

public class FailoverAgreement
extends ManagedObject

Failover agreement object. It is intended that no attributes of this class should be modified. TODO: it might be sensible to combine stuff in here with that in ShadowAgreement, since they'll have the same set of fields trac 3031

Since:

15.0

Author:

dsm

Field Summary

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

logger

Constructor Summary

Constructors

Constructor	Description
FailoverAgreement(Entry entry, IsodeDirectorySession ds, DN gdamDN)	Construct from the entry object.

Method Summary

Modifier and Type	Method	Description
void	commit()	Override the superclass method with one that always throws a ConfigOpFailedException, since it's never expected that anyone write back this type of entry.
DN	getDsaDN()
DN	getGdamDN()
Integer	getID()
int	getLastError()	Determine the value of the last error (if any).
Date	getLastErrorTime()	Determine the time when the last error was reported
Date	getLastUpdateTime()	Determine the time when the last update was reported.
void	load(Entry entry)	Populate the fields in this object based on the contents of an Entry.

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

addAttribute, addAttribute, addAttribute, addAttributeValue, addAttributeValue, addEntry, addOC, checkMandatory, checkMandatory, checkMandatory, checkMandatory, 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

Constructor Details

FailoverAgreement

public FailoverAgreement(Entry entry,
 IsodeDirectorySession ds,
 DN gdamDN)
                  throws ConfigOpFailedException

Construct from the entry object.

Parameters:

entry - Entry representing the config.

ds - Isode directory session

gdamDN - DN of GDAM. Must not be null.

Throws:

ConfigOpFailedException - if mandatory attributes are not loaded

Method Details

load

public void load(Entry entry)
          throws ConfigOpFailedException

Populate the fields in this object based on the contents of an Entry.

The original class doc says that "It is intended that no attributes of this class should be modified" which I think means that there are no setters in the class, but it is possible for callers to call this method to refresh the object in line with the current DSA contents.

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

getID

public Integer getID()

Returns:

agreement/GDAM ID, will never be null

getGdamDN

public DN getGdamDN()

Returns:

GDAM DN, will never be null

getDsaDN

public DN getDsaDN()

Returns:

failover DSA DN, will never be null

getLastUpdateTime

public Date getLastUpdateTime()

Determine the time when the last update was reported.

Returns:

last update time, which will be null if no update time is reported.

getLastErrorTime

public Date getLastErrorTime()

Determine the time when the last error was reported

Returns:

last error time, which will be null if no error time is reported.

getLastError

public int getLastError()

Determine the value of the last error (if any).

Returns:

last error, which will be zero if no error has been reported.

commit

public void commit()
            throws ReadFailedException,
ConfigOpFailedException

Override the superclass method with one that always throws a ConfigOpFailedException, since it's never expected that anyone write back this type of entry.

Overrides:

commit in class ManagedObject

Throws:

ConfigOpFailedException - always

ReadFailedException - never

See Also:

• ManagedObject.reset(Entry)