|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.sun.identity.um.Common | +--com.sun.identity.um.Organization
The AMOrganization
interface provides methods to manage
organization
Method Summary | |
java.lang.String |
createAssignableDynamicGroup(java.lang.String name,
java.util.Map attributes,
java.util.Map serviceNameAndAttrs)
Creates assignable dynamic group. |
java.lang.String |
createDynamicGroup(java.lang.String name,
java.util.Map attributes,
java.util.Map serviceNameAndAttrs)
Creates dynamic group. |
java.util.Set |
createRoles(java.util.Map roles)
Creates roles. |
java.util.Set |
createRoles(java.util.Set roleNames)
Creates roles. |
java.lang.String |
createStaticGroup(java.lang.String name,
java.util.Map attributes,
java.util.Map serviceNameAndAttrs)
Creates static group. |
java.lang.String |
createUser(java.lang.String uid,
java.util.Map attrMap,
java.util.Map serviceNameAndAttrs)
Create user and initializes the attributes. |
void |
deleteAssignableDynamicGroups(java.util.Set assignableDynamicGroupDNs)
Deletes assignable dynamic groups. |
void |
deleteDynamicGroups(java.util.Set dynamicGroupDNs)
Deletes dynamic groups. |
void |
deleteRoles(java.util.Set roleDNs)
Deletes roles. |
void |
deleteStaticGroups(java.util.Set groupDNs)
Deletes static groups. |
void |
deleteUsers(java.util.Set users)
Removes users from the organization. |
long |
getNumberOfRoles(int level)
Gets number of roles within the specified level. |
java.util.Set |
getRoles(int level)
Gets the roles within the specified level. |
java.lang.String |
getUser(java.lang.String uid,
java.lang.String userSearchTemplate)
Returns DN of user in this organization (or in subrogs), whose naming attribute exactly matches with uid. |
java.util.Set |
searchAssignableDynamicGroups(java.lang.String wildcard,
int level,
java.lang.String groupSearchTemplate,
java.util.Map avPairs)
Searches for assignable dynamic groups in this organization using wildcards. |
java.util.Set |
searchDynamicGroups(java.lang.String wildcard,
int level,
java.lang.String groupSearchTemplate,
java.util.Map avPairs)
Searches for dynamic groups in this organization using wildcards. |
java.util.Set |
searchRoles(java.lang.String wildcard,
int level)
Searches for roles in this organization using wildcards. |
java.util.Set |
searchRoles(java.lang.String wildcard,
java.util.Map avPairs,
int level)
Searches for roles in this organization using wildcards and attribute values. |
java.util.Set |
searchStaticGroups(java.lang.String wildcard,
int level,
java.lang.String groupSearchTemplate,
java.util.Map avPairs)
Searches for static groups in this organization using wildcards. |
java.util.Set |
searchUsers(java.lang.String wildcard,
int level,
java.lang.String userSearchTemplate,
java.util.Map avPairs)
Searches for users in this organization using wildcards and attribute values. |
Methods inherited from class com.sun.identity.um.Common |
assignServices, delete, delete, getAssignedServices, getAttributes, getAttributes, getDN, getOrganizationDN, getParentDN, getServiceAttributes, getServiceStatus, isExists, modifyService, removeAttributes, setAttributes, setServiceStatus, store, unassignServices |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
public java.util.Set createRoles(java.util.Set roleNames) throws UMException, SSOException
roles
- The set of Roles' names to be created.UMException
- if there is an internal error in the AM StoreSSOException
- if the sign on is no longer validpublic java.util.Set createRoles(java.util.Map roles) throws UMException, SSOException
roles
- Map where the key is the name of the role, and the value
is a Map to represent Attribute-Value PairsUMException
- if there is an internal error in the AM StoreSSOException
- if the sign on is no longer validpublic void deleteRoles(java.util.Set roleDNs) throws UMException, SSOException
roles
- The set of roles' DNs to be deleted.UMException
- if there is an internal error in the AM StoreSSOException
- if the sign on is no longer validpublic java.util.Set getRoles(int level) throws UMException, SSOException
level
- The search level starting from the organization.public long getNumberOfRoles(int level) throws UMException, SSOException
level
- The search level starting from the organization.public java.util.Set searchRoles(java.lang.String wildcard, int level) throws UMException, SSOException
wildcard
- wildcard pattern to be used in the searchlevel
- the search level that needs to be used
(AMConstants.SCOPE_ONE or AMConstansts.SCOPE_SUB)UMException
- if there is an internal error in the AM StoreSSOException
- if the sign on is no longer validpublic java.util.Set searchRoles(java.lang.String wildcard, java.util.Map avPairs, int level) throws UMException, SSOException
wildcard
- wildcard pattern to be used in the searchavPairs
- attribute-value pairs to match when searching userslevel
- the search level that needs to be used
(AMConstants.SCOPE_ONE or AMConstansts.SCOPE_SUB)UMException
- if there is an internal error in the AM StoreSSOException
- if the sign on is no longer validpublic java.lang.String createAssignableDynamicGroup(java.lang.String name, java.util.Map attributes, java.util.Map serviceNameAndAttrs) throws UMException, SSOException
Name
- of group to be createdServiceName
- and attrsMap where the map is like this:
UMException
- SSOException
- if the SSOtoken is no longer validpublic void deleteAssignableDynamicGroups(java.util.Set assignableDynamicGroupDNs) throws UMException, SSOException
assignableDynamicGroupDNs
- The set of assignable dynamic groups's
DNs to be deleted.UMException
- if there is an internal error in the AM StoreSSOException
- if the sign on is no longer validpublic java.util.Set searchAssignableDynamicGroups(java.lang.String wildcard, int level, java.lang.String groupSearchTemplate, java.util.Map avPairs) throws UMException, SSOException
wildcard
- wildcard pattern to be used in the searchlevel
- the search level that needs to be used
(AMConstants.SCOPE_ONE or AMConstants.SCOPE_SUB)groupSearchTemplate
- template to be used to search for groups.avPairs
- This option can be used to further qualify the search
filter. The attribute-value pairs provided by this map are appended
to the search filter.UMException
- if an error is encountered when trying to
access/retrieve data from the data storeSSOException
- if the sign on is no longer validpublic java.lang.String createDynamicGroup(java.lang.String name, java.util.Map attributes, java.util.Map serviceNameAndAttrs) throws UMException, SSOException
Name
- of group to be createdServiceName
- and attrsMap where the map is like this:
UMException
- SSOException
- if the SSOtoken is no longer validpublic void deleteDynamicGroups(java.util.Set dynamicGroupDNs) throws UMException, SSOException
dynamicGroupDNs
- The set of dynamic groups's DNs to be deleted.UMException
- if there is an internal error in the AM StoreSSOException
- if the sign on is no longer validpublic java.util.Set searchDynamicGroups(java.lang.String wildcard, int level, java.lang.String groupSearchTemplate, java.util.Map avPairs) throws UMException, SSOException
wildcard
- wildcard pattern to be used in the searchlevel
- the search level that needs to be used
(AMConstants.SCOPE_ONE or AMConstants.SCOPE_SUB)groupSearchTemplate
- template to be used to search for groups.avPairs
- This option can be used to further qualify the search
filter. The attribute-value pairs provided by this map are appended
to the search filter.UMException
- if an error is encountered when trying to
access/retrieve data from the data storeSSOException
- if the sign on is no longer validpublic java.lang.String createStaticGroup(java.lang.String name, java.util.Map attributes, java.util.Map serviceNameAndAttrs) throws UMException, SSOException
Name
- of group to be createdServiceName
- and attrsMap where the map is like this:
UMException
- SSOException
- if the SSOtoken is no longer validpublic void deleteStaticGroups(java.util.Set groupDNs) throws UMException, SSOException
groups
- The set of static groups to be deleted.public java.util.Set searchStaticGroups(java.lang.String wildcard, int level, java.lang.String groupSearchTemplate, java.util.Map avPairs) throws UMException, SSOException
wildcard
- wildcard pattern to be used in the searchlevel
- the search level that needs to be used
(AMConstants.SCOPE_ONE or AMConstants.SCOPE_SUB)groupSearchTemplate
- template to be used to search for groups.avPairs
- This option can be used to further qualify the search
filter. The attribute-value pairs provided by this map are appended
to the search filter.UMException
- if an error is encountered when trying to
access/retrieve data from the data storeSSOException
- if the sign on is no longer validpublic java.lang.String createUser(java.lang.String uid, java.util.Map attrMap, java.util.Map serviceNameAndAttrs) throws UMException, SSOException
iplanet-am-required-services
of the service
iPlanetAMAdminConsoleService
template are added. If a
corresponding template does not exist, the default values are picked up
from schema. Also services as defined in the arguments, are assigned
to the user, with default values being picked up from the service schema
if none are provided for required attributes of the service.String
- uid, value of naming attribute for user.Map
- attrMap attribute-values to be set in the user entry.Map
- serviceNameAndAttr service names and attributes to be
assigned to the user.UMException
- if an error is encountered when trying to
access/retrieve data from the data storeSSOException
- if the sign on is no longer validpublic void deleteUsers(java.util.Set users) throws UMException, SSOException
users
- The set of user DN's to be removed from the organization.public java.lang.String getUser(java.lang.String uid, java.lang.String userSearchTemplate) throws UMException, SSOException
String
- uid - namingAttribute value for userString
- userSearchTemplateUMException
- SSOException
- public java.util.Set searchUsers(java.lang.String wildcard, int level, java.lang.String userSearchTemplate, java.util.Map avPairs) throws UMException, SSOException
wildcard
- wildcard pattern to be used in the searchlevel
- the search level that needs to be used
(AMConstants.SCOPE_ONE or AMConstants.SCOPE_SUB)userSearchTemplate
- template to be used to search for users.avPairs
- This option can be used to further qualify the search
filter. The attribute-value pairs provided by this map are appended
to the search filter.UMException
- if an error is encountered when trying to
access/retrieve data from 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 |