Package com.atlassian.jira.security

Interface JiraAuthenticationContext

All Known Implementing Classes:
BootstrapJiraAuthenticationContext, JiraAuthenticationContextImpl, MockAuthenticationContext, MockSimpleAuthenticationContext
@PublicApi 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 Details

    • getUser

      @Deprecated @IncompatibleReturnType(since="6.0", was="com.atlassian.crowd.embedded.api.User") ApplicationUser getUser()
      Deprecated.
      Use getLoggedInUser(). Since v7.0
      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.

      Returns:
      The logged in ApplicationUser, or null

    • getLoggedInUser

      @IncompatibleReturnType(since="7.0", was="com.atlassian.crowd.embedded.api.User") 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 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.

      Returns:
      The logged in ApplicationUser, or null

    • isLoggedInUser

      boolean isLoggedInUser()
      Returns a boolean indicating whether there is a currently logged in user.
      Returns:
      true if there is a currently logged in user
      Since:
      v5.0.4

    • 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

    • getI18nHelper

      @Nonnull I18nHelper getI18nHelper()
      Useful for localisation of messages.
      Returns:
      An instance of I18nHelper

    • setLoggedInUser

      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

    • clearLoggedInUser

      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