|
WebLogic Process Integrator Version 2.0 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Provides workflow participants based on security principals defined in an external security realm. The default implementation provides behavior, extended attributes and persistence using a database table.
WLPIPrincipalHome
Method Summary | |
void |
addOrganization(OrganizationInfo orgInfo)
Create a new organization. |
void |
addRole(RoleInfo roleInfo)
Create a new role. |
void |
addUserToOrganization(java.lang.String userID,
java.lang.String orgID)
Add a user to an organization. |
void |
addUserToRole(java.lang.String userID,
java.lang.String orgID,
java.lang.String roleID)
Add a user to a role. |
UserInfo |
createUser(java.lang.String userID,
java.lang.String pswd)
Create a new user in the realm and add it to the wlpiUsers group. |
java.security.Principal |
createWlpiUser(java.lang.String userID,
java.lang.String pswd)
Deprecated. WLPI 1.2.1 release |
void |
deleteOrganization(java.lang.String orgID)
Delete an organization. |
void |
deleteRole(java.lang.String orgID,
java.lang.String roleID)
Delete a role. |
void |
deleteUser(java.lang.String userID)
Deletes a user from the realm. |
java.util.List |
getAllOrganizations(boolean obtainAttributes)
List all defined organizations. |
java.util.List |
getAllUsers(boolean obtainAttributes)
List all defined users. |
java.util.List |
getGroups()
Returns a list of WLS security groups available within the application. |
java.lang.String |
getMappedGroup(java.lang.String roleID,
java.lang.String orgID)
This method returns a single mapping value based on a Role ID and and Organization ID. |
OrganizationInfo |
getOrganizationInfo(java.lang.String orgID)
Get further information about the specified organization. |
java.util.List |
getOrganizationsForUser(java.lang.String userID,
boolean obtainAttributes)
List the organizations to which the specified user belongs. |
RoleInfo |
getRoleInfo(java.lang.String roleID,
java.lang.String orgID)
Get further information about the specified role. |
java.util.Map |
getRoleMappingsInOrg(java.lang.String orgID)
This method returns a Map of all role to WLS security group mapping for a given organization. |
java.util.List |
getRolesForUser(java.lang.String orgID,
java.lang.String userID,
boolean obtainAttributes)
List the roles to which the specified user belongs. |
java.util.List |
getRolesInOrganization(java.lang.String orgID,
boolean obtainAttributes)
List the roles defined for an organization. |
java.lang.String |
getSecurityRealmClassName()
Return the class name of the installed WebLogic security realm. |
UserInfo |
getUserInfo(java.lang.String userID)
Get further information about the specified user. |
java.util.List |
getUsersInOrganization(java.lang.String orgID,
boolean obtainAttributes)
List the users in the specified organization. |
java.util.List |
getUsersInRole(java.lang.String roleID,
java.lang.String orgID,
boolean obtainAttributes)
List the users in the specified role of the specified organization. |
boolean |
isManageableSecurityRealm()
Check whether the realm in question is manageable. |
boolean |
isRoleInOrganization(java.lang.String roleID,
java.lang.String orgID)
Check whether a role is defined within a particular organization. |
boolean |
isUserInOrganization(java.lang.String userID,
java.lang.String orgID)
Check whether a user belongs to particular organization. |
void |
mapRolesToGroups(java.lang.String orgID,
java.util.Map rolesToGroupMap)
This method maps a set of roles to groups. |
void |
mapRoleToGroup(java.lang.String roleID,
java.lang.String orgID,
java.lang.String groupID)
This method maps an individual role to a WLS security group. |
void |
ping()
A "dummy" method for the client to ping. |
void |
removeUserFromOrganization(java.lang.String userID,
java.lang.String orgID)
Remove a user from an organization. |
void |
removeUserFromRole(java.lang.String userID,
java.lang.String orgID,
java.lang.String roleID)
Remove a user from a role. |
void |
setOrganizationInfo(OrganizationInfo orgInfo)
Update the information about an organization. |
void |
setRoleInfo(RoleInfo roleInfo)
Update the information about a role. |
void |
setUserInfo(UserInfo userInfo)
Update the information about a user. |
Methods inherited from interface javax.ejb.EJBObject |
getEJBHome, getHandle, getPrimaryKey, isIdentical, remove |
Method Detail |
public void ping() throws java.rmi.RemoteException
public void addOrganization(OrganizationInfo orgInfo) throws java.rmi.RemoteException, WorkflowException
orgInfo
- Values for the new organization to create.java.rmi.RemoteException
- if a communications error occurred.WorkflowException
- if the security realm is not manageable, or if
any exception occurred.public void addRole(RoleInfo roleInfo) throws java.rmi.RemoteException, WorkflowException
roleInfo
- Values for the new role to create.java.rmi.RemoteException
- if a communications error occurred.WorkflowException
- if the security realm is not manageable, or if
any exception occurred.public void addUserToOrganization(java.lang.String userID, java.lang.String orgID) throws java.rmi.RemoteException, WorkflowException
userID
- The ID of the user to add.orgID
- The ID of the organization.java.rmi.RemoteException
- if a communications error occurred.WorkflowException
- if the security realm is not manageable, or if
any exception occurred.public void addUserToRole(java.lang.String userID, java.lang.String orgID, java.lang.String roleID) throws java.rmi.RemoteException, WorkflowException
userID
- The ID of the user to add.orgID
- The ID of the organization.roleID
- The ID of the role within organization orgID
.java.rmi.RemoteException
- if a communications error occurred.WorkflowException
- if the security realm is not manageable, or if
any exception occurred.public void deleteOrganization(java.lang.String orgID) throws java.rmi.RemoteException, WorkflowException
orgID
- The ID of the organization to delete.java.rmi.RemoteException
- if a communications error occurred.WorkflowException
- if the security realm is not manageable, or if
any exception occurred.public void deleteRole(java.lang.String orgID, java.lang.String roleID) throws java.rmi.RemoteException, WorkflowException
orgID
- The ID of the organization containing the role to delete.roleID
- The ID of the role to delete.java.rmi.RemoteException
- if a communications error occurred.WorkflowException
- if the security realm is not manageable, or if
any exception occurred.public java.util.List getAllOrganizations(boolean obtainAttributes) throws java.rmi.RemoteException, WorkflowException
obtainAttributes
- true
to return all OrganizationInfo
attributes, false
for just the
orgIDs.OrganizationInfo
objects.java.rmi.RemoteException
- if a communications error occurred.WorkflowException
- if the security realm is not listable, or if
any exception occurred.public java.util.List getAllUsers(boolean obtainAttributes) throws java.rmi.RemoteException, WorkflowException
obtainAttributes
- true
to return all UserInfo
attributes, false
for just the
userIDs.UserInfo
objects.java.rmi.RemoteException
- if a communications error occurred.WorkflowException
- if the security realm is not listable, or if
any exception occurred.public OrganizationInfo getOrganizationInfo(java.lang.String orgID) throws java.rmi.RemoteException, WorkflowException
orgID
- The ID of the organization about which further information
is required.java.rmi.RemoteException
- if a communications error occurred.WorkflowException
- if the security realm is not listable, or if
any exception occurred.public RoleInfo getRoleInfo(java.lang.String roleID, java.lang.String orgID) throws java.rmi.RemoteException, WorkflowException
orgID
- The ID of the organization containing the role.roleID
- The ID of the role about which further information is
required.java.rmi.RemoteException
- if a communications error occurred.WorkflowException
- if the security realm is not listable, or if
any exception occurred.public UserInfo getUserInfo(java.lang.String userID) throws java.rmi.RemoteException, WorkflowException
userID
- The ID of the user about whom further information is
required.java.rmi.RemoteException
- if a communications error occurred.WorkflowException
- if the security realm is not listable, or if
any exception occurred.public java.util.List getOrganizationsForUser(java.lang.String userID, boolean obtainAttributes) throws java.rmi.RemoteException, WorkflowException
userID
- The ID of the user.obtainAttributes
- true
to return all OrganizationInfo
attributes, false
for just the orgIDs.OrganizationInfo
objects.java.rmi.RemoteException
- if a communications error occurred.WorkflowException
- if the security realm is not listable, or if
any exception occurred.public java.util.List getRolesForUser(java.lang.String orgID, java.lang.String userID, boolean obtainAttributes) throws java.rmi.RemoteException, WorkflowException
orgID
- The ID of the organization.userID
- The ID of the user.obtainAttributes
- true
to return all RoleInfo
attributes, false
for just the
roleIDs.RoleInfo
objects.java.rmi.RemoteException
- if a communications error occurred.WorkflowException
- if the security realm is not listable, or if
any exception occurred.public java.util.List getRolesInOrganization(java.lang.String orgID, boolean obtainAttributes) throws java.rmi.RemoteException, WorkflowException
orgID
- The ID of the organization.obtainAttributes
- true
to return all RoleInfo
attributes, false
for just the
roleIDs.RoleInfo
objects.java.rmi.RemoteException
- if a communications error occurred.WorkflowException
- if the security realm is not listable, or if
any exception occurred.public java.util.List getUsersInOrganization(java.lang.String orgID, boolean obtainAttributes) throws java.rmi.RemoteException, WorkflowException
orgID
- The ID of the organization.obtainAttributes
- true
to return all UserInfo
attributes, false
for just the
userIDs.UserInfo
objects.java.rmi.RemoteException
- if a communications error occurred.WorkflowException
- if the security realm is not listable, or if
any exception occurred.public java.util.List getUsersInRole(java.lang.String roleID, java.lang.String orgID, boolean obtainAttributes) throws java.rmi.RemoteException, WorkflowException
roleID
- The ID of the role.orgID
- The ID of the organization.obtainAttributes
- true
to return all UserInfo
attributes, false
for just the
userIDs.UserInfo
objects.java.rmi.RemoteException
- if a communications error occurred.WorkflowException
- if the security realm is not listable, or if
any exception occurred.public java.lang.String getSecurityRealmClassName() throws java.rmi.RemoteException, WorkflowException
weblogic.security.acl.internal.WLPropertyRealm
) is
in use, and to adjust user interfaces to reflect the fact that this
realm, although manageable, does not* persist updates.
*As at the time of writing (WebLogic Server 5.1 SP6).
java.rmi.RemoteException
- if a communications error occurred.WorkflowException
- if the security realm is not listable, or if
any exception occurred.isManageableSecurityRealm()
public boolean isManageableSecurityRealm() throws java.rmi.RemoteException, WorkflowException
true
if the security realm implements the
ManageableRealm
interface.java.rmi.RemoteException
- if a communications error occurred.WorkflowException
- if the security realm is not listable, or if
any exception occurred.getSecurityRealmClassName()
public boolean isRoleInOrganization(java.lang.String roleID, java.lang.String orgID) throws java.rmi.RemoteException, WorkflowException
roleID
- The ID of the role.orgID
- The ID of the organization.true
if role defined within organization.java.rmi.RemoteException
- if a communications error occurred.WorkflowException
- if the security realm is not listable, or if
any exception occurred.public boolean isUserInOrganization(java.lang.String userID, java.lang.String orgID) throws java.rmi.RemoteException, WorkflowException
userID
- The ID of the user.orgID
- The ID of the organization.true
if user belongs to organization.java.rmi.RemoteException
- if a communications error occurred.WorkflowException
- if the security realm is not listable, or if
any exception occurred.public void removeUserFromOrganization(java.lang.String userID, java.lang.String orgID) throws java.rmi.RemoteException, WorkflowException
userID
- The ID of the user to remove.orgID
- The ID of the organization.java.rmi.RemoteException
- if a communications error occurred.WorkflowException
- if the security realm is not manageable, or if
any exception occurred.public void removeUserFromRole(java.lang.String userID, java.lang.String orgID, java.lang.String roleID) throws java.rmi.RemoteException, WorkflowException
userID
- The ID of the user to remove.orgID
- The ID of the organization.roleID
- The ID of role within the organization orgID
.java.rmi.RemoteException
- if a communications error occurred.WorkflowException
- if the security realm is not manageable, or if
any exception occurred.public void setOrganizationInfo(OrganizationInfo orgInfo) throws java.rmi.RemoteException
orgInfo
was retrieved with obtainAttributes=true
(where applicable) to avoid inadvertently clearing the attributes.orgInfo
- Organization information to update.java.rmi.RemoteException
- if a communications error occurred.public void setRoleInfo(RoleInfo roleInfo) throws java.rmi.RemoteException
roleInfo
was retrieved with obtainAttributes=true
(where applicable) to avoid inadvertently clearing the attributes.roleInfo
- Role information to update.java.rmi.RemoteException
- if a communications error occurred.public void setUserInfo(UserInfo userInfo) throws java.rmi.RemoteException
userInfo
was retrieved with obtainAttributes=true
(where applicable) to avoid inadvertently clearing the attributes.userInfo
- User information to update.java.rmi.RemoteException
- if a communications error occurred.public java.security.Principal createWlpiUser(java.lang.String userID, java.lang.String pswd) throws java.rmi.RemoteException, WorkflowException
userID
- The name of the user to add.pswd
- The clear-text password for the user.java.rmi.RemoteException
- if a communications error occurred.WorkflowException
- if the user could not be added (already
exists, etc.).public UserInfo createUser(java.lang.String userID, java.lang.String pswd) throws java.rmi.RemoteException, WorkflowException
userID
- The name of the user to add.pswd
- The clear-text password for the user.java.rmi.RemoteException
- if a communications error occurred.WorkflowException
- if the user could not be added (already
exists, etc.).public void deleteUser(java.lang.String userID) throws java.rmi.RemoteException, WorkflowException
userID
- The name of the user to delete.java.rmi.RemoteException
- if a communications error occurred.WorkflowException
- if the user could not be deleted (does
not exist, etc.).public java.util.Map getRoleMappingsInOrg(java.lang.String orgID) throws java.rmi.RemoteException, WorkflowException
String
- Organization IDjava.rmi.RemoteException
- if a communications error occurred.WorkflowException
- if the mapping could not be retrievedpublic java.lang.String getMappedGroup(java.lang.String roleID, java.lang.String orgID) throws java.rmi.RemoteException, WorkflowException
String
- Role IDString
- Organization IDjava.rmi.RemoteException
- if a communications error occurred.WorkflowException
- if the mapping could not be retrievedpublic java.util.List getGroups() throws java.rmi.RemoteException, WorkflowException
java.rmi.RemoteException
- if a communications error occurred.WorkflowException
- if the list could not be retrievedpublic void mapRoleToGroup(java.lang.String roleID, java.lang.String orgID, java.lang.String groupID) throws java.rmi.RemoteException, WorkflowException
String
- Role IDString
- Organization IDString
- Group IDjava.rmi.RemoteException
- if a communications error occurred.WorkflowException
- if an error occurred during the updatepublic void mapRolesToGroups(java.lang.String orgID, java.util.Map rolesToGroupMap) throws java.rmi.RemoteException, WorkflowException
String
- Organization IDMap
- Map of RoleID/GroupIDjava.rmi.RemoteException
- if a communications error occurred.WorkflowException
- if an error occurred during the update
|
WebLogic Process Integrator Version 2.0 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |