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()
          Useful for I18n
 I18nBean getI18nBean(String additionalBundle)
          This method may be used to inject additional messagebundles into the I18nBean.
 Locale getLocale()
          Get the users locale.
 OutlookDate getOutlookDate()
          Method used to get a nice representation of a date using a user's locale.
 String getText(String key)
          Deprecated. Use getText() method on getI18nBean().
 User getUser()
          Returns the currently logged in User.
 void setUser(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

User getUser()
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

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

Returns:
A OutlookDate

getText

String getText(String key)
Deprecated. Use getText() method on getI18nBean().


getI18nBean

I18nBean getI18nBean()
Useful for I18n

Returns:
An instance of I18nBean

getI18nBean

I18nBean getI18nBean(String additionalBundle)
This method may be used to inject additional messagebundles into the I18nBean.

Parameters:
additionalBundle -
Returns:
An instance of I18nBean with additional message bundles.

setUser

void setUser(User user)
This comes to use in places like Jelly where we need to switch the identity of a user during execution.

Parameters:
user -


Copyright © 2002-2008 Atlassian. All Rights Reserved.