ca.bc.gov.webade
Interface UserInfoProvider


Deprecated. Use ca.bc.gov.webade.user.provider.UserProvider instead.

public interface UserInfoProvider

Interface for remote systems that provide the WebADE with user details for users in the WebADE system.

Author:
jross

Method Summary
 java.util.List findUsers(UserSearchObject searchObject)
          Deprecated. Returns the user information of the users from the LDAP directory matching the given search criteria.
 java.lang.String[] getSupportedSourceDirectories()
          Deprecated.  
 UserTypeCode[] getSupportedUserTypes()
          Deprecated.  
 WebADEUserInfo getUser(UserCredentials credentials)
          Deprecated. Returns the user information from the LDAP directory hosting the user identified by the given credentials.
 java.util.List getUserSearchMetadata()
          Deprecated. Returns a List of UserSearchObject metadata objects for all configured directories for this application.
 boolean handlesSourceDirectory(java.lang.String sourceDirectory)
          Deprecated. Returns true if the given sourceDirectory is one of the ones supported by this provider.
 boolean handlesUserType(UserTypeCode userType)
          Deprecated. Returns true if the given user type is one of the ones supported by this provider.
 void init(PreferenceSet preferences)
          Deprecated. Initializes the provider using the given preference set.
 GUID[] isUserInGroups(UserCredentials user, GUID[] groupGuids)
          Deprecated. Checks to see if the user is a member of the groups identified by the given array of GUID values.
 

Method Detail

init

public void init(PreferenceSet preferences)
          throws WebADEException
Deprecated. 
Initializes the provider using the given preference set.

Parameters:
preferences - Configuration settings for the user info provider hosting user information for this WebADE application.
Throws:
WebADEException - Thrown if the configuration settings are not properly configured (Missing parameters, etc).

handlesSourceDirectory

public boolean handlesSourceDirectory(java.lang.String sourceDirectory)
Deprecated. 
Returns true if the given sourceDirectory is one of the ones supported by this provider.

Parameters:
sourceDirectory - The target sourceDirectory name.
Returns:
True if this provider provides support for the given domain.

handlesUserType

public boolean handlesUserType(UserTypeCode userType)
Deprecated. 
Returns true if the given user type is one of the ones supported by this provider.

Parameters:
userType - The target user type.
Returns:
True if this provider provides support for the given user type.

getSupportedSourceDirectories

public java.lang.String[] getSupportedSourceDirectories()
Deprecated. 
Returns:
The array of source directory names this provider handles.

getSupportedUserTypes

public UserTypeCode[] getSupportedUserTypes()
Deprecated. 
Returns:
The array of user types this provider handles.

getUser

public WebADEUserInfo getUser(UserCredentials credentials)
                       throws WebADEException
Deprecated. 
Returns the user information from the LDAP directory hosting the user identified by the given credentials.

Parameters:
credentials - The user's credentials.
Returns:
The loaded user object, or null if the user is not found.
Throws:
WebADEException - Thrown if a connection cannot be made to the application's LDAP directories or an error occurs.

isUserInGroups

public GUID[] isUserInGroups(UserCredentials user,
                             GUID[] groupGuids)
                      throws WebADEException
Deprecated. 
Checks to see if the user is a member of the groups identified by the given array of GUID values. This method will also traverse the groups' member groups recursively until it has either found the user or exhausted the set of member groups.

Parameters:
user - The target user credentials object.
groupGuids - The unique GUID values of the target groups.
Returns:
The array of all GUID values for groups in the set that the user is a member of (Returns a size-0 array if the user is not a member of any of the given groups).
Throws:
WebADEException - Thrown if ant of the groups are not found or an error occurs while processing the request.

getUserSearchMetadata

public java.util.List getUserSearchMetadata()
Deprecated. 
Returns a List of UserSearchObject metadata objects for all configured directories for this application.

Returns:
A List of UserSearchObject objects.

findUsers

public java.util.List findUsers(UserSearchObject searchObject)
                         throws WebADEException
Deprecated. 
Returns the user information of the users from the LDAP directory matching the given search criteria.

Parameters:
searchObject - The user search object containing the search parameters.
Returns:
The List of loaded user objects.
Throws:
WebADEException - Thrown if a connection cannot be made to the application's LDAP directories or an error occurs.