public class

MockSimpleAuthenticationContext

extends Object
implements JiraAuthenticationContext
java.lang.Object
   ↳ com.atlassian.jira.mock.security.MockSimpleAuthenticationContext

Class Overview

Simple authentication context that can be used for testing.

Summary

Public Constructors
MockSimpleAuthenticationContext(ApplicationUser user)
MockSimpleAuthenticationContext(ApplicationUser user, Locale locale)
MockSimpleAuthenticationContext(ApplicationUser user, Locale locale, I18nHelper helper)
Public Methods
void clearLoggedInUser()
Clears any logged in user from authentication scope.
static MockSimpleAuthenticationContext createNoopContext(ApplicationUser user)
I18nHelper getI18nBean()
Useful for localisation of messages.
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.
String getText(String key)
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.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.jira.security.JiraAuthenticationContext

Public Constructors

public MockSimpleAuthenticationContext (ApplicationUser user)

public MockSimpleAuthenticationContext (ApplicationUser user, Locale locale)

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

Public Methods

public void clearLoggedInUser ()

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

public static MockSimpleAuthenticationContext createNoopContext (ApplicationUser user)

public I18nHelper getI18nBean ()

Useful for localisation of messages.

Returns

public I18nHelper getI18nHelper ()

Useful for localisation of messages.

Returns

public Locale getLocale ()

Get the users locale.

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

public ApplicationUser getLoggedInUser ()

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 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.

Returns
  • The logged in ApplicationUser, or null

public OutlookDate getOutlookDate ()

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

Returns

public String getText (String key)

public ApplicationUser getUser ()

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 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.

Returns
  • The logged in ApplicationUser, or null

public boolean isLoggedInUser ()

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

Returns
  • true if there is a currently logged in user

public MockSimpleAuthenticationContext setLocale (Locale locale)

public void setLoggedInUser (ApplicationUser user)

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

Parameters
user the currently logged in user