|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface OrganizationManager
Manager for organizations, organization hierarchies, access control groups, roles, users and companies.
Field Summary | |
---|---|
static java.lang.String |
copyright
|
Method Summary | |
---|---|
AccessControlGroup |
createAccessControlGroup(java.lang.String acgName,
java.lang.String description,
Role role,
java.util.EnumSet<Permission> permissions)
Creates an access control group object with the specified acg name and acg description. |
OrganizationHierarchy |
createOrganizationHierarchy(PrimarySpec spec,
java.lang.String name)
Creates a new organization hierarchy object. |
OrganizationHierarchy |
createOrganizationHierarchy(PrimarySpec spec,
java.lang.String name,
AttributeDefinition pathAttribute,
AccessControlGroup accessControlGroup,
AttributeDefinition displayAttribute)
Create a new organization hierarchy object. |
Role |
createRole(java.lang.String roleName,
java.lang.String description)
Creates a role with the specified parameters. |
User |
createUser(java.lang.String userName,
java.lang.String firstName,
java.lang.String lastName,
java.lang.String email,
boolean enabled,
java.lang.String password,
java.util.List<Role> roles,
Organization organization,
boolean encryptPassword)
Creates a user with the specified parameters. |
AccessControlGroup |
getAccessControlGroup(java.lang.String name)
Returns an access control group object for the specified acg name |
java.util.Collection<OrganizationHierarchy> |
getOrganizationHierarchies()
Retrieves all Organization Hierarchies available in the current context As prescribed via Permission.HIERARCHY_LIST |
OrganizationHierarchy |
getOrganizationHierarchy(java.lang.String name)
Retrieves a specific organization hierarchy by name. |
Role |
getRole(java.lang.String name)
Retrieves a role based upon a name |
User |
getUser(java.lang.String name)
Returns a specific User based upon name. |
Methods inherited from interface com.ibm.pim.common.Manager |
---|
getManagerName |
Field Detail |
---|
static final java.lang.String copyright
Method Detail |
---|
AccessControlGroup createAccessControlGroup(java.lang.String acgName, java.lang.String description, Role role, java.util.EnumSet<Permission> permissions)
AccessControlGroup.save()
is
called on it.
acgName
- The name to give the newly created access control group.description
- The description to add to the newly created access control
group.role
- The role object for which the given set of permissions shall
be assigned corresponding to this ACG.permissions
- The permissions to be assigned for the given role.
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the current user does not have the equivalent of
SystemWideAccessPrivilege.SECURITY_MODIFY_ROLES_ACCESS
java.lang.IllegalArgumentException
- If any of the input parameters are null or name is null or
empty.
java.lang.IllegalStateException
- if any API object passed as a parameter that has not yet been
persisted.OrganizationHierarchy createOrganizationHierarchy(PrimarySpec spec, java.lang.String name)
spec
- The primary spec for the organization hierarchy.name
- A name to be given to the organization hierarchy.
PIMInternalException
- if an internal exception occurs
PIMAuthorizationException
- reserved for future use
java.lang.IllegalArgumentException
- if any of the parameters is null or if name is empty
java.lang.IllegalStateException
- if any API object passed as a parameter that has not yet been
persisted.OrganizationHierarchy createOrganizationHierarchy(PrimarySpec spec, java.lang.String name, AttributeDefinition pathAttribute, AccessControlGroup accessControlGroup, AttributeDefinition displayAttribute)
spec
- The primary spec for the organization hierarchy.name
- A name to be given to the organization hierarchy.pathAttribute
- The spec node to be used as the path attribute for the objects
in the organization hierarchy.accessControlGroup
- The Access Control Group for the organization hierarchy.displayAttribute
- The spec node to be used as the display attribute for the
objects in the organization hierarchy.
PIMInternalException
- if an internal exception occurs
PIMAuthorizationException
- reserved for future use
java.lang.IllegalArgumentException
- if any of the parameters is null or if name is empty
java.lang.IllegalStateException
- if any API object passed as a parameter that has not yet been
persisted.Role createRole(java.lang.String roleName, java.lang.String description)
Role.save()
is called on it.
roleName
- The name of the user to createdescription
- A description of this role.
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the current user does not have the equivalent of
SystemWideAccessPrivilege.SECURITY_MODIFY_ROLES_ACCESS
java.lang.IllegalArgumentException
- If the roleName is null or empty or description is null.User createUser(java.lang.String userName, java.lang.String firstName, java.lang.String lastName, java.lang.String email, boolean enabled, java.lang.String password, java.util.List<Role> roles, Organization organization, boolean encryptPassword)
User.save()
is called on it.
userName
- The name of the user to createfirstName
- The first name of the user.lastName
- The family name of the user.email
- The user's email address.enabled
- Indicates if the user is to be created enabled or not.password
- The initial password for the user.roles
- The roles the user is to have associated.organization
- The organization the user is to belong to.encryptPassword
- A boolean value which determines whether the password string
needs to be encrypted. encryptPassword exists for the purpose
of migrating environments so that encrypted passwords exported
from one environment can be loaded into another environment
without encrypting them again and that there is no possibility
of knowing what the password was. The value should always be
set to true except during environment migration.
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the current user does not have the equivalent of
SystemWideAccessPrivilege.SECURITY_MODIFY_USERS
java.lang.IllegalArgumentException
- If any of the input parameters is null or userName,
firstName, lastName, email or password is null or empty.
java.lang.IllegalStateException
- If any of the API objects passed as a parameter has not been
persisted.AccessControlGroup getAccessControlGroup(java.lang.String name)
name
- The access control group name for which an acg object is to be
returned.
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use.
java.lang.IllegalArgumentException
- If name is null or emptyjava.util.Collection<OrganizationHierarchy> getOrganizationHierarchies()
Permission.HIERARCHY_LIST
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- reserved for future useOrganizationHierarchy getOrganizationHierarchy(java.lang.String name)
name
- The name of the Organization hierarchy to be retrieved
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_LIST
java.lang.IllegalArgumentException
- if name is null or emptyRole getRole(java.lang.String name)
name
- The role name
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use.
java.lang.IllegalArgumentException
- If name is null or empty.User getUser(java.lang.String name)
name
- Users name
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use.
java.lang.IllegalArgumentException
- If name is null or empty.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |