com.atlassian.jira.service
Class ARequestAwareService

java.lang.Object
  com.atlassian.jira.service.AbstractService
      com.atlassian.jira.service.ARequestAwareService

All Implemented Interfaces:

com.atlassian.configurable.ObjectConfigurable, IResquestAwareService, com.atlassian.jira.service.JiraService

Direct Known Subclasses:

AutoTransitionService, IssueExportService

public abstract class ARequestAwareService
extends com.atlassian.jira.service.AbstractService
implements IResquestAwareService

FQCN : com.atlassian.jira.service.ARequestAwareService

Since:

3.10.1.34

Version:

3.10.1.34 Description :

Author:

Kaamelot

Field Summary

protected com.atlassian.jira.security.JiraAuthenticationContext	authenticationContext
protected com.atlassian.jira.issue.IssueManager	issueManager
protected com.atlassian.jira.issue.IssueUtilsBean	issueUtilsBean
protected com.atlassian.jira.issue.search.SearchProvider	searchProvider
protected com.atlassian.jira.issue.search.SearchRequestManager	searchRequestManager
protected com.opensymphony.user.UserManager	userManager

Fields inherited from class com.atlassian.jira.service.AbstractService

name

Fields inherited from interface com.atlassian.jira.service.IResquestAwareService

REQUEST_KEY, SEARCHER_KEY

Fields inherited from interface com.atlassian.jira.service.JiraService

NAME_COMPARATOR

Constructor Summary

ARequestAwareService()
Constructor

Method Summary

protected com.opensymphony.user.User	getDefaultSearcher(java.lang.String _searcherName)
protected java.util.List	getIssues()
com.atlassian.jira.issue.search.SearchRequest	getSearchRequest()
protected com.atlassian.jira.issue.search.SearchRequest	getSearchRequest(java.lang.Long filterId)
protected com.atlassian.jira.issue.search.SearchResults	getSearchResults(com.atlassian.jira.issue.search.SearchRequest _searchRequest) Returns search results if the user is logged in and search request passed in is not null
com.opensymphony.user.User	getUserSearcher()
void	init(com.opensymphony.module.propertyset.PropertySet _props) Service Initialisation
void	run() Apply User Context and Run Service core
void	runService() Core of the Service
abstract void	runServiceOnIssue(com.atlassian.jira.issue.MutableIssue _issue)
void	runServiceOnIssues(java.util.List _issues)
protected void	setUserSearcher(com.opensymphony.user.User _userSearcher)
abstract void	validate() Performs Validation before running the Service

Methods inherited from class com.atlassian.jira.service.AbstractService

destroy, getDefaultProperty, getDescription, getKey, getLongProperty, getName, getObjectConfiguration, getProperties, getProperty, getTextProperty, hasProperty, isInternal, isUnique, setName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.atlassian.configurable.ObjectConfigurable

getObjectConfiguration

Field Detail

searchRequestManager

protected com.atlassian.jira.issue.search.SearchRequestManager searchRequestManager

issueManager

protected com.atlassian.jira.issue.IssueManager issueManager

userManager

protected com.opensymphony.user.UserManager userManager

searchProvider

protected com.atlassian.jira.issue.search.SearchProvider searchProvider

authenticationContext

protected com.atlassian.jira.security.JiraAuthenticationContext authenticationContext

issueUtilsBean

protected com.atlassian.jira.issue.IssueUtilsBean issueUtilsBean

Constructor Detail

ARequestAwareService

public ARequestAwareService()

Constructor

Method Detail

run

public void run()

Apply User Context and Run Service core

Specified by:

run in interface com.atlassian.jira.service.JiraService

Specified by:

run in class com.atlassian.jira.service.AbstractService

validate

public abstract void validate()
                       throws com.atlassian.jira.service.ServiceException

Description copied from interface: IResquestAwareService

Performs Validation before running the Service

Specified by:

validate in interface IResquestAwareService

Throws:

ServiceException

See Also:

IResquestAwareService.validate()

runService

public void runService()
                throws com.atlassian.jira.service.ServiceException

Description copied from interface: IResquestAwareService

Core of the Service

Specified by:

runService in interface IResquestAwareService

Throws:

ServiceException

See Also:

IResquestAwareService.runService()

runServiceOnIssues

public void runServiceOnIssues(java.util.List _issues)
                        throws com.atlassian.jira.service.ServiceException

Specified by:

runServiceOnIssues in interface IResquestAwareService

Parameters:

_issues - List of Issue concerned by the Services

Throws:

ServiceException

See Also:

IResquestAwareService.runServiceOnIssues(java.util.List)

runServiceOnIssue

public abstract void runServiceOnIssue(com.atlassian.jira.issue.MutableIssue _issue)
                                throws com.atlassian.jira.service.ServiceException

Specified by:

runServiceOnIssue in interface IResquestAwareService

Parameters:

_issue - Issue on which the Service has to perform something !

Throws:

ServiceException

See Also:

IResquestAwareService.runServiceOnIssue(com.atlassian.jira.issue.MutableIssue)

setUserSearcher

protected void setUserSearcher(com.opensymphony.user.User _userSearcher)

Parameters:

_userSearcher - User used as Requester

getUserSearcher

public com.opensymphony.user.User getUserSearcher()

Returns:

User used as Requester

init

public void init(com.opensymphony.module.propertyset.PropertySet _props)
          throws com.atlassian.configurable.ObjectConfigurationException

Service Initialisation

Specified by:

init in interface com.atlassian.jira.service.JiraService

Overrides:

init in class com.atlassian.jira.service.AbstractService

Parameters:

_props - Properies to use for Initialisation

Throws:

com.atlassian.configurable.ObjectConfigurationException

getDefaultSearcher

protected com.opensymphony.user.User getDefaultSearcher(java.lang.String _searcherName)

Parameters:

_searcherName - User Name provided by Service Parameters

Returns:

Associated User

getSearchRequest

public com.atlassian.jira.issue.search.SearchRequest getSearchRequest()

Returns:

A SearchRequest depending on Service Parameters

getSearchRequest

protected com.atlassian.jira.issue.search.SearchRequest getSearchRequest(java.lang.Long filterId)

Parameters:

filterId - SearchRequest Id.

Returns:

SearchRequest retrieved by its id. NULL if the request do not exist.

getSearchResults

protected com.atlassian.jira.issue.search.SearchResults getSearchResults(com.atlassian.jira.issue.search.SearchRequest _searchRequest)

Returns search results if the user is logged in and search request passed in is not null

Parameters:

_searchRequest - Search Request

Returns:

search results

getIssues

protected java.util.List getIssues()

Returns:

List of Issues