com.atlassian.sal.core.permission

Class DefaultPermissionEnforcer

java.lang.Object

com.atlassian.sal.core.permission.DefaultPermissionEnforcer

All Implemented Interfaces:

PermissionEnforcer

public class DefaultPermissionEnforcer
extends Object
implements PermissionEnforcer

Constructor Summary

Constructors

Constructor and Description
DefaultPermissionEnforcer(UserManager userManager)

Method Summary

Modifier and Type	Method and Description
void	enforceAdmin() Verifies that the current security context has sufficient authorisation to perform administration tasks.
void	enforceAuthenticated() Verifies that the current user is authenticated.
void	enforceSystemAdmin() Verifies that the current security context has sufficient authorisation to perform system administration tasks.
boolean	isAdmin() Tests whether the current security context has sufficient authorisation to perform administration tasks.
boolean	isAuthenticated()
boolean	isSystemAdmin() Tests whether the current security context has sufficient authorisation to perform system administration tasks.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultPermissionEnforcer

public DefaultPermissionEnforcer(UserManager userManager)

Method Detail

enforceAdmin

public void enforceAdmin()
                  throws AuthorisationException

Description copied from interface: PermissionEnforcer

Verifies that the current security context has sufficient authorisation to perform administration tasks. This can either be because the user is an administrator, or because the security context is running with temporarily elevated permissions.

Specified by:

enforceAdmin in interface PermissionEnforcer

Throws:

AuthorisationException - if the current security context lacks the required authorisation

NotAuthenticatedException - if the current security context lacks the required authorisation and the current user is not authenticated

enforceAuthenticated

public void enforceAuthenticated()
                          throws AuthorisationException

Description copied from interface: PermissionEnforcer

Verifies that the current user is authenticated.

Specified by:

enforceAuthenticated in interface PermissionEnforcer

Throws:

NotAuthenticatedException - if the user is not authenticated

AuthorisationException

enforceSystemAdmin

public void enforceSystemAdmin()
                        throws AuthorisationException

Description copied from interface: PermissionEnforcer

Verifies that the current security context has sufficient authorisation to perform system administration tasks. This can either be because the user is a system administrator, or because the security context is running with temporarily elevated permissions.

Specified by:

enforceSystemAdmin in interface PermissionEnforcer

Throws:

AuthorisationException - if the current security context lacks the required authorisation

NotAuthenticatedException - if the current security context lacks the required authorisation and the current user is not authenticated

isAdmin

public boolean isAdmin()

Description copied from interface: PermissionEnforcer

Tests whether the current security context has sufficient authorisation to perform administration tasks. This can either be because the user is an administrator, or because the security context is running with temporarily elevated permissions.

Specified by:

isAdmin in interface PermissionEnforcer

Returns:

true if the current security context has sufficient authorisation to perform administration tasks, otherwise false

isAuthenticated

public boolean isAuthenticated()

Specified by:

isAuthenticated in interface PermissionEnforcer

Returns:

true if the current user is authenticated

isSystemAdmin

public boolean isSystemAdmin()

Description copied from interface: PermissionEnforcer

Tests whether the current security context has sufficient authorisation to perform system administration tasks. This can either be because the user is a system administrator, or because the security context is running with temporarily elevated permissions.

Specified by:

isSystemAdmin in interface PermissionEnforcer

Returns:

true if the current security context has sufficient authorisation to perform system administration tasks, otherwise false