org.wso2.carbon.dataservices.core.auth

Interface AuthorizationProvider

All Known Implementing Classes:

AbstractAuthorizationProvider, JWTAuthorizationProvider, UserStoreAuthorizationProvider

public interface AuthorizationProvider

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

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	getUsername(org.apache.axis2.context.MessageContext msgContext) Method to get username from the message context.
String[]	getUserRoles(org.apache.axis2.context.MessageContext msgContext) Method used to get the roles of the user.
void	init(Map<String,String> authorizationProps) To set the properties specific to AuthorizationProvider, and instantiate the object.

Method Detail

getUserRoles

String[] getUserRoles(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

getUsername

String getUsername(org.apache.axis2.context.MessageContext msgContext)
            throws DataServiceFault

Method to get username from the message context.

Parameters:

msgContext -

Returns:

username.

Throws:

DataServiceFault

init

void init(Map<String,String> authorizationProps)
   throws DataServiceFault

To set the properties specific to AuthorizationProvider, and instantiate the object. if no properties specified, empty map will be passed, format to specify property "admin"

Throws:

DataServiceFault