org.wso2.carbon.dataservices.core.auth

Class UserStoreAuthorizationRoleRetriever

java.lang.Object

org.wso2.carbon.dataservices.core.auth.UserStoreAuthorizationRoleRetriever

All Implemented Interfaces:

AuthorizationRoleRetriever

public class UserStoreAuthorizationRoleRetriever
extends Object
implements AuthorizationRoleRetriever

Implementation class for role retrieval for role based content filtering.

Constructor Summary

Constructors

Constructor and Description
UserStoreAuthorizationRoleRetriever()

Method Summary

Methods

Modifier and Type	Method and Description
String[]	getAllRoles() Method used to get all the user roles in order to display in data service design phase.
String[]	getRolesForUser(org.apache.axis2.context.MessageContext msgContext) Method used to get the roles of the user.
void	init() This method will be invoked after instantiating the class, So operation which needs to be carried out with specified properties needs to be done in this method.
void	setProperties(Map<String,String> authenticatorProperties) To set the properties specific to role retriever, if no properties specified, empty map will be passed format to specify property "admin"

Methods inherited from class java.lang.Object

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

Constructor Detail

UserStoreAuthorizationRoleRetriever

public UserStoreAuthorizationRoleRetriever()

Method Detail

getRolesForUser

public String[] getRolesForUser(org.apache.axis2.context.MessageContext msgContext)
                         throws DataServiceFault

Description copied from interface: AuthorizationRoleRetriever

Method used to get the roles of the user.

Specified by:

getRolesForUser in interface AuthorizationRoleRetriever

Parameters:

msgContext - to be used in retrieving roles.

Returns:

String array of user roles assigned to that particular user.

Throws:

DataServiceFault

getAllRoles

public String[] getAllRoles()
                     throws DataServiceFault

Description copied from interface: AuthorizationRoleRetriever

Method used to get all the user roles in order to display in data service design phase.

Specified by:

getAllRoles in interface AuthorizationRoleRetriever

Returns:

String array of all user roles.

Throws:

DataServiceFault

setProperties

public void setProperties(Map<String,String> authenticatorProperties)

Description copied from interface: AuthorizationRoleRetriever

To set the properties specific to role retriever, if no properties specified, empty map will be passed format to specify property "admin"

Specified by:

setProperties in interface AuthorizationRoleRetriever

init

public void init()
          throws DataServiceFault

Description copied from interface: AuthorizationRoleRetriever

This method will be invoked after instantiating the class, So operation which needs to be carried out with specified properties needs to be done in this method.

Specified by:

init in interface AuthorizationRoleRetriever

Throws:

DataServiceFault