org.wso2.carbon.analytics.permissions

Interface PermissionProvider

All Known Implementing Classes:

DefaultPermissionProvider

public interface PermissionProvider

Permission provider interface.

Method Summary

Modifier and Type	Method and Description
void	addPermission(Permission permission) Add permission.
String	addPermissionAPI(Permission permission)
void	deletePermission(Permission permission) Delete permission.
void	deletePermission(String permissionID)
List<Role>	getGrantedRoles(Permission permission) Get list of roles which has a permission granted.
List<Role>	getGrantedRoles(String permissionID)
List<PermissionString>	getPermissionStrings(String appName)
void	grantPermission(Permission permission, Role role) Grant permission to specific role.
boolean	hasPermission(String username, Permission permission) Check whether a particular user has specific permission.
boolean	hasPermission(String username, String permissionID)
boolean	isPermissionExists(Permission permission) Check permission.
void	revokePermission(Permission permission) Revoke permission for all roles.
void	revokePermission(Permission permission, Role role) Revoke permission from specific role.
void	revokePermission(Permission permission, String roleID)
void	revokePermission(String permissionID)

Method Detail

addPermission

void addPermission(Permission permission)
            throws PermissionException

Add permission.

Parameters:

permission -

Throws:

PermissionException

addPermissionAPI

String addPermissionAPI(Permission permission)
                 throws PermissionException

Throws:

PermissionException

isPermissionExists

boolean isPermissionExists(Permission permission)
                    throws PermissionException

Check permission.

Parameters:

permission - this is the permission object with app name and permission string parameters.

Throws:

PermissionException - throws when exception occurred while executing query.

deletePermission

void deletePermission(Permission permission)
               throws PermissionException

Delete permission.

Parameters:

permission -

Throws:

PermissionException

deletePermission

void deletePermission(String permissionID)
               throws PermissionException

Throws:

PermissionException

getPermissionStrings

List<PermissionString> getPermissionStrings(String appName)

grantPermission

void grantPermission(Permission permission,
                     Role role)
              throws PermissionException

Grant permission to specific role.

Parameters:

permission -

role -

Throws:

PermissionException

revokePermission

void revokePermission(Permission permission)
               throws PermissionException

Revoke permission for all roles.

Parameters:

permission -

Throws:

PermissionException

revokePermission

void revokePermission(String permissionID)
               throws PermissionException

Throws:

PermissionException

revokePermission

void revokePermission(Permission permission,
                      Role role)
               throws PermissionException

Revoke permission from specific role.

Parameters:

permission -

role -

Throws:

PermissionException

revokePermission

void revokePermission(Permission permission,
                      String roleID)
               throws PermissionException

Throws:

PermissionException

hasPermission

boolean hasPermission(String username,
                      Permission permission)
               throws PermissionException

Check whether a particular user has specific permission.

Parameters:

username -

permission -

Returns:

Throws:

PermissionException

hasPermission

boolean hasPermission(String username,
                      String permissionID)
               throws PermissionException

Throws:

PermissionException

getGrantedRoles

List<Role> getGrantedRoles(Permission permission)
                    throws PermissionException

Get list of roles which has a permission granted.

Parameters:

permission -

Returns:

Throws:

PermissionException

getGrantedRoles

List<Role> getGrantedRoles(String permissionID)
                    throws PermissionException

Throws:

PermissionException