Package org.openiam.esb.am.service

Interface AuthProviderService

All Known Implementing Classes:

AuthProviderServiceImpl

public interface AuthProviderService

Method Summary

Modifier and Type	Method	Description
void	addProviderType(AuthProviderType entity)
void	deAuthorizeClient(String clientId, String userId)
void	deleteAuthProvider(String providerId)
List<AuthAttribute>	findAuthAttributeBeans(AuthAttributeSearchBean searchBean, int from, int size)
org.springframework.data.domain.Page<AuthProvider>	findAuthProviderBeans(AuthProviderSearchBean searchBean, int from, int size)
void	generatePublicPrivateKeyPairForSAMLIdentityProvider(String authProviderId)
OAuthScopesResponse	getAuthorizedScopes(String clientId, String userId, boolean countNumAuthorizedScopes, boolean internationalizeScopes)	Deprecated.
List<Resource>	getAuthorizedScopes(String clientId, OAuthToken token)
OAuthScopesResponse	getAuthorizedScopesRFC6749(String clientId, String userId, String requestedScopes, boolean countNumAuthorizedScopes, boolean internationalizeScopes)	Return User's Authorized scopes
AuthProviderEntity	getAuthProvider(String id)
AuthProviderType	getAuthProviderType(String providerType)
AuthProviderTypeEntity	getAuthProviderTypeForProvider(String providerId)
List<AuthProviderType>	getAuthProviderTypeList()
AuthProvider	getOAuthClient(String clientId)
OAuthCode	getOAuthCode(String code)
OAuthToken	getOAuthToken(String token)
OAuthToken	getOAuthTokenByRefreshToken(String refreshToken)
AuthProvider	getProvider(String id)
List<AuthProviderType>	getSocialAuthProviderTypeList()
String	saveAuthProvider(AuthProvider provider, String requesterId)
void	saveClientScopeAuthorization(String providerId, String userId, List<OAuthUserClientXref> oauthUserClientXrefList)
void	saveOAuthCode(OAuthCode oAuthCode)
String	saveOAuthToken(OAuthToken oAuthToken)

Method Detail

getAuthProviderType

AuthProviderType getAuthProviderType(String providerType)
                              throws BasicDataServiceException

Throws:

BasicDataServiceException

getAuthProviderTypeList

List<AuthProviderType> getAuthProviderTypeList()

getSocialAuthProviderTypeList

List<AuthProviderType> getSocialAuthProviderTypeList()

addProviderType

void addProviderType(AuthProviderType entity)
              throws BasicDataServiceException

Throws:

BasicDataServiceException

getAuthProviderTypeForProvider

AuthProviderTypeEntity getAuthProviderTypeForProvider(String providerId)

findAuthAttributeBeans

List<AuthAttribute> findAuthAttributeBeans(AuthAttributeSearchBean searchBean,
                                           int from,
                                           int size)

findAuthProviderBeans

org.springframework.data.domain.Page<AuthProvider> findAuthProviderBeans(AuthProviderSearchBean searchBean,
                                                                         int from,
                                                                         int size)

getProvider

AuthProvider getProvider(String id)

saveAuthProvider

String saveAuthProvider(AuthProvider provider,
                        String requesterId)
                 throws BasicDataServiceException

Throws:

BasicDataServiceException

deleteAuthProvider

void deleteAuthProvider(String providerId)
                 throws BasicDataServiceException

Throws:

BasicDataServiceException

getAuthProvider

AuthProviderEntity getAuthProvider(String id)

getOAuthClient

AuthProvider getOAuthClient(String clientId)

getAuthorizedScopes

List<Resource> getAuthorizedScopes(String clientId,
                                   OAuthToken token)

getAuthorizedScopes

@Deprecated(since="4.2.1.1")
OAuthScopesResponse getAuthorizedScopes(String clientId,
                                        String userId,
                                        boolean countNumAuthorizedScopes,
                                        boolean internationalizeScopes)
                                 throws BasicDataServiceException

Deprecated.

Use getAuthorizedScopesRFC6749(String, String, String, boolean, boolean) instead

Parameters:

clientId - - OAuth Client ID

userId - - Current User Id

countNumAuthorizedScopes - - Send a total number of scopes

internationalizeScopes - - Flag says should we internationalize Response (Fetch from Language Mapping)

Returns:

OAuthScopesResponse

Throws:

BasicDataServiceException - in case of problems

getAuthorizedScopesRFC6749

OAuthScopesResponse getAuthorizedScopesRFC6749(String clientId,
                                               String userId,
                                               String requestedScopes,
                                               boolean countNumAuthorizedScopes,
                                               boolean internationalizeScopes)
                                        throws BasicDataServiceException

Return User's Authorized scopes

Parameters:

clientId - - OAuth Client ID

userId - - Current User Id

requestedScopes - - The scopes requested in the Authorization Request as it is (space-separated String)

countNumAuthorizedScopes - - Send a total number of scopes

internationalizeScopes - - Flag says should we internationalize Response (Fetch from Language Mapping)

Returns:

OAuthScopesResponse

Throws:

BasicDataServiceException - in case of problems

saveClientScopeAuthorization

void saveClientScopeAuthorization(String providerId,
                                  String userId,
                                  List<OAuthUserClientXref> oauthUserClientXrefList)
                           throws BasicDataServiceException

Throws:

BasicDataServiceException

saveOAuthCode

void saveOAuthCode(OAuthCode oAuthCode)

getOAuthCode

OAuthCode getOAuthCode(String code)

getOAuthToken

OAuthToken getOAuthToken(String token)

getOAuthTokenByRefreshToken

OAuthToken getOAuthTokenByRefreshToken(String refreshToken)

saveOAuthToken

String saveOAuthToken(OAuthToken oAuthToken)
               throws BasicDataServiceException

Throws:

BasicDataServiceException

deAuthorizeClient

void deAuthorizeClient(String clientId,
                       String userId)

generatePublicPrivateKeyPairForSAMLIdentityProvider

void generatePublicPrivateKeyPairForSAMLIdentityProvider(String authProviderId)