org.wso2.carbon.analytics.idp.client.local

Class LocalIdPClient

java.lang.Object

org.wso2.carbon.analytics.idp.client.local.LocalIdPClient

All Implemented Interfaces:

IdPClient

public class LocalIdPClient
extends Object
implements IdPClient

Local IdP Client.

Constructor Summary

Constructors

Constructor and Description
LocalIdPClient(int sessionTimeOut, int refreshTimeout, List<LocalUser> users, List<Role> roles, Role adminRole)

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalIdPClient

public LocalIdPClient(int sessionTimeOut,
                      int refreshTimeout,
                      List<LocalUser> users,
                      List<Role> roles,
                      Role adminRole)

Method Detail

getAllRoles

public List<Role> getAllRoles()

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

getAdminRole

public Role getAdminRole()

Description copied from interface: IdPClient

This returns the admin role of the user store.

Specified by:

getAdminRole in interface IdPClient

Returns:

{Role}

getUser

public User getUser(String name)

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}

getUserRoles

public List<Role> getUserRoles(String name)

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}

login

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

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

logout

public void logout(Map<String,String> properties)

Description copied from interface: IdPClient

This invalidates the user session.

Specified by:

logout in interface IdPClient

Parameters:

properties - Map of logout properties.

authenticate

public String authenticate(String token)
                    throws AuthenticationException

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