© 2004 BEA Systems, Inc.

com.bea.p13n.controls.securityProvider
Interface UserProviderControl

All Superinterfaces:
weblogic.jws.control.Control, com.bea.control.Control, Serializable

public interface UserProviderControl
extends weblogic.jws.control.Control

This control:


Control properties:
Security requirements: These are determined by the roles specified on the AtnSecurityProvider MBean for the application. For example:

See Also:
ProfileWrapper

Nested Class Summary
 
Nested classes inherited from class com.bea.control.Control
com.bea.control.Control.Callback
 
Method Summary
 void createUser(String username, String password, HttpServletRequest request)
          Create a new user and return an object representing the user's information.
 List getUserNames(String searchExpression, int limit)
          Get a list of all user names
 void removeUser(String username)
          Removes a user from the system.
 void setPassword(String username, String password)
          Sets the password for a user in the realm.
 boolean userExists(String username)
          Determine whether a user exists
 

Method Detail

userExists

public boolean userExists(String username)
                   throws OperationNotSupportedException
Determine whether a user exists

Parameters:
username - The user (login) name of the user
Returns:
true if the user exists, false if cannot find user of this name
Throws:
OperationNotSupportedException - if authentication provider implementation does not support this operation

getUserNames

public List getUserNames(String searchExpression,
                         int limit)
                  throws OperationNotSupportedException
Get a list of all user names

Parameters:
searchExpression - a wildcard search expression
limit - a limit of results to return
Returns:
a List of all user names matching the search expression
Throws:
OperationNotSupportedException - if authentication provider implementation does not support this operation

createUser

public void createUser(String username,
                       String password,
                       HttpServletRequest request)
                throws UserAlreadyExistsException,
                       InvalidUsernameException,
                       LoginException,
                       InvalidPasswordException,
                       OperationNotSupportedException
Create a new user and return an object representing the user's information.

Parameters:
username - The user's login name
password - The user's password
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
LoginException

removeUser

public void removeUser(String username)
                throws InvalidUsernameException,
                       OperationNotSupportedException
Removes a user from the system. This will remove both the realm and profile records for this user. Security constraints should restrict use of this method to administrators only.

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

setPassword

public void setPassword(String username,
                        String password)
                 throws InvalidPasswordException,
                        OperationNotSupportedException
Sets the password for a user in the realm. Security constraints should restrict use of this method to administrators only.

Parameters:
username - the username of the user
password - the new password for the user
Throws:
InvalidPasswordExceptionif - the password is malformed or otherwise invalid
OperationNotSupportedException - if authentication provider implementation does not support this operation
InvalidPasswordException

© 2004 BEA Systems, Inc.

Copyright © 2004 BEA Systems, Inc. All Rights Reserved