|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
API that contains all functionality related to user information, including the retrieval and searching for user information, along with various supporting API calls.
| Method Summary | |
UserSearchQuery |
createUserSearchQuery(UserTypeCode userType)
Returns the UserSearchQuery meta-data object to perform user searching for this application on the provided user type. |
WebADEUserInfo[] |
findUsers(UserSearchQuery searchQuery)
Finds the set of WebADEUserInfo objects that match the provided 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()
Returns the set of source directory names supported by this instance of the UserInfoService. |
UserTypeCode[] |
getSupportedUserTypes()
Returns the set of user type codes supported by this instance of the UserInfoService. |
UserTypeCode |
getUserTypeForSourceDirectory(java.lang.String sourceDirectory)
Returns the user type for the given source directory if it is supported by this provider. |
WebADEUserInfo |
getWebADEUserInfo(UserCredentials userCredentials)
Loads the target user's personal information from the user provider, or returns null if the user is not found. |
WebADEUserInfo |
getWebADEUserInfo(UserCredentials userCredentials,
boolean ignoreSessionCache)
Loads the target user's personal information from the user provider, or returns null if the user is not found. |
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. |
boolean |
isUserInGroup(UserCredentials userCredentials,
GUID groupGuid)
Checks to see if the user is a member of the group identified by the given GUID. |
GUID[] |
isUserInGroups(UserCredentials userCredentials,
GUID[] groupGuids)
Checks to see if the user is a member of the groups identified by the given array of GUID values. |
| Method Detail |
public boolean handlesSourceDirectory(java.lang.String sourceDirectory)
throws UserInfoServiceException
sourceDirectory - The target sourceDirectory name.
UserInfoServiceException
public boolean handlesUserType(UserTypeCode userType)
throws UserInfoServiceException
userType - The target user type.
UserInfoServiceException
public java.lang.String getSourceDirectoryForUserType(UserTypeCode userType)
throws UserInfoServiceException
userType - The target user type.
UserInfoServiceException
public UserTypeCode getUserTypeForSourceDirectory(java.lang.String sourceDirectory)
throws UserInfoServiceException
sourceDirectory - The target sourceDirectory name.
UserInfoServiceException
public java.lang.String[] getSupportedSourceDirectories()
throws UserInfoServiceException
UserInfoServiceException
public UserTypeCode[] getSupportedUserTypes()
throws UserInfoServiceException
UserInfoServiceException
public WebADEUserInfo getWebADEUserInfo(UserCredentials userCredentials)
throws UserInfoServiceException
userCredentials - The user's identifying credentials.
UserInfoServiceException
public WebADEUserInfo getWebADEUserInfo(UserCredentials userCredentials,
boolean ignoreSessionCache)
throws UserInfoServiceException
userCredentials - The user's identifying credentials.ignoreSessionCache - A flag indicating whether to ignore the internally cached user
info object, should it match the given user credentials.
UserInfoServiceException
public boolean isUserInGroup(UserCredentials userCredentials,
GUID groupGuid)
throws UserInfoServiceException
userCredentials - The target user's credentials.groupGuid - The unique GUID of the target group.
UserInfoServiceException - Thrown if the group is not found or an error occurs while
processing the request.
public GUID[] isUserInGroups(UserCredentials userCredentials,
GUID[] groupGuids)
throws UserInfoServiceException
userCredentials - The target user's credentials.groupGuids - The unique GUID values of the target groups.
UserInfoServiceException - Thrown if ant of the groups are not found or an error occurs
while processing the request.
public UserSearchQuery createUserSearchQuery(UserTypeCode userType)
throws UserInfoServiceException
userType - The user type to perform searching for.
UserInfoServiceException - Thrown when an error occurs while trying to create the search
query from the user provider for the given user type.
public WebADEUserInfo[] findUsers(UserSearchQuery searchQuery)
throws UserInfoServiceException
searchQuery - The search query.
UserInfoServiceException - Thrown when an error occurs while trying to retrieve the
information from the user provider.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||