Package com.isode.dsapi.config

Class SupplierAgreement

java.lang.Object

com.isode.dsapi.config.ManagedObject

com.isode.dsapi.config.ShadowAgreement

com.isode.dsapi.config.SupplierAgreement

public class SupplierAgreement
extends ShadowAgreement

Supplier agreement object.

Since:

15.0

Author:

mv

Nested Class Summary

Nested classes/interfaces inherited from class com.isode.dsapi.config.ShadowAgreement

ShadowAgreement.ShadowError

Field Summary

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

agreementId, agreementVersion, beginTimeStr, isEnabled, isOtherTimes, lastError, lastErrorTime, lastSuccessTime, lastUpdateTime, onChange, peerDsaDN, prefixDN, supplierInitiated, updateInterval, windowSize

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

logger

Constructor Summary

Constructors

Constructor	Description
SupplierAgreement(Entry agreement, Entry state, IsodeDirectorySession ds)	Construct from the entry object.

Method Summary

Modifier and Type	Method	Description
static SupplierAgreement	create(IsodeDirectorySession ds, DN dsa_dn, Integer id, Integer version, DN prefix_dn, Boolean enabled)	Create a basic on change agreement.
MS.AttributeSelection	getAttributeSelection()	Get the attribute selection.
Boolean	getForbidAutoTotal()	Get the forbid auto total flag.
BAC.SubtreeSpecification	getShadowArea()	Get the shadow area.
void	load(Entry entry)	Load values from an entry.
void	setAttributeSelection(MS.AttributeSelection selection)	Set the attribute selection.
void	setForbidAutoTotal(Boolean forbid)	Set the forbid auto total flag.
void	setShadowArea(BAC.SubtreeSpecification area)	Set the shadow area.
String	toString()

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

buildDN, create, forceUpdate, getAgreementID, getAgreementVersion, getBeginTime, getEnabled, getForceNowTime, getOnChange, getOtherTimes, getPeer, getShadowError, getShadowPrefix, getSupplierInitiated, getUpdateInterval, getWindowSize, lastError, lastErrorString, lastErrorTime, lastSuccessTime, lastUpdateTime, loadAgreement, loadState, setAgreementVersion, setBeginTime, setEnabled, setOnChange, setOtherTimes, setSupplierInitiated, setUpdateInterval, setWindowSize

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, wait, wait, wait

Constructor Details

SupplierAgreement

public SupplierAgreement(Entry agreement,
 Entry state,
 IsodeDirectorySession ds)
                  throws ConfigOpFailedException

Construct from the entry object.

Parameters:

agreement - Entry representing the agreement, must not be null

state - Entry representing the state, can be null if not read

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

create

public static SupplierAgreement create(IsodeDirectorySession ds,
 DN dsa_dn,
 Integer id,
 Integer version,
 DN prefix_dn,
 Boolean enabled)
                                throws ConfigOpFailedException,
ReadFailedException

Create a basic on change agreement.

Parameters:

ds - Isode directory session.

dsa_dn - DSA DN.

id - Agreement ID.

version - Agreement version.

prefix_dn - Prefix DN.

enabled - Agreement enabled flag.

Returns:

The created agreement.

Throws:

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

ConfigOpFailedException - if there is any other problem on applying the changes.

getShadowArea

public BAC.SubtreeSpecification getShadowArea()

Get the shadow area.

Returns:

Shadow area.

setShadowArea

public void setShadowArea(BAC.SubtreeSpecification area)

Set the shadow area.

Parameters:

area - Shadow area.

getAttributeSelection

public MS.AttributeSelection getAttributeSelection()

Get the attribute selection.

Returns:

Attribute Selection.

setAttributeSelection

public void setAttributeSelection(MS.AttributeSelection selection)

Set the attribute selection.

Parameters:

selection - Attribute Selection.

getForbidAutoTotal

public Boolean getForbidAutoTotal()

Get the forbid auto total flag.

Returns:

Forbid Auto Flag

setForbidAutoTotal

public void setForbidAutoTotal(Boolean forbid)

Set the forbid auto total flag.

Parameters:

forbid - Forbid Auto Flag

toString

public String toString()

Overrides:

toString in class ShadowAgreement