Package com.sun.identity.federation.accountmgmt

Interface FSUserProvider

All Known Implementing Classes:

DefaultFSUserProvider

public interface FSUserProvider

Interface used to search federation user.

Method Summary

Modifier and Type	Method	Description
String	getUserID(String orgDN, Map avPairs, Map env)	Searches user.
void	init(String hostedProviderId)	Initializes the provider.

Method Detail

init

void init(String hostedProviderId)
   throws FSAccountMgmtException

Initializes the provider.

Parameters:

hostedProviderId - provider id of hosted provider

Throws:

FSAccountMgmtException - if an error occured during initialization.

getUserID

String getUserID(String orgDN,
                 Map avPairs,
                 Map env)
          throws FSAccountMgmtException

Searches user.

Parameters:

orgDN - The organization to search the user.

avPairs - Attribute value pairs that will be used for searching the user.

env - Extra parameters that can be used for user mapping. The followings are possible key-value pair of the Map: Used for federation termination: key: IFSConstants.FS_USER_PROVIDER_ENV_TERMINATION_KEY value: FSFederationTerminationNotification object; Used for federation/sso with POST and LECP profile: key: IFSConstants.FS_USER_PROVIDER_ENV_AUTHNRESPONSE_KEY value: FSAuthnResponse object; Used for single logout: key: IFSConstants.FS_USER_PROVIDER_ENV_LOGOUT_KEY value: FSLogoutNotification object; Used for name registration: key: IFSConstants.FS_USER_PROVIDER_ENV_REGISTRATION_KEY value: FSNameRegistrationRequest object; Used for federation/sso with artifact profile: key: IFSConstants.FS_USER_PROVIDER_ENV_FSRESPONSE_KEY value: FSResponse object. key: IFSConstants.FS_USER_PROVIDER_ENV_NAMEMAPPING_KEY value: FSNameIdentifierMappingRequest

Throws:

FSAccountMgmtException - if an error occured.