com.iplanet.am.sdk

Class AMEntityImpl

java.lang.Object

com.iplanet.am.sdk.AMEntityImpl

All Implemented Interfaces:

AMConstants, AMEntity, AMObject

public class AMEntityImpl
extends Object
implements AMEntity

Field Summary

Fields

Modifier and Type	Field and Description
protected static Debug	debug Deprecated.
protected IDirectoryServices	dsServices Deprecated.
protected String	entryDN Deprecated.
protected String	locale Deprecated.
protected static Hashtable	profileNameTable Deprecated. Hash table used to keep track of elements that need to be removed from objImplListeners table when a SSOToken is no longer valid.
protected int	profileType Deprecated.
protected String	rfcDN Deprecated.
protected SSOToken	token Deprecated.

Fields inherited from interface com.iplanet.am.sdk.AMObject

ACTIVE, ACTIVE_VALUE, ASSIGNABLE_DYNAMIC_GROUP, DELETED, DELETED_VALUE, DYNAMIC_GROUP, FILTERED_ROLE, GROUP, GROUP_CONTAINER, GROUP_PROFILE, INACTIVE, INACTIVE_VALUE, MANAGED_ROLE, ORGANIZATION, ORGANIZATIONAL_UNIT, PEOPLE_CONTAINER, POLICY, RESOURCE, ROLE, ROLE_PROFILE, SERVICE, STATIC_GROUP, TEMPLATE, UNDETERMINED_OBJECT_TYPE, UNKNOWN_OBJECT_TYPE, USER

Fields inherited from interface com.iplanet.am.sdk.AMConstants

ADD_MEMBER, ADMIN_GROUPS_ENABLED_ATTR, ADMIN_ROLE_ATTR, ADMINISTRATION_SERVICE, CACHE_ENABLED_DISABLED_KEY, CACHE_MAX_SIZE_KEY, COMPLIANCE_SPECIAL_FILTER_ATTR, COMPLIANCE_USER_DELETION_ATTR, CONTAINER_DEFAULT_TEMPLATE_ROLE, CONTAINER_SUPPORTED_TYPES_ATTRIBUTE, DCT_ATTRIBUTE_LIST_ATTR, DCT_ENABLED_ATTR, DOMAIN_ADMINISTRATORS, DOMAIN_HELP_DESK_ADMINISTRATORS, EMAIL_ATTRIBUTE, FILTER_ATTR_NAME, INET_ADMIN_OBJECT_CLASS, INET_DOMAIN_STATUS_ATTR, INET_DOMAIN_STATUS_ATTRIBUTE, INVALID_USERID_CHARACTERS, OTHER_COSATTR_TYPE, POLICY_COSATTR_TYPE, POLICY_SUFFIX, PRE_POST_PROCESSING_MODULES_ATTR, REMOVE_ATTRIBUTE, REMOVE_MEMBER, REQUIRED_SERVICES_ATTR, ROLE_MANAGED_CONTAINER_DN_ATTRIBUTE, SCOPE_BASE, SCOPE_ONE, SCOPE_SUB, SERVICE_STATUS_ATTRIBUTE, STATIC_GROUP_DN_ATTRIBUTE, SUBSCRIBABLE_ATTRIBUTE, UNIQUE_ATTRIBUTE_LIST_ATTRIBUTE, UNIQUE_MEMBER_ATTRIBUTE, USER_CREATE_NOTIFICATION_LIST, USER_DELETE_NOTIFICATION_LIST, USER_ENCRYPTED_PASSWORD_ATTRIBUTE, USER_ENTRY_PROCESSING_IMPL, USER_MODIFY_NOTIFICATION_LIST, USER_PASSWORD_ATTRIBUTE, USER_SEARCH_RETURN_ATTR, USERID_PASSWORD_VALIDATION_CLASS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AMEntityImpl(SSOToken ssotoken, String dn)
protected	AMEntityImpl(SSOToken ssotoken, String dn, int type)

Method Summary

Modifier and Type	Method and Description
void	activate() Activates the entity (if a status attribute is defined for this entity).
void	addEventListener(AMEventListener listener) Deprecated. Register a AMEventListener that needs to be invoked when a relevant event occurs.
void	assignPolicies(String serviceName, Set policyDNs) Deprecated. Assigns the given policies to this object.
void	assignServices(Map serviceNamesAndAttr) Deprecated. Assigns a set of services and the attributes for a service to the user.
void	assignServices(Map serviceNamesAndAttr, boolean store) Deprecated. Assigns a set of services and the attributes for a service to the user.
protected static String	constructFilter(Map avPairs) Deprecated.
protected static String	constructFilter(String objectClassFilter) Deprecated.
protected static String	constructFilter(String namingAttr, String objectClassFilter, String wildcard) Deprecated.
void	create() Deprecated.
void	create(String stype)
AMTemplate	createPolicyTemplate(String serviceName, Map attributes) Deprecated. Creates a Policy Template with no priority for the given service associated with this AMObject.
AMTemplate	createPolicyTemplate(String serviceName, Map attributes, int priority) Deprecated. Creates a Policy Template with a priority for the given service associated with this AMObject.
AMTemplate	createTemplate(int templateType, String serviceName, Map attributes) Deprecated. Creates a Template with no priority for the given service associated with this AMObject.
AMTemplate	createTemplate(int templateType, String serviceName, Map attributes, int priority) Deprecated. Creates a Template with a priority for the given service associated with this AMObject.
AMTemplate	createTemplate(int templateType, String serviceName, Map attributes, int priority, Set policyDNs) Deprecated.
void	deactivate() Deactivates the entity (if a status attribute is defined for this entity).
void	delete() Removes and destroys the object.
void	delete(boolean recursive) Deletes object.
Set	getAssignedServices() Deprecated. Gets all service names that are assigned to the user/group/org.
Set	getAttribute(String attributeName) Deprecated. Returns attribute value.
byte[][]	getAttributeByteArray(String attributeName) Deprecated. Returns attribute value.
Map	getAttributes() Returns Map of all attributes.
Map	getAttributes(Set attributeNames) Returns Map of specified attributes.
Map	getAttributesByteArray() Deprecated. Returns Map of all attributes.
Map	getAttributesByteArray(Set attributeNames) Deprecated. Returns Map of specified attributes.
Map	getAttributesFromDataStore() Deprecated. Returns Map of all attributes directly from data store.
Map	getAttributesFromDataStore(Set attributeNames) Deprecated. Returns Map of specified attributes directly from data store.
boolean	getBooleanAttribute(String attributeName) Deprecated.
String	getDN() Returns the DN of the entry.
int	getIntegerAttribute(String attributeName) Deprecated.
String	getOrganizationDN() Gets the object's organization.
String	getParentDN() Returns the parent DN of the entry.
Map	getPolicy(String serviceName) Deprecated. Returns the effective service policy defined at this object after considering any inheritance from any policy templates.
AMTemplate	getPolicyTemplate(String serviceName) Deprecated. Returns the policy template for a service defined for this object ignoring any inheritance.
protected Set	getRoleDNs()
protected String	getSearchFilter(int objectType) Deprecated.
protected String	getSearchFilter(int objectType, String searchTempName) Deprecated.
Map	getServiceAttributes(String serviceName) Deprecated. Returns Map of all attributes of specified service.
String	getServiceStatus(String serviceName) Deprecated. Get the status of the service for this entity (user/group/organization/ organizational unit).
String	getStringAttribute(String attributeName) Deprecated. Returns string type attribute value.
AMTemplate	getTemplate(String serviceName, int templateType) Deprecated. Returns the Template for the given service associated with this AMObject.
boolean	isActivated() Returns true if the entity is activated.
boolean	isExists() Checks if the entry exists in the directory or not.
void	modifyService(String sname, Map attrMap) Deprecated. Modify the service attributes of a service assigned to a entity (user/group/organization/organizational unit).
protected static void	notifyACIChangeEvent(String dn, int eventType) Deprecated. Notifies ACI Change.
protected static void	notifyAffectedDNs(String affectedDN, AMEvent dpEvent) Deprecated. Sends event notifications to all the listeners that correspond to a DN whose suffix which ends with affectedDN in the objImpListeners.
protected static void	notifyEntryEvent(String dn, int eventType, boolean cosType) Deprecated. This method will be called EntryEventListener to send notifications to all interested AMObjectImp's whenever an Entry Event occurs.
void	purge(boolean recursive, int graceperiod) Method to hard Delete an object.
void	removeAttributes(Set attributes) Removes attributes in this AMObject.
void	removeEventListener(AMEventListener listener) Deprecated. UnRegister a previously registered event listener.
protected static Set	removeFromProfileNameTable(SSOToken ssoToken) Deprecated. This method removes the entry corresponding to SSOTokenID supplied.
protected static void	removeObjImplListeners(Set dnSet, SSOTokenID ssoTokenId) Deprecated. Method that removes all the entries that correspond ("dn",ssoTokenId) supplied.
protected Set	replaceAciListMacros(Set aciSet, String roleDN, String orgDN, String groupDN, String pcDN) Deprecated. Substitutes the macros in the set of DN:ACI.
protected String	replaceAciMacro(String aci, String macro, String str) Deprecated.
protected String	replaceAciMacros(String aci, String roleDN, String orgDN, String groupDN, String pcDN) Deprecated.
Set	search(int level, String filter) Deprecated. Search objects based on specified level and filter.
protected AMSearchResults	searchObjects(int[] objectTypes, String wildcard, Map avPairs, AMSearchControl searchControl) Deprecated.
protected Set	searchObjects(int[] objectTypes, String wildcard, Map avPairs, int level) Deprecated.
protected AMSearchResults	searchObjects(String objectClassFilter, AMSearchControl searchControl, String avfilter) Deprecated.
protected AMSearchResults	searchObjects(String namingAttr, String objectClassFilter, String wildcard, AMSearchControl searchControl, String avfilter) Deprecated.
protected AMSearchResults	searchObjects(String namingAttr, String objectClassFilter, String wildcard, Map avPairs, AMSearchControl searchControl) Deprecated.
Set	searchObjects(String namingAttr, String objectClassFilter, String wildcard, Map avPairs, int level) Deprecated.
protected static void	sendExpiryEvent(String sourceDN, int sourceType) Deprecated.
void	setAttribute(String attributeName, Set attributeValue) Deprecated.
void	setAttributeByteArray(String attrName, byte[][] byteValues) Deprecated. Sets byte attribute values in this AMObject.
void	setAttributes(Map attributes) Sets attribute values in this AMObject.
void	setAttributesByteArray(Map attributes) Deprecated. Sets byte attribute values in this AMObject.
void	setBooleanAttribute(String attributeName, boolean value) Deprecated.
void	setIntegerAttribute(String attributeName, int value) Deprecated.
void	setServiceStatus(String sname, String status) Deprecated. Set the status of the service for this entity (User/Organization /Group/Organizational Unit).
void	setStringAttribute(String attributeName, String value) Deprecated. Sets string type attribute value.
void	store() Stores the change to directory server.
void	store(boolean isAdd) Deprecated. Stores the change to directory server.
void	unassignPolicies(String serviceName, Set policyDNs) Deprecated. Unassigns the given policies from this object.
void	unassignServices(Set serviceNames) Deprecated. Unassigns services from the user.

Methods inherited from class java.lang.Object

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

Field Detail

profileNameTable

protected static Hashtable profileNameTable

Deprecated.

Hash table used to keep track of elements that need to be removed from objImplListeners table when a SSOToken is no longer valid. The key is SSOTokenId & the value is a Set of DN's.

debug

protected static Debug debug

Deprecated.

dsServices

protected IDirectoryServices dsServices

Deprecated.

token

protected SSOToken token

Deprecated.

entryDN

protected String entryDN

Deprecated.

rfcDN

protected String rfcDN

Deprecated.

locale

protected String locale

Deprecated.

profileType

protected int profileType

Deprecated.

Constructor Detail

AMEntityImpl

protected AMEntityImpl(SSOToken ssotoken,
                       String dn)

AMEntityImpl

protected AMEntityImpl(SSOToken ssotoken,
                       String dn,
                       int type)

Method Detail

delete

public void delete(boolean recursive)
            throws AMException,
                   SSOException

Deletes object. This method takes a boolean parameter, if its value is true, will remove all sub entries and the object itself, otherwise, will try to remove the object only. Two notes on recursive delete. First, be aware of the PERFORMANCE hit when large amount of child objects present. Second, it won't follow referral.

Specified by:

delete in interface AMEntity

Specified by:

delete in interface AMObject

Parameters:

recursive - if true delete the object and any objects under it, otherwise, delete the object only.

Throws:

AMException - if there is an internal problem with AM Store.

SSOException - if the sign-on is no longer valid.

See Also:

AMObject.purge(boolean, int)

getAttributes

public Map getAttributes()
                  throws AMException,
                         SSOException

Description copied from interface: AMObject

Returns Map of all attributes. Map key is the attribute name and value is the attribute value.

Specified by:

getAttributes in interface AMEntity

Specified by:

getAttributes in interface AMObject

Returns:

Map of all attributes.

Throws:

AMException - if an error is encountered when trying to access/retrieve data from the data store.

SSOException - if the single sign on token is no longer valid.

getDN

public String getDN()

Description copied from interface: AMObject

Returns the DN of the entry.

Specified by:

getDN in interface AMEntity

Specified by:

getDN in interface AMObject

Returns:

String DN

getOrganizationDN

public String getOrganizationDN()
                         throws AMException,
                                SSOException

Gets the object's organization.

Specified by:

getOrganizationDN in interface AMEntity

Specified by:

getOrganizationDN in interface AMObject

Returns:

The object's organization DN.

Throws:

AMException - if there is an internal error in the AM Store or the object doesn't have organzation DN.

SSOException - if the sign on is no longer valid

getParentDN

public String getParentDN()

Description copied from interface: AMObject

Returns the parent DN of the entry.

Specified by:

getParentDN in interface AMEntity

Specified by:

getParentDN in interface AMObject

Returns:

String DN

isExists

public boolean isExists()
                 throws SSOException

Checks if the entry exists in the directory or not. First a syntax check is done on the DN string corresponding to the entry. If the DN syntax is valid, a directory call will be made to check for the existence of the entry.

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.

Specified by:

isExists in interface AMEntity

Specified by:

isExists in interface AMObject

Returns:

false if the entry does not have a valid DN syntax or if the entry does not exists in the Directory. True otherwise.

Throws:

SSOException - if the sign-on is no longer valid.

purge

public void purge(boolean recursive,
                  int graceperiod)
           throws AMException,
                  SSOException

Method to hard Delete an object.

Specified by:

purge in interface AMEntity

Specified by:

purge in interface AMObject

Parameters:

recursive - If true, then 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.

Throws:

AMException - if there is an internal error in the access management data store.

SSOException - if the single sign on token is no longer valid

See Also:

AMObject.delete()

removeAttributes

public void removeAttributes(Set attributes)
                      throws AMException,
                             SSOException

Description copied from interface: AMObject

Removes attributes in this AMObject. The attributes are removed from the LDAP data store

Specified by:

removeAttributes in interface AMEntity

Specified by:

removeAttributes in interface AMObject

Parameters:

attributes - The Set of attribute names

Throws:

AMException - if an error is encountered when trying to access/retrieve data from the data store

SSOException - if the single sign on token is no longer valid.

setAttributes

public void setAttributes(Map attributes)
                   throws AMException,
                          SSOException

Description copied from interface: AMObject

Sets attribute values in this 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.

Specified by:

setAttributes in interface AMEntity

Specified by:

setAttributes in interface AMObject

Parameters:

attributes - Map where key is the attribute name and value is a Set of attribute values. Each of the attribute value must be a string value.

Throws:

AMException - if an error is encountered when trying to access/retrieve data from the data store

SSOException - if the single sign on token is no longer valid.

delete

public void delete()
            throws AMException,
                   SSOException

Removes and destroys the object.

Specified by:

delete in interface AMEntity

Specified by:

delete in interface AMObject

Throws:

AMException - if there is an internal problem with AM Store.

SSOException - if the sign-on is no longer valid.

See Also:

AMObject.delete(boolean), AMObject.purge(boolean, int)

store

public void store()
           throws AMException,
                  SSOException

Description copied from interface: AMObject

Stores the change to directory server. This method should be called after doing setAttributes so that the changes that are made can be permanently committed to the LDAP data store.

Specified by:

store in interface AMEntity

Specified by:

store in interface AMObject

Throws:

AMException - if an error is encountered when trying to access/retrieve data from the data store.

SSOException - if the single sign on token is no longer valid.

create

public void create(String stype)
            throws AMException,
                   SSOException

Throws:

AMException

SSOException

activate

public void activate()
              throws AMException,
                     SSOException

Description copied from interface: AMEntity

Activates the entity (if a status attribute is defined for this entity). If a status attribute is not defined then this method returns without doing anything.

Specified by:

activate in interface AMEntity

Throws:

AMException - if an error is encountered when trying to activate the managed object.

SSOException - if the single sign on token is no longer valid.

deactivate

public void deactivate()
                throws AMException,
                       SSOException

Description copied from interface: AMEntity

Deactivates the entity (if a status attribute is defined for this entity). If a status attribute is not defined then this method returns without doing anything.

Specified by:

deactivate in interface AMEntity

Throws:

AMException - if an error is encountered when trying to deactivate the managed object.

SSOException - if the single sign on token is no longer valid.

isActivated

public boolean isActivated()
                    throws AMException,
                           SSOException

Description copied from interface: AMEntity

Returns true if the entity is activated. If the entity does not have a status attribute, then this method returns true, rather that throw an exception.

Specified by:

isActivated in interface AMEntity

Returns:

true if the entity is activated.

Throws:

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.

getAttributes

public Map getAttributes(Set attributeNames)
                  throws AMException,
                         SSOException

Description copied from interface: AMObject

Returns Map of specified attributes. Map key is the attribute name and value is the attribute value.

Specified by:

getAttributes in interface AMEntity

Specified by:

getAttributes in interface AMObject

Parameters:

attributeNames - The Set of attribute names.

Returns:

Map of specified attributes.

Throws:

AMException - if an error is encountered when trying to access/retrieve data from the data store

SSOException - if the single sign on token is no longer valid.

getRoleDNs

protected Set getRoleDNs()
                  throws AMException,
                         SSOException

Throws:

AMException

SSOException

getAssignedServices

public Set getAssignedServices()
                        throws AMException,
                               SSOException

Deprecated.

Gets all service names that are assigned to the user/group/org.

Specified by:

getAssignedServices in interface AMObject

Returns:

The Set of service names that are assigned to the user.

Throws:

AMException - if there is an internal error in the AM Store

SSOException - if the sign on is no longer valid

setAttribute

public void setAttribute(String attributeName,
                         Set attributeValue)
                  throws AMException,
                         SSOException

Deprecated.

Throws:

AMException

SSOException

getAttribute

public Set getAttribute(String attributeName)
                 throws AMException,
                        SSOException

Deprecated.

Description copied from interface: AMObject

Returns attribute value.

Specified by:

getAttribute in interface AMObject

Parameters:

attributeName - Attribute name

Returns:

Set of attribute values.

Throws:

AMException - if an error is encountered when trying to access/retrieve data from the data store

SSOException - if the single sign on token is no longer valid.

setAttributeByteArray

public void setAttributeByteArray(String attrName,
                                  byte[][] byteValues)
                           throws AMException,
                                  SSOException

Deprecated.

Description copied from interface: AMObject

Sets byte attribute values in this 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.

Specified by:

setAttributeByteArray in interface AMObject

Parameters:

attrName - the attribute name

byteValues - attribute values in byte[][] format

Throws:

AMException - if an error is encountered when trying to access/retrieve data from the data store

SSOException - if the single sign on token is no longer valid.

getAttributeByteArray

public byte[][] getAttributeByteArray(String attributeName)
                               throws AMException,
                                      SSOException

Deprecated.

Description copied from interface: AMObject

Returns attribute value.

Specified by:

getAttributeByteArray in interface AMObject

Parameters:

attributeName - Attribute name

Returns:

attribute values in byte[][] format or null if the attribute does not exist.

Throws:

AMException - if an error is encountered when trying to access/retrieve data from the data store

SSOException - if the single sign on token is no longer valid.

getAttributesFromDataStore

public Map getAttributesFromDataStore()
                               throws AMException,
                                      SSOException

Deprecated.

Description copied from interface: AMObject

Returns Map of all attributes directly from data store. Map key is the attribute name and value is the attribute value.

Specified by:

getAttributesFromDataStore in interface AMObject

Returns:

Map of all attributes.

Throws:

AMException - if an error is encountered when trying to access/retrieve data from the data store

SSOException - if the single sign on token is no longer valid.

getAttributesFromDataStore

public Map getAttributesFromDataStore(Set attributeNames)
                               throws AMException,
                                      SSOException

Deprecated.

Description copied from interface: AMObject

Returns Map of specified attributes directly from data store. Map key is the attribute name and value is the attribute value.

Specified by:

getAttributesFromDataStore in interface AMObject

Parameters:

attributeNames - The Set of attribute names.

Returns:

Map of specified attributes.

Throws:

AMException - if an error is encountered when trying to access/retrieve data from the data store

SSOException - if the single sign on token is no longer valid.

setAttributesByteArray

public void setAttributesByteArray(Map attributes)
                            throws SSOException,
                                   AMException

Deprecated.

Description copied from interface: AMObject

Sets byte attribute values in this 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.

Specified by:

setAttributesByteArray in interface AMObject

Parameters:

attributes - Map where key is the attribute name and values are in byte[][] format.

Throws:

SSOException - if the single sign on token is no longer valid.

AMException - if an error is encountered when trying to access/retrieve data from the data store

getAttributesByteArray

public Map getAttributesByteArray()
                           throws AMException,
                                  SSOException

Deprecated.

Description copied from interface: AMObject

Returns Map of all attributes. Map key is the attribute name and value is the attribute value in byte[][] format.

Specified by:

getAttributesByteArray in interface AMObject

Returns:

Map of all attributes.

Throws:

AMException - if an error is encountered when trying to access/retrieve data from the data store

SSOException - if the single sign on token is no longer valid.

getAttributesByteArray

public Map getAttributesByteArray(Set attributeNames)
                           throws AMException,
                                  SSOException

Deprecated.

Description copied from interface: AMObject

Returns Map of specified attributes. Map key is the attribute name and value is the attribute value in byte[][] format.

Specified by:

getAttributesByteArray in interface AMObject

Parameters:

attributeNames - The Set of attribute names.

Returns:

Map of specified attributes. The key of the map is the attribute name and the values in byte[][] format.

Throws:

AMException - if an error is encountered when trying to access/retrieve data from the data store

SSOException - if the single sign on token is no longer valid.

setBooleanAttribute

public void setBooleanAttribute(String attributeName,
                                boolean value)
                         throws AMException,
                                SSOException

Deprecated.

Throws:

AMException

SSOException

getBooleanAttribute

public boolean getBooleanAttribute(String attributeName)
                            throws AMException,
                                   SSOException

Deprecated.

Throws:

AMException

SSOException

setIntegerAttribute

public void setIntegerAttribute(String attributeName,
                                int value)
                         throws AMException,
                                SSOException

Deprecated.

Throws:

AMException

SSOException

getIntegerAttribute

public int getIntegerAttribute(String attributeName)
                        throws AMException,
                               SSOException

Deprecated.

Throws:

AMException

SSOException

getPolicy

public Map getPolicy(String serviceName)
              throws UnsupportedOperationException,
                     AMException,
                     SSOException

Deprecated.

Description copied from interface: AMObject

Returns the effective service policy defined at this object after considering any inheritance from any policy templates.

Specified by:

getPolicy in interface AMObject

Parameters:

serviceName - service name.

Returns:

Map the effective service policy for the object after inheritance; key is the attribute name and value is attribute value. An empty Map will be returned if no policy attribute is defined in the specified service.

Throws:

UnsupportedOperationException - if the class implementing this interface does not support this method

AMException - if an error is encountered when trying to access/retrieve data from the data store

SSOException - if the single sign on token is no longer valid

getPolicyTemplate

public AMTemplate getPolicyTemplate(String serviceName)
                             throws UnsupportedOperationException,
                                    AMException,
                                    SSOException

Deprecated.

Description copied from interface: AMObject

Returns the policy template for a service defined for this object ignoring any inheritance. This is a convenience method and is equivalent to getTemplate(serviceName, AMTemplate.POLICY_TEMPLATE). AMUser object will throw UnsupportedOperationException because this method is not relevant for AMUser.

Specified by:

getPolicyTemplate in interface AMObject

Parameters:

serviceName - service name.

Returns:

AMTemplate the policy template of the service for this object.

Throws:

UnsupportedOperationException - if the class implementing this interface does not support this method.

AMException - if an error is encountered when trying to access/retrieve data from the data store.

SSOException - if the single sign on token is no longer valid

getServiceAttributes

public Map getServiceAttributes(String serviceName)
                         throws AMException,
                                SSOException

Deprecated.

Description copied from interface: AMObject

Returns Map of all attributes of specified service. Map key is the attribute name and value is the attribute value.

Specified by:

getServiceAttributes in interface AMObject

Parameters:

serviceName - Service name

Returns:

Map of all attributes of specified service, an empty Map will be returned if no service attribute is defined in the specified service.

Throws:

AMException - if an error is encountered when trying to access/retrieve data from the data store

SSOException - if the single sign on token is no longer valid.

See Also:

AMObject.getTemplate(java.lang.String, int)

setServiceStatus

public void setServiceStatus(String sname,
                             String status)
                      throws AMException,
                             SSOException

Deprecated.

Description copied from interface: AMObject

Set the status of the service for this entity (User/Organization /Group/Organizational Unit). The valid values for the status attribute are defined in the SMS DTD. Before the status attribute is set, it is verified to see if the service is first assigned to the user or not, and that the value for the status is valid per the DTD.

Specified by:

setServiceStatus in interface AMObject

Parameters:

sname - Name of service whose status attribute has to be changed

status - One of the status values as defined in the service schema

Throws:

AMException - if a data store exception is encountered.

SSOException - if the single sign on token is no longer valid.

getServiceStatus

public String getServiceStatus(String serviceName)
                        throws AMException,
                               SSOException

Deprecated.

Description copied from interface: AMObject

Get the status of the service for this entity (user/group/organization/ organizational unit). Returns null, if service is not assigned to the entity.

Specified by:

getServiceStatus in interface AMObject

Parameters:

serviceName - Name of service

Returns:

status Value of the status attribute

Throws:

AMException - if a data store exception is encountered

SSOException - if single sign on token is no longer valid.

setStringAttribute

public void setStringAttribute(String attributeName,
                               String value)
                        throws AMException,
                               SSOException

Deprecated.

Sets string type attribute value.

Specified by:

setStringAttribute in interface AMObject

Parameters:

attributeName - Attribute name

value - value to be set for the attributeName

Throws:

AMException - if there is an internal problem with AM Store.

SSOException - if the sign-on is no longer valid.

getStringAttribute

public String getStringAttribute(String attributeName)
                          throws AMException,
                                 SSOException

Deprecated.

Description copied from interface: AMObject

Returns string type attribute value.

Specified by:

getStringAttribute in interface AMObject

Parameters:

attributeName - Attribute name

Returns:

String value of attribute

Throws:

AMException - if an error is encountered when trying to access/retrieve data from the data store

SSOException - if the single sign on token is no longer valid.

getTemplate

public AMTemplate getTemplate(String serviceName,
                              int templateType)
                       throws UnsupportedOperationException,
                              AMException,
                              SSOException

Deprecated.

Description copied from interface: AMObject

Returns the Template for the given service associated with this AMObject.

Specified by:

getTemplate in interface AMObject

Parameters:

serviceName - service name.

templateType - the template type. Can be one of the following:

• AMTemplate.DYNAMIC_TEMPLATE
• AMTemplate.ORGANIZATION_TEMPLATE

Returns:

AMTemplate the service template for this AMObject.

Throws:

UnsupportedOperationException - if the class implementing this interface does not support this method

AMException - if an error is encountered when trying to access/retrieve data from the data store

SSOException - if the single sign on token is no longer valid.

addEventListener

public void addEventListener(AMEventListener listener)
                      throws SSOException

Deprecated.

Register a AMEventListener that needs to be invoked when a relevant event occurs. If the listener was already registered, then it is registered only once; no duplicate registration is allowed.

Object.equals() method on the listener object is used to determine duplicates.
NOTE: This method does not check if the listener implementation object exists in the directory, since it is brought from directory itself.

Specified by:

addEventListener in interface AMObject

Parameters:

listener - listener object that will be called upon when an event occurs.

Throws:

SSOException - if errors were encountered in adding a new SSOTokenListener instance

assignPolicies

public void assignPolicies(String serviceName,
                           Set policyDNs)
                    throws AMException,
                           SSOException

Deprecated.

Assigns the given policies to this object.

Specified by:

assignPolicies in interface AMObject

Parameters:

serviceName - serviceName

policyDNs - Set of policy DN string

Throws:

AMException - if there is an internal problem with AM Store.

SSOException - if the sign-on is no longer valid.

assignServices

public void assignServices(Map serviceNamesAndAttr)
                    throws AMException,
                           SSOException

Deprecated.

Assigns a set of services and the attributes for a service to the user.

Specified by:

assignServices in interface AMObject

Parameters:

serviceNamesAndAttr - Set of service names and the attributes for a service.

Throws:

AMException - if there is an internal error in the AM Store

SSOException - if the sign on is no longer valid

See Also:

AMUserImpl.assignServices(java.util.Set)

assignServices

public void assignServices(Map serviceNamesAndAttr,
                           boolean store)
                    throws AMException,
                           SSOException

Deprecated.

Assigns a set of services and the attributes for a service to the user.

Parameters:

serviceNamesAndAttr - Set of service names and the attributes for a service.

store - A boolean value. If the boolean value is 'true', 1) Checks if there is already an assigned service. 2) Checks if any of the assigned services are registered with the parent organization. 3) Combines the old Object Classes and the new Object classes and assigns them for a service. If the boolean value is 'false', 1) Assigns services without any check for existence of already assigned service. 2) Assigns only the new object classes.

Throws:

AMException - if there is an internal error in the AM Store

SSOException - if the sign on is no longer valid

See Also:

AMUserImpl.assignServices( java.util.Set serviceNames)

create

public void create()
            throws AMException,
                   SSOException

Deprecated.

Throws:

AMException

SSOException

createPolicyTemplate

public AMTemplate createPolicyTemplate(String serviceName,
                                       Map attributes)
                                throws UnsupportedOperationException,
                                       AMException,
                                       SSOException

Deprecated.

Description copied from interface: AMObject

Creates a Policy Template with no priority for the given service associated with this AMObject. This is a convenience method and is equivalent to createTemplate( AMTemplate.POLICY_TEMPLATE, serviceName, attributes).

Specified by:

createPolicyTemplate in interface AMObject

Parameters:

serviceName - service name.

attributes - Map of attributes name-value pairs.

Returns:

AMTemplate the service template for this AMObject.

Throws:

UnsupportedOperationException - if the class implementing this interface does not support this method.

AMException - if an error is encountered when trying to access/retrieve data from the data store.

SSOException - if the single sign on token is no longer valid.

createPolicyTemplate

public AMTemplate createPolicyTemplate(String serviceName,
                                       Map attributes,
                                       int priority)
                                throws UnsupportedOperationException,
                                       AMException,
                                       SSOException

Deprecated.

Description copied from interface: AMObject

Creates a Policy Template with a priority for the given service associated with this AMObject. This is a convenience method and is equivalent to createTemplate(AMTemplate.POLICY_TEMPLATE, serviceName, attributes, priority).

Specified by:

createPolicyTemplate in interface AMObject

Parameters:

serviceName - service name.

attributes - Map of attributes name-value pairs.

priority - template priority (0 is the highest priority).

Returns:

AMTemplate the service template for this AMObject.

Throws:

UnsupportedOperationException - if the class implementing this interface does not support this method.

AMException - if an error is encountered when trying to access/retrieve data from the data store

SSOException - if the single sign on token is no longer valid.

createTemplate

public AMTemplate createTemplate(int templateType,
                                 String serviceName,
                                 Map attributes)
                          throws UnsupportedOperationException,
                                 AMException,
                                 SSOException

Deprecated.

Description copied from interface: AMObject

Creates a Template with no priority for the given service associated with this AMObject.

Specified by:

createTemplate in interface AMObject

Parameters:

templateType - the template type. Can be one of the following:

• AMTemplate.DYNAMIC_TEMPLATE
• AMTemplate.ORGANIZATION_TEMPLATE

serviceName - service name

attributes - Map of attributes name-value pairs. if it is null default values will be used.

Returns:

AMTemplate the service template for this AMObject.

Throws:

UnsupportedOperationException - if the class implementing this interface does not support this method.

AMException - if an error is encountered when trying to access/retrieve data from the data store.

SSOException - if the single sign on token is no longer valid.

createTemplate

public AMTemplate createTemplate(int templateType,
                                 String serviceName,
                                 Map attributes,
                                 int priority)
                          throws UnsupportedOperationException,
                                 AMException,
                                 SSOException

Deprecated.

Description copied from interface: AMObject

Creates a Template with a priority for the given service associated with this AMObject.

Specified by:

createTemplate in interface AMObject

Parameters:

templateType - the template type. Can be one of the following:

• AMTemplate.DYNAMIC_TEMPLATE
• AMTemplate.ORGANIZATION_TEMPLATE

serviceName - service name.

attributes - Map of attributes name-value pairs

priority - template priority (0 is the highest priority)

Returns:

AMTemplate the service template for this AMObject.

Throws:

UnsupportedOperationException - if the class implementing this interface does not support this method

AMException - if an error is encountered when trying to access/retrieve data from the data store

SSOException - if the single sign on token is no longer valid.

createTemplate

public AMTemplate createTemplate(int templateType,
                                 String serviceName,
                                 Map attributes,
                                 int priority,
                                 Set policyDNs)
                          throws UnsupportedOperationException,
                                 AMException,
                                 SSOException

Deprecated.

Throws:

UnsupportedOperationException

AMException

SSOException

modifyService

public void modifyService(String sname,
                          Map attrMap)
                   throws AMException,
                          SSOException

Deprecated.

Description copied from interface: AMObject

Modify the service attributes of a service assigned to a entity (user/group/organization/organizational unit). It replaces existing service attribute values with the ones provided. If new attribute values are provided, those are set too. Values of the attribute are validated against the service schema. Before the values are replaced in the entry, the ServiceCallback classes, if any, are instantiated and the validateAttribute() method is called.

Specified by:

modifyService in interface AMObject

Parameters:

sname - Name of the service which has to be modified

attrMap - Map of attribute names and set of attribute values.

Throws:

AMException - if an error occurs during validation or storing

SSOException - if the single sign on token is no longer valid.

removeEventListener

public void removeEventListener(AMEventListener listener)

Deprecated.

UnRegister a previously registered event listener. If the listener was not registered, the method simply returns without doing anything.

Specified by:

removeEventListener in interface AMObject

Parameters:

listener - listener object that will be removed or unregistered.

search

public Set search(int level,
                  String filter)
           throws AMException,
                  SSOException

Deprecated.

Description copied from interface: AMObject

Search objects based on specified level and filter.

Specified by:

search in interface AMObject

Parameters:

level - The search level starting from the object

filter - The search filter

Returns:

Set of object DN's matching the search

Throws:

AMException - if an error is encountered when trying to access/retrieve data from the data store

SSOException - if the single sign on token is no longer valid.

searchObjects

public Set searchObjects(String namingAttr,
                         String objectClassFilter,
                         String wildcard,
                         Map avPairs,
                         int level)
                  throws AMException,
                         SSOException

Deprecated.

Throws:

AMException

SSOException

store

public void store(boolean isAdd)
           throws AMException,
                  SSOException

Deprecated.

Description copied from interface: AMObject

Stores the change to directory server. This method should be called after doing setAttributes or any other set methods provided. so that the changes that are made can be permanently committed to the LDAP data store.

Specified by:

store in interface AMObject

Parameters:

isAdd - If addValues is true, then the attribute values as set in the setAttributes method are added to any existing values for the same attribute in the directory. Otherwise, the attribute values replace existing values in the data store.

Throws:

AMException - if an error is encountered when trying to access/retrieve data from the data store.

SSOException - if the single sign on token is no longer valid.

unassignPolicies

public void unassignPolicies(String serviceName,
                             Set policyDNs)
                      throws AMException,
                             SSOException

Deprecated.

Unassigns the given policies from this object.

Specified by:

unassignPolicies in interface AMObject

Parameters:

serviceName - serviceName

policyDNs - Set of policy DN string

Throws:

AMException - if there is an internal problem with AM Store.

SSOException - if the sign-on is no longer valid.

unassignServices

public void unassignServices(Set serviceNames)
                      throws AMException,
                             SSOException

Deprecated.

Unassigns services from the user.

Specified by:

unassignServices in interface AMObject

Parameters:

serviceNames - Set of service names

Throws:

AMException - if there is an internal error in the AM Store

SSOException - if the sign on is no longer valid

constructFilter

protected static String constructFilter(String objectClassFilter)

Deprecated.

constructFilter

protected static String constructFilter(String namingAttr,
                                        String objectClassFilter,
                                        String wildcard)

Deprecated.

constructFilter

protected static String constructFilter(Map avPairs)

Deprecated.

getSearchFilter

protected String getSearchFilter(int objectType)

Deprecated.

getSearchFilter

protected String getSearchFilter(int objectType,
                                 String searchTempName)

Deprecated.

notifyACIChangeEvent

protected static void notifyACIChangeEvent(String dn,
                                           int eventType)

Deprecated.

Notifies ACI Change. This method will be called by the AMIdRepoListener to send notifications to all interested AMObjectImp's whenever an ACI change occurs.

Parameters:

dn - name of the object changed

eventType - type of modification

notifyEntryEvent

protected static void notifyEntryEvent(String dn,
                                       int eventType,
                                       boolean cosType)

Deprecated.

This method will be called EntryEventListener to send notifications to all interested AMObjectImp's whenever an Entry Event occurs.

Parameters:

dn - the object that is modified

eventType - type of modification

cosType - - true if it is a cosrelated event; false otherwise

sendExpiryEvent

protected static void sendExpiryEvent(String sourceDN,
                                      int sourceType)

Deprecated.

removeFromProfileNameTable

protected static Set removeFromProfileNameTable(SSOToken ssoToken)

Deprecated.

This method removes the entry corresponding to SSOTokenID supplied.

Parameters:

ssoToken - - a SSOToken

Returns:

Set of DN's for the given SSOTokenID or null if not present

removeObjImplListeners

protected static void removeObjImplListeners(Set dnSet,
                                             SSOTokenID ssoTokenId)

Deprecated.

Method that removes all the entries that correspond ("dn",ssoTokenId) supplied. This is done for all the DN's in the set of DN's supplied.

Parameters:

dnSet - - a set of DNs

ssoTokenId - - the SSO token Id

replaceAciListMacros

protected Set replaceAciListMacros(Set aciSet,
                                   String roleDN,
                                   String orgDN,
                                   String groupDN,
                                   String pcDN)

Deprecated.

Substitutes the macros in the set of DN:ACI.

Parameters:

aciSet - Set of DN:ACI

roleDN - Role DN to replace macro ROLENAME

orgDN - Organization DN to replace macro ORGANIZATION

groupDN - Group DN to replace macro GROUPNAME

pcDN - People container DN to replace PCNAME

replaceAciMacro

protected String replaceAciMacro(String aci,
                                 String macro,
                                 String str)

Deprecated.

replaceAciMacros

protected String replaceAciMacros(String aci,
                                  String roleDN,
                                  String orgDN,
                                  String groupDN,
                                  String pcDN)

Deprecated.

searchObjects

protected AMSearchResults searchObjects(String namingAttr,
                                        String objectClassFilter,
                                        String wildcard,
                                        Map avPairs,
                                        AMSearchControl searchControl)
                                 throws AMException,
                                        SSOException

Deprecated.

Throws:

AMException

SSOException

searchObjects

protected AMSearchResults searchObjects(String namingAttr,
                                        String objectClassFilter,
                                        String wildcard,
                                        AMSearchControl searchControl,
                                        String avfilter)
                                 throws AMException,
                                        SSOException

Deprecated.

Throws:

AMException

SSOException

searchObjects

protected AMSearchResults searchObjects(String objectClassFilter,
                                        AMSearchControl searchControl,
                                        String avfilter)
                                 throws AMException,
                                        SSOException

Deprecated.

Throws:

AMException

SSOException

searchObjects

protected Set searchObjects(int[] objectTypes,
                            String wildcard,
                            Map avPairs,
                            int level)
                     throws AMException,
                            SSOException

Deprecated.

Throws:

AMException

SSOException

searchObjects

protected AMSearchResults searchObjects(int[] objectTypes,
                                        String wildcard,
                                        Map avPairs,
                                        AMSearchControl searchControl)
                                 throws AMException,
                                        SSOException

Deprecated.

Throws:

AMException

SSOException

notifyAffectedDNs

protected static void notifyAffectedDNs(String affectedDN,
                                        AMEvent dpEvent)

Deprecated.

Sends event notifications to all the listeners that correspond to a DN whose suffix which ends with affectedDN in the objImpListeners.

Parameters:

affectedDN - - String which has been stripped to reflect the subtree of DN's that will be affected in case of cos related changes

dpEvent - - a AMEvent