|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectca.bc.gov.webade.user.provider.capws.v4.CAPWebServicesProvider
| Field Summary | |
static java.lang.String |
CAP_WEB_SERVICES_CONNECT_PASSWORD
The CAP web services connect password preference name. |
static java.lang.String |
CAP_WEB_SERVICES_CONNECT_USERNAME
The CAP web services connect username preference name. |
static java.lang.String |
CAP_WEB_SERVICES_PROVIDER_SUPPORTED_TYPES
The user-provider supported user types preference name. |
static java.lang.String |
CAP_WEB_SERVICES_PROVIDER_URL
The CAP web services provider url preference name. |
static java.lang.String |
CAP_WEB_SERVICES_PROVIDER_USER_TYPE_DOMAIN_SUFFIX
The user-provider supported user types domain mapping preference name suffix. |
static java.lang.String |
CAP_WEB_SERVICES_SECONDS_TIMEOUT
The CAP web services timeout value (in seconds) preference name. |
static java.lang.String |
CAP_WEB_SERVICES_SYSTEM_USER_ACCOUNT
The system user account name preference name. |
static java.lang.String |
CAP_WEB_SERVICES_SYSTEM_USER_GUID
The system user GUID preference name. |
static java.lang.String |
CAP_WEB_SERVICES_SYSTEM_USER_TYPE_CODE
The system user type code preference name. |
| Fields inherited from interface ca.bc.gov.webade.user.provider.WebADEUserProvider |
PROVIDER_CLASS_NAME, PROVIDER_ENABLED, WEBADE_USER_PROVIDER_SUBTYPE |
| Constructor Summary | |
CAPWebServicesProvider()
Default Constructor. |
|
| 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()
|
java.util.LinkedHashMap |
getSupportedTypesAndDomains()
|
UserTypeCode[] |
getSupportedUserTypes()
|
int |
getTimeout()
|
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. |
java.lang.String |
getWebServiceUrl()
|
java.lang.String |
getWebServiceUsername()
|
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. |
java.lang.String |
toString()
|
| Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
public static final java.lang.String CAP_WEB_SERVICES_PROVIDER_SUPPORTED_TYPES
public static final java.lang.String CAP_WEB_SERVICES_PROVIDER_USER_TYPE_DOMAIN_SUFFIX
public static final java.lang.String CAP_WEB_SERVICES_PROVIDER_URL
public static final java.lang.String CAP_WEB_SERVICES_SECONDS_TIMEOUT
public static final java.lang.String CAP_WEB_SERVICES_CONNECT_USERNAME
public static final java.lang.String CAP_WEB_SERVICES_CONNECT_PASSWORD
public static final java.lang.String CAP_WEB_SERVICES_SYSTEM_USER_TYPE_CODE
public static final java.lang.String CAP_WEB_SERVICES_SYSTEM_USER_GUID
public static final java.lang.String CAP_WEB_SERVICES_SYSTEM_USER_ACCOUNT
| Constructor Detail |
public CAPWebServicesProvider()
| Method Detail |
public final void init(java.util.Properties properties)
throws WebADEUserProviderException
WebADEUserProvider
init in interface WebADEUserProviderproperties - 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).WebADEUserProvider.init(java.util.Properties)public final boolean handlesSourceDirectory(java.lang.String sourceDirectory)
WebADEUserProvider
handlesSourceDirectory in interface WebADEUserProvidersourceDirectory - The target sourceDirectory name.
WebADEUserProvider.handlesSourceDirectory(java.lang.String)public final boolean handlesUserType(UserTypeCode userType)
WebADEUserProvider
handlesUserType in interface WebADEUserProvideruserType - The target user type.
WebADEUserProvider.handlesUserType(ca.bc.gov.webade.user.UserTypeCode)public final java.lang.String getSourceDirectoryForUserType(UserTypeCode userType)
WebADEUserProvider
getSourceDirectoryForUserType in interface WebADEUserProvideruserType - The target user type.
WebADEUserProvider.getSourceDirectoryForUserType(ca.bc.gov.webade.user.UserTypeCode)public final UserTypeCode getUserTypeForSourceDirectory(java.lang.String sourceDirectory)
WebADEUserProvider
getUserTypeForSourceDirectory in interface WebADEUserProvidersourceDirectory - The target sourceDirectory name.
WebADEUserProvider.getUserTypeForSourceDirectory(java.lang.String)public final java.lang.String[] getSupportedSourceDirectories()
getSupportedSourceDirectories in interface WebADEUserProviderWebADEUserProvider.getSupportedSourceDirectories()public final UserTypeCode[] getSupportedUserTypes()
getSupportedUserTypes in interface WebADEUserProviderWebADEUserProvider.getSupportedUserTypes()
public final WebADEUserInfo getUser(UserCredentials requestingUserCredentials,
UserCredentials targetUserCredentials)
throws WebADEUserProviderException
WebADEUserProvider
getUser in interface WebADEUserProviderrequestingUserCredentials - 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.WebADEUserProvider.getUser(ca.bc.gov.webade.user.UserCredentials, ca.bc.gov.webade.user.UserCredentials)
public final GUID[] isUserInGroups(UserCredentials requestingUserCredentials,
UserCredentials targetUserCredentials,
GUID[] groupGuids)
throws WebADEUserProviderException
WebADEUserProvider
isUserInGroups in interface WebADEUserProviderrequestingUserCredentials - 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.WebADEUserProvider.isUserInGroups(
ca.bc.gov.webade.user.UserCredentials, ca.bc.gov.webade.user.UserCredentials, ca.bc.gov.webade.user.GUID[])
public final UserSearchQuery createUserSearchQuery(UserTypeCode userType)
throws WebADEUserProviderException
WebADEUserProvider
createUserSearchQuery in interface WebADEUserProvideruserType - The user type to create a query object for.
WebADEUserProviderException - Thrown if searching for the given user type is not supported.WebADEUserProvider.createUserSearchQuery(ca.bc.gov.webade.user.UserTypeCode)
public final java.util.List findUsers(UserCredentials requestingUserCredentials,
UserSearchQuery query)
throws WebADEUserProviderException
WebADEUserProvider
findUsers in interface WebADEUserProviderrequestingUserCredentials - 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.WebADEUserProvider.findUsers(ca.bc.gov.webade.user.UserCredentials,
ca.bc.gov.webade.user.search.UserSearchQuery)public final java.util.LinkedHashMap getSupportedTypesAndDomains()
public final int getTimeout()
public final java.lang.String getWebServiceUrl()
public final java.lang.String getWebServiceUsername()
public final java.lang.String toString()
Object.toString()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||