Package com.almworks.jira.structure.api.auth

Class StructureAuth

Object

StructureAuth

public class StructureAuth
extends Object

This class manages the current authentication context assumed when accessing, managing and updating Structure entities such as Structure or StructureView.

The context is local to the current thread.

By default, the context equals to JIRA's authentication context. It is possible to specify another user or disable security checks; see sudo(ApplicationUser, boolean, CallableE)) and sudo(CallableE).

Constructor Summary

Constructors

Constructor	Description
StructureAuth()

Method Summary

Modifier and Type	Method	Description
static AuthContext	currentContext()
static ApplicationUser	getUser()	Returns the current user.
static String	getUserKey()	Returns user key of the current user.
static boolean	isSecurityOverridden()	Returns true if permission checks shouldn't be carried out in this context.
static <R, E extends Exception> R	sudo(CallableE<R,E> f)	Execute actions with Structure under the current JIRA user with all security checks disabled.
static <R, E extends Exception> R	sudo(ApplicationUser user, boolean overrideSecurity, CallableE<R,E> f)	Execute actions with Structure under a different authentication context - as another user, and/or with all security checks disabled.

Methods inherited from class Object

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

Constructor Details

StructureAuth

public StructureAuth()

Method Details

getUser

@Nullable
public static ApplicationUser getUser()

Returns the current user. If the user is not authenticated, i.e. the context is anonymous, returns null. "Override security" setting does not influence this method.

Returns:

the current user

getUserKey

@Nullable
public static String getUserKey()

Returns user key of the current user. If the user is not authenticated, i.e. the context is anonymous, returns null. "Override security" setting does not influence this method.

Returns:

key of the current user

isSecurityOverridden

public static boolean isSecurityOverridden()

Returns true if permission checks shouldn't be carried out in this context.

sudo

public static <R,
E extends Exception> R sudo(@Nullable
 ApplicationUser user,
 boolean overrideSecurity,
 CallableE<R,E> f)
                                      throws E

Execute actions with Structure under a different authentication context - as another user, and/or with all security checks disabled. If you only need to override security while keeping user context intact, you can use a shorthand override

Parameters:

user - the user, can be null to represent anonymous

overrideSecurity - if true, user access level will not be checked for f

f - the code to execute, this method will return the computed value. Can throw StructureAuth, it will be propagated.

Throws:

E extends Exception

sudo

public static <R,
E extends Exception> R sudo(CallableE<R,E> f)
                                      throws E

Execute actions with Structure under the current JIRA user with all security checks disabled.

Parameters:

f - the code to execute, this method will return the computed value. Can throw StructureAuth, it will be propagated.

Throws:

E extends Exception

currentContext

public static AuthContext currentContext()