|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.4) E14255-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.bea.p13n.security.management.authentication.AtnManagerProxy
public class AtnManagerProxy
This class provides access to all user and group management functions
as defined by the WLS Security Service Provider Interface (SSPI). This
class acts as a proxy for a single, configured Authentication Provider
plug-in by proxying calls to the UserProvider
and
GroupProvider
classes.
This class should not contain any layered product dependencies.
Since it is possible that an Authentication Provider may not implement
all optional management interfaces, an OperationNotSupportedException
may be thrown.
This class is constructed using the AtnProviderDescription
.
AtnSecurityMgmtHelper
Constructor Summary | |
---|---|
AtnManagerProxy(AtnProviderDescription aProviderDescription)
Creates an instance of AtnManagerProxy that provides access to all user and group management functions. |
|
AtnManagerProxy(AtnProviderDescription aProviderDescription,
boolean cacheAdminMBean)
Creates an instance of AtnManagerProxy that provides access to all user and group management functions. |
Method Summary | |
---|---|
void |
addGroupToGroup(String parentGroup,
String childGroup)
Add a child group to a group within this provider. |
void |
addUserToGroup(String groupName,
String userName)
Add a user to an existing group within this provider. |
void |
createGroup(String groupName)
Create a new group within this provider. |
void |
createGroup(String groupName,
String description)
Create a new group within this provider. |
void |
createUser(String userName,
String password)
Creates a user with the given username and password. |
void |
createUser(String userName,
String password,
String description)
Creates a user with the given username and password. |
List<String> |
getAllGroupNames()
Retrieve a list of all groups from this provider. |
List<String> |
getChildGroupNames(String groupName)
Retrieve a list of all children of a group within this provider. |
String |
getGroupDescription(String groupName)
Get description for a group |
List<String> |
getGroupNamesForUser(String userName)
Retrieve a list of all groups that a given user belongs to within this provider. |
String |
getName()
The name of the provider is the AtnProviderDescription's name |
List<String> |
getParentGroupNames(String groupName)
Retrieve a list of all direct parents of a group within this provider. |
String |
getUniqueName()
Get the unique name for this AtnManagerProxy. |
String |
getUserDescription(String userName)
Get description for a user |
List<String> |
getUserNames(String searchExpression,
int limit)
Returns a List of user names matching the search expression |
List<String> |
getUsernamesForGroup(String groupName)
Retrieve a list of all users in a group in this provider. |
List<String> |
getUsernamesForGroup(String groupName,
String searchExpression,
int limit)
Retrieve a list of users in a group within this provider, matching the provided wildcard expression. |
boolean |
groupExists(String groupName)
Determines if a group exists within this provider (does not check all providers). |
boolean |
isDescendent(String ancestor,
String descendent)
Determine if one group is a descendent of another. |
boolean |
isMemberGroup(String groupNameParent,
String groupNameChild,
boolean recurse)
Determine if a group is a member of a group. |
boolean |
isMemberUser(String groupName,
String userName,
boolean recurse)
Determine if a user is a member of a group. |
void |
removeGroup(String groupName)
Remove a group from this provider. |
void |
removeGroupFromGroup(String parentGroup,
String childGroup)
Remove a child group from an existing group within this provider. |
void |
removeUser(String userName)
Removes a user from the system. |
void |
removeUserFromGroup(String groupName,
String userName)
Remove a user from an existing group within this provider. |
void |
setContextHandler(P13nContextHandler contextHandler)
Associate the context handler identifying the caller of AtnManagerProxy methods. |
void |
setGroupDescription(String groupName,
String description)
Update the description associated with a group name. |
void |
setPassword(String userName,
String password)
Sets the password for a user in the realm. |
void |
setUserDescription(String userName,
String description)
Update the description associated with a user name. |
boolean |
userExists(String userName)
Determines if a user exists. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AtnManagerProxy(AtnProviderDescription aProviderDescription)
aProviderDescription
- An authentication provider's description
IllegalArgumentException
- if aProviderDescription
is null
.public AtnManagerProxy(AtnProviderDescription aProviderDescription, boolean cacheAdminMBean)
aProviderDescription
- An authentication provider's descriptioncacheAdminMBean
- flag for caching admin MBean
IllegalArgumentException
- if aProviderDescription
is null
.Method Detail |
---|
public boolean groupExists(String groupName) throws OperationNotSupportedException
groupName
- the group name to check
OperationNotSupportedException
- if authentication provider
implementation does not support this operationpublic void createGroup(String groupName) throws GroupAlreadyExistsException, InvalidGroupnameException, OperationNotSupportedException
groupName
- the name of the group to create.
GroupAlreadyExistsException
- if the group already exists
InvalidGroupnameException
- if the group name is invalid
OperationNotSupportedException
- if authentication provider
implementation does not support this operationpublic void createGroup(String groupName, String description) throws GroupAlreadyExistsException, InvalidGroupnameException, OperationNotSupportedException
groupName
- the name of the group to create.description
- the optional description
GroupAlreadyExistsException
- if the group already exists
InvalidGroupnameException
- if the group name is invalid
OperationNotSupportedException
- if authentication provider
implementation does not support this operationpublic void removeGroup(String groupName) throws InvalidGroupnameException, OperationNotSupportedException
groupName
- of the group to remove
InvalidGroupnameException
- if the group is protected and cannot be deleted
OperationNotSupportedException
- if authentication provider
implementation does not support this operationpublic void addUserToGroup(String groupName, String userName) throws OperationNotSupportedException
groupName
- the name of the group to modifyuserName
- the name of the user to add
OperationNotSupportedException
- if authentication provider
implementation does not support this operationpublic void removeUserFromGroup(String groupName, String userName) throws OperationNotSupportedException
groupName
- the name of the group to modifyuserName
- the name of the user to remove
OperationNotSupportedException
- if authentication provider
implementation does not support this operationpublic void addGroupToGroup(String parentGroup, String childGroup) throws OperationNotSupportedException
parentGroup
- the name of the group to modifychildGroup
- the name of the group to add
OperationNotSupportedException
- if authentication provider
implementation does not support this operationpublic void removeGroupFromGroup(String parentGroup, String childGroup) throws OperationNotSupportedException
parentGroup
- the name of the group to modifychildGroup
- the name of the group to remove
OperationNotSupportedException
- if authentication provider
implementation does not support this operationpublic List<String> getAllGroupNames() throws OperationNotSupportedException
OperationNotSupportedException
- if authentication provider
implementation does not support this operationpublic List<String> getGroupNamesForUser(String userName) throws OperationNotSupportedException
userName
- the user to query
OperationNotSupportedException
- if authentication provider
implementation does not support this operationpublic List<String> getUsernamesForGroup(String groupName) throws OperationNotSupportedException
groupName
- the group to query
OperationNotSupportedException
- if authentication provider
implementation does not support this operationpublic List<String> getUsernamesForGroup(String groupName, String searchExpression, int limit) throws OperationNotSupportedException
groupName
- the group to querysearchExpression
- a wildcard expression to matchlimit
- the maximum number of results to return
OperationNotSupportedException
- if authentication provider
implementation does not support this operationpublic List<String> getParentGroupNames(String groupName) throws OperationNotSupportedException
groupName
- the group to query
OperationNotSupportedException
- if authentication provider
implementation does not support this operationpublic List<String> getChildGroupNames(String groupName) throws OperationNotSupportedException
groupName
- the group to query
OperationNotSupportedException
- if authentication provider
implementation does not support this operationpublic boolean isDescendent(String ancestor, String descendent) throws OperationNotSupportedException
ancestor
- see if the other group is a descendent of this groupdescendent
- see if this is a descendent of the other group
OperationNotSupportedException
- if authentication provider
implementation does not support this operationpublic boolean isMemberUser(String groupName, String userName, boolean recurse) throws OperationNotSupportedException
groupName
- the group to queryuserName
- the user to look forrecurse
- Extend search to descendents of groupName
OperationNotSupportedException
- if authentication provider
implementation does not support this operationpublic boolean isMemberGroup(String groupNameParent, String groupNameChild, boolean recurse) throws OperationNotSupportedException
groupNameParent
- the group to querygroupNameChild
- the child group to look forrecurse
- Extend search to descendents of groupName
OperationNotSupportedException
- if authentication provider
implementation does not support this operationpublic boolean userExists(String userName) throws OperationNotSupportedException
userName
- the user to look for
OperationNotSupportedException
- if authentication provider
implementation does not support this operationpublic void createUser(String userName, String password) throws UserAlreadyExistsException, InvalidUsernameException, InvalidPasswordException, OperationNotSupportedException
userName
- the username for the new userpassword
- the password for the new user
InvalidPasswordException
- if the password is malformed or
otherwise invalid
InvalidUsernameException
- if the username is malformed or
otherwise invalid
UserAlreadyExistsException
- if the username is already in use
OperationNotSupportedException
- if authentication provider
implementation does not support this operationpublic void createUser(String userName, String password, String description) throws UserAlreadyExistsException, InvalidUsernameException, InvalidPasswordException, OperationNotSupportedException
userName
- the username for the new userpassword
- the password for the new userdescription
- the optional description
InvalidPasswordException
- if the password is malformed or
otherwise invalid
InvalidUsernameException
- if the username is malformed or
otherwise invalid
UserAlreadyExistsException
- if the username is already in use
OperationNotSupportedException
- if authentication provider
implementation does not support this operationpublic void setPassword(String userName, String password) throws InvalidPasswordException, OperationNotSupportedException
userName
- the username of the userpassword
- the new password for the user
InvalidPasswordException
- if the password is malformed or
otherwise invalid
OperationNotSupportedException
- if authentication provider
implementation does not support this operationpublic void removeUser(String userName) throws InvalidUsernameException, OperationNotSupportedException
userName
- the username of the user to remove
InvalidUsernameException
- if the user is protected and cannot be deleted
OperationNotSupportedException
- if authentication provider
implementation does not support this operationpublic List<String> getUserNames(String searchExpression, int limit) throws OperationNotSupportedException
searchExpression
- a wildcard search expressionlimit
- a limit of results to return
OperationNotSupportedException
- if authentication provider
implementation does not support this operationpublic String getName()
public String getUniqueName()
public void setUserDescription(String userName, String description) throws OperationNotSupportedException
userName
- User to update description fordescription
- Updated description
OperationNotSupportedException
public void setGroupDescription(String groupName, String description) throws OperationNotSupportedException
groupName
- Group to update description fordescription
- Updated description
OperationNotSupportedException
public String getUserDescription(String userName) throws OperationNotSupportedException
userName
-
OperationNotSupportedException
public String getGroupDescription(String groupName) throws OperationNotSupportedException
groupName
-
OperationNotSupportedException
public void setContextHandler(P13nContextHandler contextHandler)
contextHandler
- Optional context handler identifying caller.
|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.4) E14255-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |