Package com.isode.dsapi.config

Class MESHAgreementReport

java.lang.Object

com.isode.dsapi.config.ManagedObject

com.isode.dsapi.config.MESHAgreementReport

public class MESHAgreementReport
extends ManagedObject

MESHAgreementReport encapsulates the reported state of a MESH agreement. This maps to a single virtual entry, named by the agreement ID. Such entries area always subordinate to 'cm=mesh,cn=config'.

Since:

16.3

Field Summary

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

logger

Constructor Summary

Constructors

Constructor	Description
MESHAgreementReport(Entry entry, IsodeDirectorySession ds)	Constructor.

Method Summary

Modifier and Type	Method	Description
Integer	getID()	Get the ID of the monitored agreement.
Date	getLastUpdateTime()	Get the last update time.
MESH.AgreementState	getState()	Get the agreement state as a string.
Set<Integer>	getSyncedWith()	Get the set of servers synceed with.
void	load(Entry entry)	Load values from an entry.

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

Constructor Details

MESHAgreementReport

public MESHAgreementReport(Entry entry,
 IsodeDirectorySession ds)
                    throws ConfigOpFailedException

Constructor.

Parameters:

entry - Entry to create from. Must not be null.

ds - Isode directory session. Must not be null.

Throws:

ConfigOpFailedException - if mandatory attributes are not loaded

Method Details

load

public void load(Entry entry)
          throws ConfigOpFailedException

Description copied from class: ManagedObject

Load values from an entry. No directory operation should be done in this method.

Mandatory variables are assigned only after everything is ok. This is done so during re-loading, if there are exceptions and even then the object is used, there is no crash by using mandatory variables that are assumed to have non-null values.

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()

Get the ID of the monitored agreement.

Returns:

The ID of the agreement, never null.

getState

public MESH.AgreementState getState()

Get the agreement state as a string.

Returns:

The MESH.AgreementState, never null.

getLastUpdateTime

public Date getLastUpdateTime()

Get the last update time.

Returns:

The last update time, can be null.

getSyncedWith

public Set<Integer> getSyncedWith()

Get the set of servers synceed with.

Returns:

Set of integers, can be null.