com.atlassian.jira.security
Interface JiraAuthenticationContext

All Known Implementing Classes:
JiraAuthenticationContextImpl

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
 I18nBean getI18nBean()
          Deprecated. Use getI18nHelper() instead. Deprecated since v4.0
 I18nBean getI18nBean(java.lang.String additionalBundle)
          Deprecated. Use getI18nHelper() instead. Deprecated since v4.0
 I18nHelper getI18nHelper()
          Useful for localisation of messages.
 I18nHelper getI18nHelper(java.lang.String additionalBundle)
          Deprecated. 
 java.util.Locale getLocale()
          Get the users locale.
 OutlookDate getOutlookDate()
          Method used to get a nice representation of a date using a user's locale.
 java.lang.String getText(java.lang.String key)
          Deprecated. Use getText() method on getI18nHelper().
 com.opensymphony.user.User getUser()
          Returns the currently logged in User.
 void setUser(com.opensymphony.user.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.opensymphony.user.User getUser()
Returns the currently logged in User.

Returns:
The logged in User, or null

getLocale

java.util.Locale getLocale()
Get the users locale.

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

getOutlookDate

OutlookDate getOutlookDate()
Method used to get a nice representation of a date using a user's locale.

Returns:
A OutlookDate

getText

@Deprecated
java.lang.String getText(java.lang.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
I18nBean getI18nBean()
Deprecated. Use getI18nHelper() instead. Deprecated since v4.0

Useful for localisation of messages.

Returns:
An instance of I18nHelper

getI18nHelper

@Deprecated
I18nHelper getI18nHelper(java.lang.String additionalBundle)
Deprecated. 


getI18nBean

@Deprecated
I18nBean getI18nBean(java.lang.String additionalBundle)
Deprecated. Use getI18nHelper() instead. Deprecated since v4.0

This method may be used to inject additional message bundles into the I18nHelper.

Parameters:
additionalBundle - name of a resource bundle
Returns:
An instance of I18nHelper with additional message bundles.

setUser

void setUser(com.opensymphony.user.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-2010 Atlassian. All Rights Reserved.