com.atlassian.jira.security
Interface JiraAuthenticationContext

All Known Implementing Classes:
JiraAuthenticationContextImpl, MockAuthenticationContext, MockSimpleAuthenticationContext

public interface JiraAuthenticationContext

The JiraAuthenticationContext is used for tracking a user's session in JIRA and all it's custom parameters, such as Locale and I18n.


Method Summary
 I18nHelper getI18nBean()
          Deprecated. Use getI18nHelper() instead. Deprecated since v4.0
 I18nHelper getI18nHelper()
          Useful for localisation of messages.
 Locale getLocale()
          Get the users locale.
 com.atlassian.crowd.embedded.api.User getLoggedInUser()
          Returns the currently logged in User.
 OutlookDate getOutlookDate()
          Deprecated. Use DateTimeFormatter instead. Since v5.0.
 String getText(String key)
          Deprecated. Use getText() method on getI18nHelper().
 com.atlassian.crowd.embedded.api.User getUser()
          Deprecated. use getLoggedInUser(). Since v4.3
 void setLoggedInUser(com.atlassian.crowd.embedded.api.User user)
          This comes to use in places like Jelly where we need to switch the identity of a user during execution.
 

Method Detail

getUser

com.atlassian.crowd.embedded.api.User getUser()
Deprecated. use getLoggedInUser(). Since v4.3

Returns the currently logged in User.

Returns:
The logged in User, or null

getLoggedInUser

com.atlassian.crowd.embedded.api.User getLoggedInUser()
Returns the currently logged in User.

Returns:
The logged in User, or null

getLocale

Locale getLocale()
Get the users locale.

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

getOutlookDate

@Deprecated
OutlookDate getOutlookDate()
Deprecated. Use DateTimeFormatter instead. Since v5.0.

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

Returns:
A OutlookDate

getText

@Deprecated
String getText(String key)
Deprecated. Use getText() method on getI18nHelper().

Parameters:
key - the text key
Returns:
the translated text

getI18nHelper

I18nHelper getI18nHelper()
Useful for localisation of messages.

Returns:
An instance of I18nHelper

getI18nBean

@Deprecated
I18nHelper getI18nBean()
Deprecated. Use getI18nHelper() instead. Deprecated since v4.0

Useful for localisation of messages.

Returns:
An instance of I18nHelper

setLoggedInUser

void setLoggedInUser(com.atlassian.crowd.embedded.api.User user)
This comes to use in places like Jelly where we need to switch the identity of a user during execution.

Parameters:
user - the currently logged in user


Copyright © 2002-2012 Atlassian. All Rights Reserved.