org.wso2.carbon.analytics.idp.client.core.api

Interface IdPClient

All Known Implementing Classes:

ExternalIdPClient, LocalIdPClient

public interface IdPClient

This interface can be used to access common functionality of the IdpClient. This can be used by the dependent component without the need to know about the underlying IdPClient implementation.

Method Summary

Modifier and Type	Method and Description
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.
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.
Map<String,String>	login(Map<String,String> properties) This returns the login parameters of a login request.
void	logout(Map<String,String> properties) This invalidates the user session.

Method Detail

getAllRoles

List<Role> getAllRoles()
                throws IdPClientException

This returns all roles available in the user store.

Returns:

List of {Role} objects

Throws:

IdPClientException - thrown when an error occurred when retrieving roles

getAdminRole

Role getAdminRole()
           throws IdPClientException

This returns the admin role of the user store.

Returns:

{Role}

Throws:

IdPClientException - thrown when an error occurred when retrieving admin role

getUser

User getUser(String name)
      throws IdPClientException

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

Parameters:

name - Username

Returns:

{User}

Throws:

IdPClientException - thrown when an error occurred when retrieving user

getUserRoles

List<Role> getUserRoles(String name)
                 throws IdPClientException

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

Parameters:

name - username

Returns:

List of {Role}

Throws:

IdPClientException - thrown when an error occurred when retrieving user role

login

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

This returns the login parameters of a login request.

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

logout

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

This invalidates the user session.

Parameters:

properties - Map of logout properties.

Throws:

IdPClientException - thrown when an error occurred when logout

authenticate

String authenticate(String token)
             throws AuthenticationException,
                    IdPClientException

This will authenticate user based on the token.

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