|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Method Summary | |
void |
activate()
Activates the entity (if a status attribute is defined for this entity). |
void |
deactivate()
Deactivates the entity (if a status attribute is defined for this entity). |
void |
delete()
Deletes the object. |
void |
delete(boolean recursive)
Deletes object(s). |
java.util.Map |
getAttributes()
Returns Map of all attributes. |
java.util.Map |
getAttributes(java.util.Set attributeNames)
Returns Map of specified attributes. |
java.lang.String |
getDN()
Returns the distinguished name of the entry. |
java.lang.String |
getOrganizationDN()
Gets the object's organization distinguished name. |
java.lang.String |
getParentDN()
Returns the parent distinguished name of the entry. |
boolean |
isActivated()
Returns true if the entity is activated. |
boolean |
isExists()
Returns true if the entry exists in the directory or not. |
void |
purge(boolean recursive,
int graceperiod)
Purges entry from data store. |
void |
removeAttributes(java.util.Set attributes)
Removes attributes in this AMObject . |
void |
setAttributes(java.util.Map attributes)
Sets attribute values in this AMObject . |
void |
store()
Stores the change to directory server. |
Method Detail |
public java.lang.String getDN()
public java.lang.String getParentDN()
public boolean isExists() throws SSOException
NOTE: This method internally invokes a call to the directory to verify the existence of the entry. There could be a performance overhead. Hence, please use your discretion while using this method.
SSOException
- if the single sign on token is no longer valid.public java.util.Map getAttributes() throws AMException, SSOException
AMException
- if an error is encountered when trying to
read attributes from the data store.SSOException
- if the single sign on token is no longer valid.public java.util.Map getAttributes(java.util.Set attributeNames) throws AMException, SSOException
attributeNames
- The Set of attribute names.AMException
- if an error is encountered when trying to
access/retrieve data from the data storeSSOException
- if the single sign on token is no longer valid.public void setAttributes(java.util.Map attributes) throws AMException, SSOException
AMObject
. Note that this
method sets or replaces the attribute value with the new value supplied.
Also, the attributes changed by this method are not committed to the
LDAP data store unless the method store()
is
called explicitly.attributes
- map of attribute name to a set of attribute values.
Each of the attribute value must be a string value.AMException
- if an error is encountered when trying to
set/replace attributes from the data store.SSOException
- if the single sign on token is no longer valid.public void removeAttributes(java.util.Set attributes) throws AMException, SSOException
AMObject
.
The attributes are removed from the LDAP data store.attributes
- The Set of attribute names.AMException
- if an error is encountered when trying to
remove attributes from the data store.SSOException
- if the single sign on token is no longer valid.public void activate() throws AMException, SSOException
AMException
- if an error is encountered when trying to
activate the managed object.SSOException
- if the single sign on token is no longer valid.public void deactivate() throws AMException, SSOException
AMException
- if an error is encountered when trying to
deactivate the managed object.SSOException
- if the single sign on token is no longer valid.public boolean isActivated() throws AMException, SSOException
AMException
- if an error is encountered when trying to
get the status attribute from the data store.SSOException
- if the single sign on token is no longer valid.public void delete() throws AMException, SSOException
AMException
- if an error is encountered when trying to
delete entry from the data store.SSOException
- if the single sign on token is no longer valid.delete(boolean)
,
purge(boolean, int)
public void delete(boolean recursive) throws AMException, SSOException
Organization, Group, User
purge()
should be used to physically delete this object.recursive
- if true delete the object and any objects under it,
otherwise, delete the object only.AMException
- if an error is encountered when trying to
delete entry from the data store.SSOException
- if the single sign on token is no longer valid.purge(boolean, int)
public java.lang.String getOrganizationDN() throws AMException, SSOException
AMEntity
instance every time to obtain the organization
distinguished name is not recommended.AMException
- if an error is encountered when trying to
access/retrieve data from the data store or the object does not
have organization distinguished name.SSOException
- if the single sign on token is no longer valid.public void store() throws AMException, SSOException
setAttributes
so that the changes that are made can be permanently committed to
the LDAP data store.AMException
- if an error is encountered when trying to
save the attributes to the data store.SSOException
- if the single sign on token is no longer valid.public void purge(boolean recursive, int graceperiod) throws AMException, SSOException
delete()
will not. There is a
big PERFORMANCE hit if this method is used to delete a large
organization in the recursive mode.recursive
- true to recursively delete the whole subtree.graceperiod
- If set to an integer greater than -1, it will verify
if the object was last modified at least that many days ago before
physically deleting it. Pre/Post Callback plugins as registered
in the Administration Service, will be called upon object
deletion. If any of the pre-callback classes throw an exception,
then the operation is aborted.AMException
- if there is an internal error in the data store.SSOException
- if the single sign on token is no longer valid.delete()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |