com.bea.p13n.security.management.authentication
Class AtnManagerProxy

java.lang.Object
  com.bea.p13n.security.management.authentication.AtnManagerProxy

public class AtnManagerProxy

extends Object

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.

See Also:

AtnSecurityMgmtHelper

Constructor Summary

AtnManagerProxy(AtnProviderDescription aProviderDescription)

AtnManagerProxy(AtnProviderDescription aProviderDescription, boolean cacheAdminMBean)

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	createUser(String userName, String password) Creates a user with the given username and password.
List	getAllGroupNames() Retrieve a list of all groups from this provider.
List	getChildGroupNames(String groupName) Retrieve a list of all children of a group within this provider.
List	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
String	getUniqueName() Get the unique name for this AtnManagerProxy.
List	getUserNames(String searchExpression, int limit) Returns a List of user names matching the search expression
List	getUsernamesForGroup(String groupName) Retrieve a list of all users in a group in this provider.
List	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 userNameChild, 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	setPassword(String userName, String password) Sets the password for a user in the realm.
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

AtnManagerProxy

public AtnManagerProxy(AtnProviderDescription aProviderDescription)

AtnManagerProxy

public AtnManagerProxy(AtnProviderDescription aProviderDescription,
                       boolean cacheAdminMBean)

Method Detail

addGroupToGroup

public void addGroupToGroup(String parentGroup,
                            String childGroup)
                     throws OperationNotSupportedException

Add a child group to a group within this provider.

Parameters:

parentGroup - the name of the group to modify

childGroup - the name of the group to add

Throws:

OperationNotSupportedException - if authentication provider implementation does not support this operation

addUserToGroup

public void addUserToGroup(String groupName,
                           String userName)
                    throws OperationNotSupportedException

Add a user to an existing group within this provider.

Parameters:

groupName - the name of the group to modify

userName - the name of the user to add

Throws:

OperationNotSupportedException - if authentication provider implementation does not support this operation

createGroup

public void createGroup(String groupName)
                 throws GroupAlreadyExistsException,
                        InvalidGroupnameException,
                        OperationNotSupportedException

Create a new group within this provider. This method will always check to insure the group name is not a reserved WLS group name or a reserved group name as listed in the Security Provider Service settings in the Portal Admin tool.

Parameters:

groupName - the name of the group to create.

Throws:

GroupAlreadyExistsException - if the group already exists

InvalidGroupnameException - if the group name is invalid

OperationNotSupportedException - if authentication provider implementation does not support this operation

createUser

public void createUser(String userName,
                       String password)
                throws UserAlreadyExistsException,
                       InvalidUsernameException,
                       InvalidPasswordException,
                       OperationNotSupportedException

Creates a user with the given username and password.

Parameters:

userName - the username for the new user

password - the password for the new user

Throws:

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 operation

getAllGroupNames

public List getAllGroupNames()
                      throws OperationNotSupportedException

Retrieve a list of all groups from this provider.

Throws:

OperationNotSupportedException - if authentication provider implementation does not support this operation

getChildGroupNames

public List getChildGroupNames(String groupName)
                        throws OperationNotSupportedException

Retrieve a list of all children of a group within this provider.

Parameters:

groupName - the group to query

Returns:

a List of Strings containing the children which are groups

Throws:

OperationNotSupportedException - if authentication provider implementation does not support this operation

getGroupNamesForUser

public List getGroupNamesForUser(String userName)
                          throws OperationNotSupportedException

Retrieve a list of all groups that a given user belongs to within this provider.

Parameters:

userName - the user to query

Returns:

a List of Strings containing the groups

Throws:

OperationNotSupportedException - if authentication provider implementation does not support this operation

getName

public String getName()

The name of the provider is the AtnProviderDescription's name

getUniqueName

public String getUniqueName()

Get the unique name for this AtnManagerProxy. It's the concatenation of the display name with the version.

getUserNames

public List getUserNames(String searchExpression,
                         int limit)
                  throws OperationNotSupportedException

Returns a List of user names matching the search expression

Parameters:

searchExpression - a wildcard search expression

limit - a limit of results to return

Throws:

OperationNotSupportedException - if authentication provider implementation does not support this operation

getUsernamesForGroup

public List getUsernamesForGroup(String groupName)
                          throws OperationNotSupportedException

Retrieve a list of all users in a group in this provider.

Parameters:

groupName - the group to query

Returns:

a List of Strings containing the users

Throws:

OperationNotSupportedException - if authentication provider implementation does not support this operation

getUsernamesForGroup

public List getUsernamesForGroup(String groupName,
                                 String searchExpression,
                                 int limit)
                          throws OperationNotSupportedException

Retrieve a list of users in a group within this provider, matching the provided wildcard expression.

Parameters:

groupName - the group to query

searchExpression - a wildcard expression to match

limit - the maximum number of results to return

Returns:

a List of usernames that are in this group

Throws:

OperationNotSupportedException - if authentication provider implementation does not support this operation

groupExists

public boolean groupExists(String groupName)
                    throws OperationNotSupportedException

Determines if a group exists within this provider (does not check all providers).

Parameters:

groupName - the group name to check

Returns:

true if the group exists, false otherwise

Throws:

OperationNotSupportedException - if authentication provider implementation does not support this operation

isDescendent

public boolean isDescendent(String ancestor,
                            String descendent)
                     throws OperationNotSupportedException

Determine if one group is a descendent of another.

Parameters:

ancestor - see if the other group is a descendent of this group

descendent - see if this is a descendent of the other group

Returns:

true if group is a descendentl, otherwise false

Throws:

OperationNotSupportedException - if authentication provider implementation does not support this operation

isMemberGroup

public boolean isMemberGroup(String groupNameParent,
                             String userNameChild,
                             boolean recurse)
                      throws OperationNotSupportedException

Determine if a group is a member of a group.

Parameters:

groupNameParent - the group to query

userNameChild - the user to look for

recurse - Extend search to descendents of groupName

Throws:

OperationNotSupportedException - if authentication provider implementation does not support this operation

isMemberUser

public boolean isMemberUser(String groupName,
                            String userName,
                            boolean recurse)
                     throws OperationNotSupportedException

Determine if a user is a member of a group.

Parameters:

groupName - the group to query

userName - the user to look for

recurse - Extend search to descendents of groupName

Throws:

OperationNotSupportedException - if authentication provider implementation does not support this operation

removeGroup

public void removeGroup(String groupName)
                 throws InvalidGroupnameException,
                        OperationNotSupportedException

Remove a group from this provider.

Parameters:

groupName - of the group to remove

Throws:

InvalidGroupnameException - if the group is protected and cannot be deleted

OperationNotSupportedException - if authentication provider implementation does not support this operation

removeGroupFromGroup

public void removeGroupFromGroup(String parentGroup,
                                 String childGroup)
                          throws OperationNotSupportedException

Remove a child group from an existing group within this provider.

Parameters:

parentGroup - the name of the group to modify

childGroup - the name of the group to remove

Throws:

OperationNotSupportedException - if authentication provider implementation does not support this operation

removeUser

public void removeUser(String userName)
                throws InvalidUsernameException,
                       OperationNotSupportedException

Removes a user from the system.

Parameters:

userName - the username of the user to remove

Throws:

InvalidUsernameException - if the user is protected and cannot be deleted

OperationNotSupportedException - if authentication provider implementation does not support this operation

removeUserFromGroup

public void removeUserFromGroup(String groupName,
                                String userName)
                         throws OperationNotSupportedException

Remove a user from an existing group within this provider.

Parameters:

groupName - the name of the group to modify

userName - the name of the user to remove

Throws:

OperationNotSupportedException - if authentication provider implementation does not support this operation

setPassword

public void setPassword(String userName,
                        String password)
                 throws InvalidPasswordException,
                        OperationNotSupportedException

Sets the password for a user in the realm.

Parameters:

userName - the username of the user

password - the new password for the user

Throws:

InvalidPasswordException - if the password is malformed or otherwise invalid

OperationNotSupportedException - if authentication provider implementation does not support this operation

userExists

public boolean userExists(String userName)
                   throws OperationNotSupportedException

Determines if a user exists. This method simply checks all providers for a user with the given name.

Parameters:

userName - the user to look for

Returns:

true if the user exists, false if it does not

Throws:

OperationNotSupportedException - if authentication provider implementation does not support this operation