public abstract class AAAContext extends Object
| Constructor and Description |
|---|
AAAContext() |
| Modifier and Type | Method and Description |
|---|---|
abstract boolean |
allowSuperUser() |
Iterable<String> |
allPermissionNames()
Returns name of all
permissions |
Iterable<Permission> |
allPermissions()
Returns all
permissions |
Iterable<String> |
allPrivilegeNames()
Returns name of all
privileges |
Iterable<Privilege> |
allPrivileges()
Returns all
privileges |
Iterable<String> |
allRoleNames()
Returns name of all
roles |
Iterable<Role> |
allRoles()
Returns all
roles |
Privilege |
findPrivilege(int level)
Get a
Privilege by level |
protected Anonymous |
getAnonymousPrincipal()
Returns an anonymous principal in case current principal is not provided and the system principal is not allowed.
|
abstract Auditor |
getAuditor()
Returns the
Auditor implementation |
abstract AuthenticationService |
getAuthenticationService()
Returns the
AuthenticationService implementation |
abstract AuthorizationService |
getAuthorizationService()
Returns the
AuthorizationService implementation |
abstract Principal |
getCurrentPrincipal()
Returns a principal that initiate the current session
|
abstract Object |
getGuardedTarget()
Get the guarded target object set previously via
setGuardedTarget(Object) call |
abstract AAAPersistentService |
getPersistentService()
Returns the
AAAPersistentService implementation |
Principal |
getPrincipal(boolean allowSystem)
Returns a principal.
|
abstract int |
getSuperUserLevel() |
abstract Principal |
getSystemPrincipal()
Returns the system principal which is used by system to set up security context for background tasks
|
boolean |
hasPermission(Enum<?> permissionEnum) |
boolean |
hasPermission(Enum<?> permissionEnum,
boolean allowSystem) |
boolean |
hasPermission(Object guardedResource,
Enum<?> permissionEnum) |
boolean |
hasPermission(Object guardedResource,
Enum<?> permissionEnum,
boolean allowSystem) |
boolean |
hasPermission(Object guardedResource,
Permission permission) |
boolean |
hasPermission(Object guardedResource,
Permission permission,
boolean allowSystem) |
boolean |
hasPermission(Object guardedResource,
String permissionName) |
boolean |
hasPermission(Object guardedResource,
String permissionName,
boolean allowSystem) |
boolean |
hasPermission(Permission permission) |
boolean |
hasPermission(Permission permissionName,
boolean allowSystem) |
boolean |
hasPermission(Principal principal,
Enum<?> permissionEnum) |
boolean |
hasPermission(Principal principal,
Object guardedResource,
Enum<?> permissionEnum) |
boolean |
hasPermission(Principal principal,
Object guardedResource,
String permissionName) |
boolean |
hasPermission(Principal principal,
Permission permission) |
boolean |
hasPermission(Principal principal,
String permissionName) |
boolean |
hasPermission(String permissionName) |
boolean |
hasPermission(String permissionName,
boolean allowSystem) |
boolean |
hasPermissionOrPrivilege(Enum<?> permissionEnum,
Enum<?> privilegeEnum) |
boolean |
hasPermissionOrPrivilege(Enum<?> permissionEnum,
Enum<?> privilegeEnum,
boolean allowSystem) |
boolean |
hasPermissionOrPrivilege(Enum<?> permissionEnum,
int privilegeLevel) |
boolean |
hasPermissionOrPrivilege(Enum<?> permissionEnum,
int privilegeLevel,
boolean allowSystem) |
boolean |
hasPermissionOrPrivilege(Object guardedResource,
Enum<?> permissionEnum,
Enum<?> privilegeEnum) |
boolean |
hasPermissionOrPrivilege(Object guardedResource,
Enum<?> permissionEnum,
Enum<?> privilegeEnum,
boolean allowSystem) |
boolean |
hasPermissionOrPrivilege(Object guardedResource,
Enum<?> permissionEnum,
int privilegeLevel) |
boolean |
hasPermissionOrPrivilege(Object guardedResource,
Enum<?> permissionEnum,
int privilegeLevel,
boolean allowSystem) |
boolean |
hasPermissionOrPrivilege(Object GuardedResource,
Permission permission,
Privilege privilege) |
boolean |
hasPermissionOrPrivilege(Object GuardedResource,
Permission permission,
Privilege privilege,
boolean allowSystem) |
boolean |
hasPermissionOrPrivilege(Object guardedResource,
String permissionName,
int privilegeLevel) |
boolean |
hasPermissionOrPrivilege(Object guardedResource,
String permissionName,
int privilegeLevel,
boolean allowSystem) |
boolean |
hasPermissionOrPrivilege(Object guardedResource,
String permissionName,
String privilegeName) |
boolean |
hasPermissionOrPrivilege(Object guardedResource,
String permissionName,
String privilegeName,
boolean allowSystem) |
boolean |
hasPermissionOrPrivilege(Permission permission,
Privilege privilege) |
boolean |
hasPermissionOrPrivilege(Permission permission,
Privilege privilege,
boolean allowSystem) |
boolean |
hasPermissionOrPrivilege(String permissionName,
int privilegeLevel) |
boolean |
hasPermissionOrPrivilege(String permissionName,
int privilegeLevel,
boolean allowSystem) |
boolean |
hasPermissionOrPrivilege(String permissionName,
String privilegeName) |
boolean |
hasPermissionOrPrivilege(String permissionName,
String privilegeName,
boolean allowSystem) |
boolean |
hasPrivilege(Enum<?> privilegeEnum) |
boolean |
hasPrivilege(Enum<?> privilegeEnum,
boolean allowSystem) |
boolean |
hasPrivilege(int privilegeLevel) |
boolean |
hasPrivilege(int privilegeLevel,
boolean allowSystem) |
boolean |
hasPrivilege(Principal principal,
Enum<?> privilegeEnum) |
boolean |
hasPrivilege(Principal principal,
int privilegeLevel) |
boolean |
hasPrivilege(Principal principal,
Privilege privilege) |
boolean |
hasPrivilege(Principal principal,
String privilegeName) |
boolean |
hasPrivilege(Privilege privilege) |
boolean |
hasPrivilege(Privilege privilege,
boolean allowSystem) |
boolean |
hasPrivilege(String privilegeName) |
boolean |
hasPrivilege(String privilegeName,
boolean allowSystem) |
abstract boolean |
isSuperUser(Principal principal) |
void |
requirePermission(Enum<?> permissionEnum) |
void |
requirePermission(Enum<?> permissionEnum,
boolean allowSystem) |
void |
requirePermission(Object guardedResource,
Enum<?> permissionEnum) |
void |
requirePermission(Object guardedResource,
Enum<?> permissionEnum,
boolean allowSystem) |
void |
requirePermission(Object guardedResource,
Permission permission) |
void |
requirePermission(Object guardedResource,
Permission permission,
boolean allowSystem) |
void |
requirePermission(Object guardedResource,
String permissionName) |
void |
requirePermission(Object guardedResource,
String permissionName,
boolean allowSystem) |
void |
requirePermission(Permission permission) |
void |
requirePermission(Permission permissionName,
boolean allowSystem) |
void |
requirePermission(Principal principal,
Enum<?> permissionEnum) |
void |
requirePermission(Principal principal,
Object guardedResource,
Enum<?> permissionEnum) |
void |
requirePermission(Principal principal,
Object guardedResource,
String permissionName) |
void |
requirePermission(Principal principal,
Permission permission) |
void |
requirePermission(Principal principal,
String permissionName) |
void |
requirePermission(String permissionName) |
void |
requirePermission(String permissionName,
boolean allowSystem) |
void |
requirePermissionOrPrivilege(Enum<?> permissionEnum,
Enum<?> privilegeEnum) |
void |
requirePermissionOrPrivilege(Enum<?> permissionEnum,
Enum<?> privilegeEnum,
boolean allowSystem) |
void |
requirePermissionOrPrivilege(Enum<?> permissionEnum,
int privilegeLevel) |
void |
requirePermissionOrPrivilege(Enum<?> permissionEnum,
int privilegeLevel,
boolean allowSystem) |
void |
requirePermissionOrPrivilege(Object guardedResource,
Enum<?> permissionEnum,
Enum<?> privilegeEnum) |
void |
requirePermissionOrPrivilege(Object guardedResource,
Enum<?> permissionEnum,
Enum<?> privilegeEnum,
boolean allowSystem) |
void |
requirePermissionOrPrivilege(Object guardedResource,
Enum<?> permissionEnum,
int privilegeLevel) |
void |
requirePermissionOrPrivilege(Object guardedResource,
Enum<?> permissionEnum,
int privilegeLevel,
boolean allowSystem) |
void |
requirePermissionOrPrivilege(Object GuardedResource,
Permission permission,
Privilege privilege) |
void |
requirePermissionOrPrivilege(Object GuardedResource,
Permission permission,
Privilege privilege,
boolean allowSystem) |
void |
requirePermissionOrPrivilege(Object guardedResource,
String permissionName,
int privilegeLevel) |
void |
requirePermissionOrPrivilege(Object guardedResource,
String permissionName,
int privilegeLevel,
boolean allowSystem) |
void |
requirePermissionOrPrivilege(Object guardedResource,
String permissionName,
String privilegeName) |
void |
requirePermissionOrPrivilege(Object guardedResource,
String permissionName,
String privilegeName,
boolean allowSystem) |
void |
requirePermissionOrPrivilege(Permission permission,
Privilege privilege) |
void |
requirePermissionOrPrivilege(Permission permission,
Privilege privilege,
boolean allowSystem) |
void |
requirePermissionOrPrivilege(String permissionName,
int privilegeLevel) |
void |
requirePermissionOrPrivilege(String permissionName,
int privilegeLevel,
boolean allowSystem) |
void |
requirePermissionOrPrivilege(String permissionName,
String privilegeName) |
void |
requirePermissionOrPrivilege(String permissionName,
String privilegeName,
boolean allowSystem) |
void |
requirePrivilege(Enum<?> privilegeEnum) |
void |
requirePrivilege(Enum<?> privilegeEnum,
boolean allowSystem) |
void |
requirePrivilege(int privilegeLevel) |
void |
requirePrivilege(int privilegeLevel,
boolean allowSystem) |
void |
requirePrivilege(Principal principal,
Enum<?> privilegeEnum) |
void |
requirePrivilege(Principal principal,
int privilegeLevel) |
void |
requirePrivilege(Principal principal,
Privilege privilege) |
void |
requirePrivilege(Principal principal,
String privilegeName) |
void |
requirePrivilege(Privilege privilege) |
void |
requirePrivilege(Privilege privilege,
boolean allowSystem) |
void |
requirePrivilege(String privilegeName) |
void |
requirePrivilege(String privilegeName,
boolean allowSystem) |
abstract void |
setCurrentPrincipal(Principal user)
Set the current principal to a thread local variable.
|
abstract Object |
setGuardedTarget(Object target)
Store a guarded target object to a thread local variable.
|
public abstract AuthenticationService getAuthenticationService()
Returns the AuthenticationService implementation
public abstract AuthorizationService getAuthorizationService()
Returns the AuthorizationService implementation
public abstract AAAPersistentService getPersistentService()
Returns the AAAPersistentService implementation
public abstract Auditor getAuditor()
Returns the Auditor implementation
public abstract Principal getSystemPrincipal()
Returns the system principal which is used by system to set up security context for background tasks
protected Anonymous getAnonymousPrincipal()
Returns an anonymous principal in case current principal is not provided and the system principal is not allowed.
This method returns Anonymous.INSTANCE. However sub class might choose the override this method so it could return anonymous with different ID, e.g. IP address
public abstract int getSuperUserLevel()
public abstract boolean allowSuperUser()
public abstract boolean isSuperUser(Principal principal)
public abstract void setCurrentPrincipal(Principal user)
Set the current principal to a thread local variable. If the principal specified is null then the thread local variable should be removed
user - the pricipalpublic abstract Principal getCurrentPrincipal()
Returns a principal that initiate the current session
public Principal getPrincipal(boolean allowSystem)
Returns a principal. The logic is
current principal is set, then return itallowSystem parameter is true, then tried to return getSystemPrincipal() if it is not null, or else getAnonymousPrincipal() allowSystem - if system principal is allowedpublic abstract Object setGuardedTarget(Object target)
Store a guarded target object to a thread local variable. If target specified is null, then the thread local variable should be removed
target - the guarded objectpublic abstract Object getGuardedTarget()
Get the guarded target object set previously via setGuardedTarget(Object) call
public Privilege findPrivilege(int level)
Get a Privilege by level
level - the privilege levelpublic Iterable<Privilege> allPrivileges()
Returns all privileges
Iterablepublic Iterable<Permission> allPermissions()
Returns all permissions
Iterablepublic Iterable<String> allPrivilegeNames()
Returns name of all privileges
Iterablepublic Iterable<String> allPermissionNames()
Returns name of all permissions
Iterablepublic Iterable<String> allRoleNames()
Returns name of all roles
Iterablepublic boolean hasPermission(Permission permission) throws org.osgl.exception.AccessDeniedException
org.osgl.exception.AccessDeniedExceptionpublic boolean hasPermission(String permissionName) throws org.osgl.exception.AccessDeniedException
org.osgl.exception.AccessDeniedExceptionpublic boolean hasPermission(Enum<?> permissionEnum) throws org.osgl.exception.AccessDeniedException
org.osgl.exception.AccessDeniedExceptionpublic boolean hasPermission(Permission permissionName, boolean allowSystem) throws org.osgl.exception.AccessDeniedException
org.osgl.exception.AccessDeniedExceptionpublic boolean hasPermission(String permissionName, boolean allowSystem) throws org.osgl.exception.AccessDeniedException
org.osgl.exception.AccessDeniedExceptionpublic boolean hasPermission(Enum<?> permissionEnum, boolean allowSystem) throws org.osgl.exception.AccessDeniedException
org.osgl.exception.AccessDeniedExceptionpublic boolean hasPermission(Object guardedResource, Permission permission) throws org.osgl.exception.AccessDeniedException
org.osgl.exception.AccessDeniedExceptionpublic boolean hasPermission(Object guardedResource, String permissionName) throws org.osgl.exception.AccessDeniedException
org.osgl.exception.AccessDeniedExceptionpublic boolean hasPermission(Object guardedResource, Enum<?> permissionEnum) throws org.osgl.exception.AccessDeniedException
org.osgl.exception.AccessDeniedExceptionpublic boolean hasPermission(Object guardedResource, Permission permission, boolean allowSystem)
public boolean hasPermission(Object guardedResource, String permissionName, boolean allowSystem)
public boolean hasPermission(Object guardedResource, Enum<?> permissionEnum, boolean allowSystem)
public boolean hasPermission(Principal principal, Permission permission) throws org.osgl.exception.AccessDeniedException
org.osgl.exception.AccessDeniedExceptionpublic boolean hasPermission(Principal principal, String permissionName) throws org.osgl.exception.AccessDeniedException
org.osgl.exception.AccessDeniedExceptionpublic boolean hasPermission(Principal principal, Enum<?> permissionEnum) throws org.osgl.exception.AccessDeniedException
org.osgl.exception.AccessDeniedExceptionpublic boolean hasPermission(Principal principal, Object guardedResource, String permissionName) throws org.osgl.exception.AccessDeniedException
org.osgl.exception.AccessDeniedExceptionpublic boolean hasPermission(Principal principal, Object guardedResource, Enum<?> permissionEnum) throws org.osgl.exception.AccessDeniedException
org.osgl.exception.AccessDeniedExceptionpublic void requirePermission(Permission permission) throws org.osgl.exception.AccessDeniedException
org.osgl.exception.AccessDeniedExceptionpublic void requirePermission(String permissionName) throws org.osgl.exception.AccessDeniedException
org.osgl.exception.AccessDeniedExceptionpublic void requirePermission(Enum<?> permissionEnum) throws org.osgl.exception.AccessDeniedException
org.osgl.exception.AccessDeniedExceptionpublic void requirePermission(Permission permissionName, boolean allowSystem) throws org.osgl.exception.AccessDeniedException
org.osgl.exception.AccessDeniedExceptionpublic void requirePermission(String permissionName, boolean allowSystem) throws org.osgl.exception.AccessDeniedException
org.osgl.exception.AccessDeniedExceptionpublic void requirePermission(Enum<?> permissionEnum, boolean allowSystem) throws org.osgl.exception.AccessDeniedException
org.osgl.exception.AccessDeniedExceptionpublic void requirePermission(Object guardedResource, Permission permission) throws org.osgl.exception.AccessDeniedException
org.osgl.exception.AccessDeniedExceptionpublic void requirePermission(Object guardedResource, String permissionName) throws org.osgl.exception.AccessDeniedException
org.osgl.exception.AccessDeniedExceptionpublic void requirePermission(Object guardedResource, Enum<?> permissionEnum) throws org.osgl.exception.AccessDeniedException
org.osgl.exception.AccessDeniedExceptionpublic void requirePermission(Object guardedResource, Permission permission, boolean allowSystem)
public void requirePermission(Object guardedResource, String permissionName, boolean allowSystem)
public void requirePermission(Object guardedResource, Enum<?> permissionEnum, boolean allowSystem)
public void requirePermission(Principal principal, Permission permission) throws org.osgl.exception.AccessDeniedException
org.osgl.exception.AccessDeniedExceptionpublic void requirePermission(Principal principal, String permissionName) throws org.osgl.exception.AccessDeniedException
org.osgl.exception.AccessDeniedExceptionpublic void requirePermission(Principal principal, Enum<?> permissionEnum) throws org.osgl.exception.AccessDeniedException
org.osgl.exception.AccessDeniedExceptionpublic void requirePermission(Principal principal, Object guardedResource, String permissionName) throws org.osgl.exception.AccessDeniedException
org.osgl.exception.AccessDeniedExceptionpublic void requirePermission(Principal principal, Object guardedResource, Enum<?> permissionEnum) throws org.osgl.exception.AccessDeniedException
org.osgl.exception.AccessDeniedExceptionpublic boolean hasPrivilege(Privilege privilege)
public boolean hasPrivilege(String privilegeName)
public boolean hasPrivilege(Enum<?> privilegeEnum)
public boolean hasPrivilege(int privilegeLevel)
public boolean hasPrivilege(Principal principal, int privilegeLevel)
public boolean hasPrivilege(Privilege privilege, boolean allowSystem)
public boolean hasPrivilege(String privilegeName, boolean allowSystem)
public boolean hasPrivilege(Enum<?> privilegeEnum, boolean allowSystem)
public boolean hasPrivilege(int privilegeLevel,
boolean allowSystem)
public void requirePrivilege(Privilege privilege)
public void requirePrivilege(String privilegeName)
public void requirePrivilege(Enum<?> privilegeEnum)
public void requirePrivilege(int privilegeLevel)
public void requirePrivilege(Principal principal, int privilegeLevel)
public void requirePrivilege(Privilege privilege, boolean allowSystem)
public void requirePrivilege(String privilegeName, boolean allowSystem)
public void requirePrivilege(Enum<?> privilegeEnum, boolean allowSystem)
public void requirePrivilege(int privilegeLevel,
boolean allowSystem)
public boolean hasPermissionOrPrivilege(Permission permission, Privilege privilege)
public boolean hasPermissionOrPrivilege(String permissionName, String privilegeName)
public boolean hasPermissionOrPrivilege(String permissionName, int privilegeLevel)
public boolean hasPermissionOrPrivilege(Enum<?> permissionEnum, Enum<?> privilegeEnum)
public boolean hasPermissionOrPrivilege(Enum<?> permissionEnum, int privilegeLevel)
public boolean hasPermissionOrPrivilege(Permission permission, Privilege privilege, boolean allowSystem)
public boolean hasPermissionOrPrivilege(String permissionName, String privilegeName, boolean allowSystem)
public boolean hasPermissionOrPrivilege(String permissionName, int privilegeLevel, boolean allowSystem)
public boolean hasPermissionOrPrivilege(Enum<?> permissionEnum, Enum<?> privilegeEnum, boolean allowSystem)
public boolean hasPermissionOrPrivilege(Enum<?> permissionEnum, int privilegeLevel, boolean allowSystem)
public boolean hasPermissionOrPrivilege(Object GuardedResource, Permission permission, Privilege privilege)
public boolean hasPermissionOrPrivilege(Object guardedResource, String permissionName, String privilegeName)
public boolean hasPermissionOrPrivilege(Object guardedResource, String permissionName, int privilegeLevel)
public boolean hasPermissionOrPrivilege(Object guardedResource, Enum<?> permissionEnum, Enum<?> privilegeEnum)
public boolean hasPermissionOrPrivilege(Object guardedResource, Enum<?> permissionEnum, int privilegeLevel)
public boolean hasPermissionOrPrivilege(Object GuardedResource, Permission permission, Privilege privilege, boolean allowSystem)
public boolean hasPermissionOrPrivilege(Object guardedResource, String permissionName, String privilegeName, boolean allowSystem)
public boolean hasPermissionOrPrivilege(Object guardedResource, String permissionName, int privilegeLevel, boolean allowSystem)
public boolean hasPermissionOrPrivilege(Object guardedResource, Enum<?> permissionEnum, Enum<?> privilegeEnum, boolean allowSystem)
public boolean hasPermissionOrPrivilege(Object guardedResource, Enum<?> permissionEnum, int privilegeLevel, boolean allowSystem)
public void requirePermissionOrPrivilege(Permission permission, Privilege privilege)
public void requirePermissionOrPrivilege(String permissionName, String privilegeName)
public void requirePermissionOrPrivilege(String permissionName, int privilegeLevel)
public void requirePermissionOrPrivilege(Enum<?> permissionEnum, Enum<?> privilegeEnum)
public void requirePermissionOrPrivilege(Enum<?> permissionEnum, int privilegeLevel)
public void requirePermissionOrPrivilege(Permission permission, Privilege privilege, boolean allowSystem)
public void requirePermissionOrPrivilege(String permissionName, String privilegeName, boolean allowSystem)
public void requirePermissionOrPrivilege(String permissionName, int privilegeLevel, boolean allowSystem)
public void requirePermissionOrPrivilege(Enum<?> permissionEnum, Enum<?> privilegeEnum, boolean allowSystem)
public void requirePermissionOrPrivilege(Enum<?> permissionEnum, int privilegeLevel, boolean allowSystem)
public void requirePermissionOrPrivilege(Object GuardedResource, Permission permission, Privilege privilege)
public void requirePermissionOrPrivilege(Object guardedResource, String permissionName, String privilegeName)
public void requirePermissionOrPrivilege(Object guardedResource, String permissionName, int privilegeLevel)
public void requirePermissionOrPrivilege(Object guardedResource, Enum<?> permissionEnum, Enum<?> privilegeEnum)
public void requirePermissionOrPrivilege(Object guardedResource, Enum<?> permissionEnum, int privilegeLevel)
public void requirePermissionOrPrivilege(Object GuardedResource, Permission permission, Privilege privilege, boolean allowSystem)
public void requirePermissionOrPrivilege(Object guardedResource, String permissionName, String privilegeName, boolean allowSystem)
public void requirePermissionOrPrivilege(Object guardedResource, String permissionName, int privilegeLevel, boolean allowSystem)
public void requirePermissionOrPrivilege(Object guardedResource, Enum<?> permissionEnum, Enum<?> privilegeEnum, boolean allowSystem)
Copyright © 2017–2020 OSGL (Open Source General Library). All rights reserved.