org.wso2.carbon.dataservices.core.auth

Interface AuthorizationRoleRetriever

All Known Implementing Classes:

UserStoreAuthorizationRoleRetriever

public interface AuthorizationRoleRetriever

This is the interface which we can use to connect to third party authorisation provider in order to do role based filtering in DSS.

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"

Method Detail

getRolesForUser

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

Method used to get the roles of the user.

Parameters:

msgContext - to be used in retrieving roles.

Returns:

String array of user roles assigned to that particular user.

Throws:

DataServiceFault

getAllRoles

String[] getAllRoles()
                     throws DataServiceFault

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

Returns:

String array of all user roles.

Throws:

DataServiceFault

setProperties

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"

Parameters:

authenticatorProperties -

init

void init()
          throws DataServiceFault

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.

Throws:

DataServiceFault