org.wso2.carbon.analytics.idp.client.external

Class ExternalIdPClient

java.lang.Object

org.wso2.carbon.analytics.idp.client.external.ExternalIdPClient

All Implemented Interfaces:

IdPClient

public class ExternalIdPClient
extends Object
implements IdPClient

Implementation class for external IdP based on OAuth2 and SCIM2.

Constructor Summary

Constructors

Constructor and Description
ExternalIdPClient(String baseUrl, String authorizeEndpoint, String grantType, String signinAlgo, String adminRoleDisplayName, Map<String,OAuthApplicationInfo> oAuthAppInfoMap, int cacheTimeout, OAuthAppDAO oAuthAppDAO, DCRMServiceStub dcrmServiceStub, OAuth2ServiceStubs oAuth2ServiceStubs, SCIM2ServiceStub scimServiceStub, String defaultUserStore, boolean isSSOEnabled, String ssoLogoutURL, String scope, String jwksUrl)
ExternalIdPClient(String baseUrl, String authorizeEndpoint, String grantType, String signinAlgo, String adminRoleDisplayName, Map<String,OAuthApplicationInfo> oAuthAppInfoMap, int cacheTimeout, OAuthAppDAO oAuthAppDAO, DCRMServiceStub dcrmServiceStub, OAuth2ServiceStubs oAuth2ServiceStubs, SCIM2ServiceStub scimServiceStub, String defaultUserStore, boolean isSSOEnabled, String ssoLogoutURL, String scope, String jwksUrl, boolean isFilteredGroupsEnabled)

Method Summary

Modifier and Type	Method and Description
Map<String,String>	authCodeLogin(String appContext, String code)
Map<String,String>	authCodeLogin(String appContext, String code, Map<String,String> properties)
String	authenticate(String token) This will authenticate user based on the token.
Role	getAdminRole() This returns the admin role of the user store.
List<Role>	getAllRoles() This returns all roles available in the user store.
List<Role>	getAllRolesOfTenant(String username) This returns all the roles available in the user store for the given tenant.
User	getUser(String name) This returns the {User} object with the name passed in the parameter.
List<Role>	getUserRoles(String name) This returns a list of the roles assigned to the user.
void	init(String kmUserName)
Map<String,String>	login(Map<String,String> properties) This returns the login parameters of a login request.
Map<String,String>	logout(Map<String,String> properties) This invalidates the user session.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExternalIdPClient

public ExternalIdPClient(String baseUrl,
                         String authorizeEndpoint,
                         String grantType,
                         String signinAlgo,
                         String adminRoleDisplayName,
                         Map<String,OAuthApplicationInfo> oAuthAppInfoMap,
                         int cacheTimeout,
                         OAuthAppDAO oAuthAppDAO,
                         DCRMServiceStub dcrmServiceStub,
                         OAuth2ServiceStubs oAuth2ServiceStubs,
                         SCIM2ServiceStub scimServiceStub,
                         String defaultUserStore,
                         boolean isSSOEnabled,
                         String ssoLogoutURL,
                         String scope,
                         String jwksUrl)

ExternalIdPClient

public ExternalIdPClient(String baseUrl,
                         String authorizeEndpoint,
                         String grantType,
                         String signinAlgo,
                         String adminRoleDisplayName,
                         Map<String,OAuthApplicationInfo> oAuthAppInfoMap,
                         int cacheTimeout,
                         OAuthAppDAO oAuthAppDAO,
                         DCRMServiceStub dcrmServiceStub,
                         OAuth2ServiceStubs oAuth2ServiceStubs,
                         SCIM2ServiceStub scimServiceStub,
                         String defaultUserStore,
                         boolean isSSOEnabled,
                         String ssoLogoutURL,
                         String scope,
                         String jwksUrl,
                         boolean isFilteredGroupsEnabled)

Method Detail

init

public void init(String kmUserName)
          throws IdPClientException

Throws:

IdPClientException

getAllRoles

public List<Role> getAllRoles()
                       throws IdPClientException

Description copied from interface: IdPClient

This returns all roles available in the user store.

Specified by:

getAllRoles in interface IdPClient

Returns:

List of {Role} objects

Throws:

IdPClientException - thrown when an error occurred when retrieving roles

getAllRolesOfTenant

public List<Role> getAllRolesOfTenant(String username)
                               throws IdPClientException

Description copied from interface: IdPClient

This returns all the roles available in the user store for the given tenant.

Specified by:

getAllRolesOfTenant in interface IdPClient

Parameters:

username - name of the user

Returns:

List of {Role} objects

Throws:

IdPClientException - thrown when an error occurred when retrieving roles

getAdminRole

public Role getAdminRole()
                  throws IdPClientException

Description copied from interface: IdPClient

This returns the admin role of the user store.

Specified by:

getAdminRole in interface IdPClient

Returns:

{Role}

Throws:

IdPClientException - thrown when an error occurred when retrieving admin role

getUser

public User getUser(String name)
             throws IdPClientException

Description copied from interface: IdPClient

This returns the {User} object with the name passed in the parameter.

Specified by:

getUser in interface IdPClient

Parameters:

name - Username

Returns:

{User}

Throws:

IdPClientException - thrown when an error occurred when retrieving user

getUserRoles

public List<Role> getUserRoles(String name)
                        throws IdPClientException

Description copied from interface: IdPClient

This returns a list of the roles assigned to the user.

Specified by:

getUserRoles in interface IdPClient

Parameters:

name - username

Returns:

List of {Role}

Throws:

IdPClientException - thrown when an error occurred when retrieving user role

login

public Map<String,String> login(Map<String,String> properties)
                         throws IdPClientException

Description copied from interface: IdPClient

This returns the login parameters of a login request.

Specified by:

login in interface IdPClient

Parameters:

properties - Map of properties that is needed for login

Returns:

Map of login properties such as Status, Access Token, Refresh Token, Expiry time

Throws:

IdPClientException - thrown when an error occurred when login

authCodeLogin

public Map<String,String> authCodeLogin(String appContext,
                                        String code)
                                 throws IdPClientException

Throws:

IdPClientException

authCodeLogin

public Map<String,String> authCodeLogin(String appContext,
                                        String code,
                                        Map<String,String> properties)
                                 throws IdPClientException

Throws:

IdPClientException

logout

public Map<String,String> logout(Map<String,String> properties)
                          throws IdPClientException

Description copied from interface: IdPClient

This invalidates the user session.

Specified by:

logout in interface IdPClient

Parameters:

properties - Map of logout properties.

Returns:

properties Map of logout properties such as Redirect_URI

Throws:

IdPClientException - thrown when an error occurred when logout

authenticate

public String authenticate(String token)
                    throws AuthenticationException,
                           IdPClientException

Description copied from interface: IdPClient

This will authenticate user based on the token.

Specified by:

authenticate in interface IdPClient

Parameters:

token - token used to identify user session.

Returns:

username if authentication is success

Throws:

AuthenticationException - thrown when authentication fails

IdPClientException - thrown when an error occurred when authenticating