|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Interface for remote systems that provide the WebADE with user details for users in the WebADE system.
| Field Summary | |
static java.lang.String |
PROVIDER_CLASS_NAME
The user-provider class name preference name. |
static java.lang.String |
PROVIDER_ENABLED
The user-provider enabled preference name. |
static java.lang.String |
WEBADE_USER_PROVIDER_SUBTYPE
The WebADE user provider preference sub-type. |
| Method Summary | |
UserSearchQuery |
createUserSearchQuery(UserTypeCode userType)
Returns a UserSearchQuery metadata object for the given user type code. |
java.util.List |
findUsers(UserCredentials requestingUserCredentials,
UserSearchQuery query)
Returns the user information of the users from the LDAP directory matching the given search criteria. |
java.lang.String |
getSourceDirectoryForUserType(UserTypeCode userType)
Returns the source directory for the given user type if it is supported by this provider. |
java.lang.String[] |
getSupportedSourceDirectories()
|
UserTypeCode[] |
getSupportedUserTypes()
|
WebADEUserInfo |
getUser(UserCredentials requestingUserCredentials,
UserCredentials targetUserCredentials)
Returns the user information from the LDAP directory hosting the user identified by the given credentials. |
UserTypeCode |
getUserTypeForSourceDirectory(java.lang.String sourceDirectory)
Returns the user type for the given source directory if it is supported by this provider. |
boolean |
handlesSourceDirectory(java.lang.String sourceDirectory)
Returns true if the given sourceDirectory is one of the ones supported by this provider. |
boolean |
handlesUserType(UserTypeCode userType)
Returns true if the given user type is one of the ones supported by this provider. |
void |
init(java.util.Properties properties)
Initializes the provider using the given preference set. |
GUID[] |
isUserInGroups(UserCredentials requestingUserCredentials,
UserCredentials targetUserCredentials,
GUID[] groupGuids)
Checks to see if the user is a member of the groups identified by the given array of GUID values. |
| Field Detail |
public static final java.lang.String WEBADE_USER_PROVIDER_SUBTYPE
public static final java.lang.String PROVIDER_CLASS_NAME
public static final java.lang.String PROVIDER_ENABLED
| Method Detail |
public void init(java.util.Properties properties)
throws WebADEUserProviderException
properties - Configuration settings for the user info provider hosting user
information for this WebADE application.
WebADEUserProviderException - Thrown if the configuration settings are not properly
configured (Missing parameters, etc).
public boolean handlesSourceDirectory(java.lang.String sourceDirectory)
throws WebADEUserProviderException
sourceDirectory - The target sourceDirectory name.
WebADEUserProviderException
public boolean handlesUserType(UserTypeCode userType)
throws WebADEUserProviderException
userType - The target user type.
WebADEUserProviderException
public java.lang.String getSourceDirectoryForUserType(UserTypeCode userType)
throws WebADEUserProviderException
userType - The target user type.
WebADEUserProviderException
public UserTypeCode getUserTypeForSourceDirectory(java.lang.String sourceDirectory)
throws WebADEUserProviderException
sourceDirectory - The target sourceDirectory name.
WebADEUserProviderException
public java.lang.String[] getSupportedSourceDirectories()
throws WebADEUserProviderException
WebADEUserProviderException
public UserTypeCode[] getSupportedUserTypes()
throws WebADEUserProviderException
WebADEUserProviderException
public WebADEUserInfo getUser(UserCredentials requestingUserCredentials,
UserCredentials targetUserCredentials)
throws WebADEUserProviderException
requestingUserCredentials - The requesting user's credentials.targetUserCredentials - The user's credentials to look up.
WebADEUserProviderException - Thrown if a connection cannot be made to the application's
LDAP directories or an error occurs.
public GUID[] isUserInGroups(UserCredentials requestingUserCredentials,
UserCredentials targetUserCredentials,
GUID[] groupGuids)
throws WebADEUserProviderException
requestingUserCredentials - The requesting user's credentials.targetUserCredentials - The user's credentials to look up.groupGuids - The unique GUID values of the target groups.
WebADEUserProviderException - Thrown if ant of the groups are not found or an error occurs
while processing the request.
public UserSearchQuery createUserSearchQuery(UserTypeCode userType)
throws WebADEUserProviderException
userType - The user type to create a query object for.
WebADEUserProviderException - Thrown if searching for the given user type is not supported.
public java.util.List findUsers(UserCredentials requestingUserCredentials,
UserSearchQuery query)
throws WebADEUserProviderException
requestingUserCredentials - The requesting user's credentials.query - The user search query containing the search parameters.
WebADEUserProviderException - Thrown if a connection cannot be made to the application's
LDAP directories or an error occurs.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||