@PublicApi public interface

JiraServiceContext

com.atlassian.jira.bc.JiraServiceContext
Known Indirect Subclasses

@PublicApi

This interface is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

This is a context that provides information to calls to the JIRA service layer.

Summary

Public Methods
ErrorCollection getErrorCollection()
Gets an error collection.
I18nHelper getI18nBean()
Get an I18nHelper for localising text.
ApplicationUser getLoggedInApplicationUser()
Returns the User who has invoked the JIRA service method.
@Deprecated User getLoggedInUser()
This method is deprecated. since 6.1 use getLoggedInApplicationUser() instead

Public Methods

public ErrorCollection getErrorCollection ()

Gets an error collection. This should be used to report any human-readable errors that occur in a JIRA service method call.

Returns
  • errorCollection

public I18nHelper getI18nBean ()

Get an I18nHelper for localising text.

Returns
  • an I18nHelper for localising text.

public ApplicationUser getLoggedInApplicationUser ()

Returns the User who has invoked the JIRA service method.

Returns
  • user who is performing the operation (can be null).

@Deprecated public User getLoggedInUser ()

This method is deprecated.
since 6.1 use getLoggedInApplicationUser() instead

Returns the User who has invoked the JIRA service method.

Returns
  • user who is performing the operation (can be null).