Package com.atlassian.jira.plugin.webfragment

Class JiraWebContext

java.lang.Object

com.atlassian.jira.plugin.webfragment.JiraWebContext

public final class JiraWebContext
extends Object

Useful wrapper for web contexts.

Context is normally a map but it contains some standard entries which can be easily retrieved using this class.

All getters return empty if requested object is not set in the context map or has a type different than expected.

Since:

v6.5

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTEXT_KEY_HELPER
static final String	CONTEXT_KEY_I18N
static final String	CONTEXT_KEY_LOCATION
static final String	CONTEXT_KEY_USER
static final String	CONTEXT_KEY_USERNAME

Method Summary

Modifier and Type	Method	Description
static JiraWebContext	from(Map<String,Object> context)
<T> Optional<T>	get(String key, Class<T> type)	Returns value assigned to the specified key provided it is present in the map and has the specified type.
Optional<JiraHelper>	getHelper()
Optional<I18nHelper>	getI18n()
Optional<String>	getLocation()
Optional<ApplicationUser>	getUser()	Tries to figure out the user from context.
Optional<String>	getUsername()
static Map<String,Object>	makeContext(ApplicationUser remoteUser, JiraHelper jiraHelper)

Methods inherited from class java.lang.Object

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

Field Details

CONTEXT_KEY_USER

public static final String CONTEXT_KEY_USER

See Also:

• Constant Field Values

CONTEXT_KEY_USERNAME

public static final String CONTEXT_KEY_USERNAME

See Also:

• Constant Field Values

CONTEXT_KEY_HELPER

public static final String CONTEXT_KEY_HELPER

See Also:

• Constant Field Values

CONTEXT_KEY_LOCATION

public static final String CONTEXT_KEY_LOCATION

See Also:

• Constant Field Values

CONTEXT_KEY_I18N

public static final String CONTEXT_KEY_I18N

See Also:

• Constant Field Values

Method Details

from

public static JiraWebContext from(Map<String,Object> context)

makeContext

public static Map<String,Object> makeContext(ApplicationUser remoteUser,
 JiraHelper jiraHelper)

getUser

public Optional<ApplicationUser> getUser()

Tries to figure out the user from context. It checks the "user" key first and if it does not contain ApplicationUser value then tries to load the user based on the "username" key in the context.

Returns:

user in the context

getHelper

public Optional<JiraHelper> getHelper()

getI18n

public Optional<I18nHelper> getI18n()

getUsername

public Optional<String> getUsername()

getLocation

public Optional<String> getLocation()

get

public <T> Optional<T> get(String key,
 Class<T> type)

Returns value assigned to the specified key provided it is present in the map and has the specified type.

Type Parameters:

T - expected type

Parameters:

key - entry key

type - expected type

Returns:

value if present