Package com.atlassian.jira.mock.security

Class MockSimpleAuthenticationContext

java.lang.Object

com.atlassian.jira.mock.security.MockSimpleAuthenticationContext

All Implemented Interfaces:

JiraAuthenticationContext

public class MockSimpleAuthenticationContext
extends Object
implements JiraAuthenticationContext

Simple authentication context that can be used for testing.

Since:

v3.13

Constructor Summary

Constructors

Constructor	Description
MockSimpleAuthenticationContext(ApplicationUser user)
MockSimpleAuthenticationContext(ApplicationUser user, Locale locale)
MockSimpleAuthenticationContext(ApplicationUser user, Locale locale, I18nHelper helper)

Method Summary

Modifier and Type	Method	Description
void	clearLoggedInUser()	Clears any logged in user from authentication scope.
static MockSimpleAuthenticationContext	createNoopContext(ApplicationUser user)
I18nHelper	getI18nHelper()	Useful for localisation of messages.
Locale	getLocale()	Get the users locale.
ApplicationUser	getLoggedInUser()	Returns the currently logged in User.
OutlookDate	getOutlookDate()	Method used to get a nice representation of a date using a user's locale.
ApplicationUser	getUser()	Returns the currently logged in User.
boolean	isLoggedInUser()	Returns a boolean indicating whether there is a currently logged in user.
MockSimpleAuthenticationContext	setLocale(Locale locale)
void	setLoggedInUser(ApplicationUser user)	This is used in places like Jelly where we need to switch the identity of a user during execution.

Methods inherited from class java.lang.Object

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

Constructor Details

MockSimpleAuthenticationContext

public MockSimpleAuthenticationContext(ApplicationUser user)

MockSimpleAuthenticationContext

public MockSimpleAuthenticationContext(ApplicationUser user,
 Locale locale)

MockSimpleAuthenticationContext

public MockSimpleAuthenticationContext(ApplicationUser user,
 Locale locale,
 @Nonnull
 I18nHelper helper)

Method Details

getLoggedInUser

public ApplicationUser getLoggedInUser()

Description copied from interface: JiraAuthenticationContext

Returns the currently logged in User.

Warning: previous incarnations of this method returned com.atlassian.crowd.embedded.api.User. This method had previously been deprecated and has been reused to return an ApplicationUser instead. That class has different semantics for Object.equals(Object) and therefore does not extend the User class. This means that the 6.0 version is not binary or source compatible with earlier versions when this method is used.

Specified by:

getLoggedInUser in interface JiraAuthenticationContext

Returns:

The logged in ApplicationUser, or null

getUser

public ApplicationUser getUser()

Description copied from interface: JiraAuthenticationContext

Returns the currently logged in User.

Warning: previous incarnations of this method returned com.atlassian.crowd.embedded.api.User. This method had previously been deprecated and has been reused to return an ApplicationUser instead. That class has different semantics for Object.equals(Object) and therefore does not extend the User class. This means that the 6.0 version is not binary or source compatible with earlier versions when this method is used.

Specified by:

getUser in interface JiraAuthenticationContext

Returns:

The logged in ApplicationUser, or null

isLoggedInUser

public boolean isLoggedInUser()

Description copied from interface: JiraAuthenticationContext

Returns a boolean indicating whether there is a currently logged in user.

Specified by:

isLoggedInUser in interface JiraAuthenticationContext

Returns:

true if there is a currently logged in user

getLocale

public Locale getLocale()

Description copied from interface: JiraAuthenticationContext

Get the users locale.

Specified by:

getLocale in interface JiraAuthenticationContext

Returns:

The user's locale, or the default system locale.

getOutlookDate

public OutlookDate getOutlookDate()

Description copied from interface: JiraAuthenticationContext

Method used to get a nice representation of a date using a user's locale.

Specified by:

getOutlookDate in interface JiraAuthenticationContext

Returns:

A OutlookDate

getI18nHelper

public I18nHelper getI18nHelper()

Description copied from interface: JiraAuthenticationContext

Useful for localisation of messages.

Specified by:

getI18nHelper in interface JiraAuthenticationContext

Returns:

An instance of I18nHelper

setLoggedInUser

public void setLoggedInUser(ApplicationUser user)

Description copied from interface: JiraAuthenticationContext

This is used in places like Jelly where we need to switch the identity of a user during execution.

Specified by:

setLoggedInUser in interface JiraAuthenticationContext

Parameters:

user - the currently logged in user

clearLoggedInUser

public void clearLoggedInUser()

Description copied from interface: JiraAuthenticationContext

Clears any logged in user from authentication scope. After this call the anonymous user is considered to be about, ie no-one is about

Specified by:

clearLoggedInUser in interface JiraAuthenticationContext

setLocale

public MockSimpleAuthenticationContext setLocale(Locale locale)

createNoopContext

public static MockSimpleAuthenticationContext createNoopContext(ApplicationUser user)