|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.sun.identity.um.Common
This is the common set of methods needed by all the objects. This class is extended by all the objects
Constructor Summary | |
Common()
|
Method Summary | |
void |
assignServices(java.util.Map serviceNameAndAttrs)
Assign services to the user. |
void |
delete()
Deletes the object. |
void |
delete(boolean recursive)
Deletes object(s). |
java.util.Set |
getAssignedServices()
Gets the names of the services that are assigned to the user/group/org. |
java.util.Map |
getAttributes()
Gets Map of all attributes. |
java.util.Map |
getAttributes(java.util.Set attributeNames)
Gets Map of specified attributes. |
java.lang.String |
getDN()
Gets the DN of the entry. |
java.lang.String |
getOrganizationDN()
Gets the object's organization. |
java.lang.String |
getParentDN()
Gets the parent DN of the entry. |
java.util.Map |
getServiceAttributes(java.lang.String serviceName)
Gets Map of all attributes of specified service. |
java.lang.String |
getServiceStatus(java.lang.String serviceName)
Get the status of the service for this entity (User/Org/Group/OrgUnit). |
boolean |
isExists()
Checks if the entry exists in the directory or not. |
void |
modifyService(java.lang.String serviceName,
java.util.Map attrMap)
Modify the service attributes of a service assigned to a user. |
void |
removeAttributes(java.util.Set attributes)
Removes attributes in this AMCommon. |
void |
setAttributes(java.util.Map attributes)
Sets attribute values in this AMCommon. |
void |
setServiceStatus(java.lang.String serviceName,
java.lang.String status)
Set the status of the service for this entity (User/Org/Group/OrgUnit). |
void |
store()
Stores the change to directory server. |
void |
unassignServices(java.util.Set serviceNames)
Unassigns services from the user/group/org. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public Common()
Method Detail |
public java.lang.String getDN() throws UMException, SSOException
public java.lang.String getParentDN() throws UMException, SSOException
public void store() throws UMException, SSOException
UMException
- if an error is encountered when trying to
access/retrieve data from the data storeSSOException
- if the sign-on is no longer valid.public boolean isExists() throws UMException, 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 sign-on is no longer valid.public java.util.Map getAttributes() throws UMException, SSOException
UMException
- if an error is encountered when trying to
access/retrieve data from the data storeSSOException
- if the sign-on is no longer valid.public java.util.Map getAttributes(java.util.Set attributeNames) throws UMException, SSOException
attributeNames
- The Set of attribute names.UMException
- if an error is encountered when trying to
access/retrieve data from the data storeSSOException
- if the sign-on is no longer valid.public java.util.Map getServiceAttributes(java.lang.String serviceName) throws UMException, SSOException
serviceName
- Service nameUMException
- if an error is encountered when trying to
access/retrieve data from the data storeSSOException
- if the sign-on is no longer valid.public void setAttributes(java.util.Map attributes) throws UMException, SSOException
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.UMException
- if an error is encountered when trying to
access/retrieve data from the data storeSSOException
- if the sign-on is no longer valid.public void removeAttributes(java.util.Set attributes) throws UMException, SSOException
attributes
- The Set of attribute namesUMException
- if an error is encountered when trying to
access/retrieve data from the data storeSSOException
- if the sign-on is no longer valid.public void delete() throws UMException, SSOException
UMException
- if an error is encountered when trying to
access/retrieve data from the data storeSSOException
- if the sign-on is no longer valid.public void delete(boolean recursive) throws UMException, SSOException
recursive
- if true delete the object and any objects under it,
otherwise, delete the object only.UMException
- if an error is encountered when trying to
access/retrieve data from the data storeSSOException
- if the sign-on is no longer valid.public java.lang.String getOrganizationDN() throws UMException, SSOException
UMException
- if an error is encountered when trying to
access/retrieve data from the data store or the object doesn't
have organzation DN.SSOException
- if the sign on is no longer validpublic void assignServices(java.util.Map serviceNameAndAttrs) throws UMException, SSOException
serviceNameAndAttrs
- Map of Service name with Map of
Attribute-Value pairsUMException
- if an error is encounters when trying to
access/retrieve data
from the datastoreSSOException
- if the token is no longer validpublic void modifyService(java.lang.String serviceName, java.util.Map attrMap) throws UMException, SSOException
serviceName
- attributeMap
- Map of attribute names and set of attribute values.UMException
- when an error occurs during validation or storingSSOException
- if the SSOToken is no longer valid.public void setServiceStatus(java.lang.String serviceName, java.lang.String status) throws UMException, SSOException
serviceName
- status
- UMException
- when an error occurs while validating/storing dataSSOException
- when the SSOToken is no longer validpublic java.lang.String getServiceStatus(java.lang.String serviceName) throws UMException, SSOException
serviceName
- UMException
- when an error occurs while validating/storing dataSSOException
- when SSOToken is no longer validpublic void unassignServices(java.util.Set serviceNames) throws UMException, SSOException
serviceNames
- Set of service namesUMException
- if there is an internal error in the AM StoreSSOException
- if the sign on is no longer validpublic java.util.Set getAssignedServices() throws UMException, SSOException
UMException
- if there is an internal error in the data StoreSSOException
- if the sign on is no longer valid
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |