public interface AuthorizationPolicy
Modifier and Type | Method and Description |
---|---|
String |
getGroupDescription(org.jboss.errai.security.shared.api.Group group)
Get the description of an existing group.
|
Set<org.jboss.errai.security.shared.api.Group> |
getGroups()
Get the collection of groups this policy is related to.
|
String |
getHomePerspective()
Gets the identifier of the default home perspective.
|
String |
getHomePerspective(org.jboss.errai.security.shared.api.Group group)
Get the identifier of the home perspective assigned to the given group.
|
String |
getHomePerspective(org.jboss.errai.security.shared.api.Role role)
Get the identifier of the home perspective assigned to the given group.
|
String |
getHomePerspective(org.jboss.errai.security.shared.api.identity.User user)
Get the identifier of the perspective this user is redirected by default.
|
PermissionCollection |
getPermissions()
Get the default permissions.
|
PermissionCollection |
getPermissions(org.jboss.errai.security.shared.api.Group group)
Get the permissions assigned to a given group.
|
PermissionCollection |
getPermissions(org.jboss.errai.security.shared.api.Role role)
Get the permissions assigned to a given role.
|
int |
getPriority(org.jboss.errai.security.shared.api.Group group)
Get a group's priority.
|
int |
getPriority(org.jboss.errai.security.shared.api.Role role)
Get a role's priority.
|
String |
getRoleDescription(org.jboss.errai.security.shared.api.Role role)
Get the description of an existing role.
|
Set<org.jboss.errai.security.shared.api.Role> |
getRoles()
Get the collection of roles this policy is related to.
|
void |
setGroupDescription(org.jboss.errai.security.shared.api.Group group,
String description)
Sets a description for an existing group.
|
void |
setHomePerspective(org.jboss.errai.security.shared.api.Group group,
String perspectiveId)
Set the identifier of the home perspective assigned to the given group.
|
void |
setHomePerspective(org.jboss.errai.security.shared.api.Role role,
String perspectiveId)
Set the identifier of the home perspective assigned to the given role.
|
void |
setHomePerspective(String perspectiveId)
Sets the identifier of the default home perspective.
|
void |
setPermissions(org.jboss.errai.security.shared.api.Group group,
PermissionCollection permissions)
Set the group's permissions
|
void |
setPermissions(org.jboss.errai.security.shared.api.Role role,
PermissionCollection permissions)
Set the role's permissions
|
void |
setPriority(org.jboss.errai.security.shared.api.Group group,
int priority)
Set the group's priority
|
void |
setPriority(org.jboss.errai.security.shared.api.Role role,
int priority)
Set the role's priority
|
void |
setRoleDescription(org.jboss.errai.security.shared.api.Role role,
String description)
Sets a description for an existing role.
|
Set<org.jboss.errai.security.shared.api.Role> getRoles()
Set<org.jboss.errai.security.shared.api.Group> getGroups()
String getRoleDescription(org.jboss.errai.security.shared.api.Role role)
role
- The rolevoid setRoleDescription(org.jboss.errai.security.shared.api.Role role, String description)
role
- The roledescription
- A non empty descriptionString getGroupDescription(org.jboss.errai.security.shared.api.Group group)
group
- The groupvoid setGroupDescription(org.jboss.errai.security.shared.api.Group group, String description)
group
- The group identifierdescription
- A non empty descriptionint getPriority(org.jboss.errai.security.shared.api.Role role)
role
- The role instanceint getPriority(org.jboss.errai.security.shared.api.Group group)
group
- The group instancevoid setPriority(org.jboss.errai.security.shared.api.Role role, int priority)
role
- The role instancepriority
- Any valid integer. The highest, the more priority the role is.void setPriority(org.jboss.errai.security.shared.api.Group group, int priority)
group
- The group instancepriority
- Any valid integer. The highest, the more priority the role is.PermissionCollection getPermissions(org.jboss.errai.security.shared.api.Role role)
role
- The role instancevoid setPermissions(org.jboss.errai.security.shared.api.Role role, PermissionCollection permissions)
role
- The role instancepermissions
- A permission collectionPermissionCollection getPermissions(org.jboss.errai.security.shared.api.Group group)
group
- The group instancevoid setPermissions(org.jboss.errai.security.shared.api.Group group, PermissionCollection permissions)
group
- The group instancepermissions
- A permission collectionString getHomePerspective(org.jboss.errai.security.shared.api.Role role)
String getHomePerspective(org.jboss.errai.security.shared.api.Group group)
void setHomePerspective(org.jboss.errai.security.shared.api.Role role, String perspectiveId)
role
- The target role instanceperspectiveId
- An existing perspective identifiervoid setHomePerspective(org.jboss.errai.security.shared.api.Group group, String perspectiveId)
group
- The target group instanceperspectiveId
- An existing perspective identifierString getHomePerspective(org.jboss.errai.security.shared.api.identity.User user)
If the user is assigned with more than one role or group then the most priority one is taken.
getPriority(Role)
,
getPriority(Group)
String getHomePerspective()
This is the perspective that is returned for those roles/groups with no home perspective set.
void setHomePerspective(String perspectiveId)
This is the perspective that is returned for those roles/groups with no gome perspective set.
perspectiveId
- An existing perspective identifierPermissionCollection getPermissions()
These are he permissions that are returned for those roles/groups with no permissions set.
Copyright © 2012–2018 JBoss by Red Hat. All rights reserved.