package com.atlassian.jira.service;
   
   import java.util.Collections;
   import java.util.Iterator;
   import java.util.List;
   
   import org.apache.log4j.Category;
   
   import com.atlassian.configurable.ObjectConfigurationException;
  import com.atlassian.jira.ComponentManager;
  import com.atlassian.jira.ManagerFactory;
  import com.atlassian.jira.exception.DataAccessException;
  import com.atlassian.jira.issue.Issue;
  import com.atlassian.jira.issue.IssueManager;
  import com.atlassian.jira.issue.IssueUtilsBean;
  import com.atlassian.jira.issue.MutableIssue;
  import com.atlassian.jira.issue.search.SearchException;
  import com.atlassian.jira.issue.search.SearchProvider;
  import com.atlassian.jira.issue.search.SearchRequest;
  import com.atlassian.jira.issue.search.SearchRequestManager;
  import com.atlassian.jira.issue.search.SearchResults;
  import com.atlassian.jira.security.JiraAuthenticationContext;
  import com.atlassian.jira.security.JiraAuthenticationContextImpl;
  import com.atlassian.jira.web.bean.PagerFilter;
  import com.opensymphony.module.propertyset.PropertySet;
  import com.opensymphony.user.EntityNotFoundException;
  import com.opensymphony.user.User;
  import com.opensymphony.user.UserManager;
  
  /**
   * FQCN : com.atlassian.jira.service.ARequestAwareService
   * @author Kaamelot
   * @since 3.10.1.34
   * @version 3.10.1.34
   * Description :
   *
   */
  public abstract class ARequestAwareService extends AbstractService implements IResquestAwareService {
  
  	private static final Category log = Category.getInstance(ARequestAwareService.class);
  	
  	// -- Service Parameters Key
  
  	protected SearchRequestManager searchRequestManager;
  
  	protected IssueManager issueManager;
  
  	protected UserManager userManager;
  
  	protected SearchProvider searchProvider;
  
  	protected JiraAuthenticationContext authenticationContext;
  
  	protected IssueUtilsBean issueUtilsBean;
  
  	// -- Service Parameters
  
  	private String requestId;
  
  	private User userSearcher;
  
  	/**
  	 * Constructor
  	 */
  	public ARequestAwareService() {
  		searchRequestManager = (SearchRequestManager) ComponentManager.getComponentInstanceOfType(SearchRequestManager.class);
  		searchProvider = (SearchProvider) ComponentManager.getComponentInstanceOfType(SearchProvider.class);
  		authenticationContext = (JiraAuthenticationContext) ComponentManager.getComponentInstanceOfType(JiraAuthenticationContext.class);
  		issueUtilsBean = (IssueUtilsBean) ComponentManager.getComponentInstanceOfType(IssueUtilsBean.class);
  		issueManager = ManagerFactory.getIssueManager();
  		userManager = UserManager.getInstance();
  	}
  
  	/**
  	 * Apply User Context and Run Service core
  	 */
  	public void run() {
  		// Remember the current user
  		User previousUser = authenticationContext.getUser();
  
  		// Execute as specified user
  		try {
  			authenticationContext.setUser(getUserSearcher());
  			JiraAuthenticationContextImpl.clearRequestCache();
  			
  			validate();
  			runService();
  
  		} catch (ServiceException e) {
  			log.error("[" + getName() + " Service] failed ...");
  			e.printStackTrace();
  		} finally {
  			// Restores the user
  			authenticationContext.setUser(previousUser);
  			JiraAuthenticationContextImpl.clearRequestCache();
  		}
  	}
  	
  	/**
 	 * @see com.atlassian.jira.service.IResquestAwareService#validate()
 	 */
 	public abstract void validate() throws ServiceException;
 
 	/**
 	 * @see com.atlassian.jira.service.IResquestAwareService#runService()
 	 */
 	public void runService() throws ServiceException {
 		log.info("[" + getName() + " Service] started ...");
 		// Retrieves Issues to scan
 		List issues = getIssues();
 		// Perform Service Task on Issues
 		runServiceOnIssues(issues);
 		log.info("[" + getName() + " Service] ended ...");
 	}
 
 	/**
 	 * @see com.atlassian.jira.service.IResquestAwareService#runServiceOnIssues(java.util.List)
 	 */
 	public void runServiceOnIssues(final List _issues) throws ServiceException {
 		log.info("[" + getName() + " Service] " + _issues.size() + " issues to scan ...");
 		// Loop on each Issue
 		for (Iterator iterator = _issues.iterator(); iterator.hasNext();) {
 			Issue issue = (Issue) iterator.next();
 			MutableIssue mIssue = issueManager.getIssueObject(issue.getId());
 			runServiceOnIssue(mIssue);
 		}
 	}	
 	
 	/**
 	 * @see com.atlassian.jira.service.IResquestAwareService#runServiceOnIssue(com.atlassian.jira.issue.MutableIssue)
 	 */
 	public abstract void runServiceOnIssue(final MutableIssue _issue) throws ServiceException;
 	
 	/**
 	 * @param _userSearcher  User used as Requester
 	 */
 	protected void setUserSearcher(final User _userSearcher) {
 		userSearcher = _userSearcher;
 	}
 
 	/**
 	 * @return User used as Requester 
 	 */
 	public User getUserSearcher() {
 		return userSearcher;
 	}
 
 	/**
 	 * Service Initialisation
 	 * @param _props Properies to use for Initialisation
 	 * @throws ObjectConfigurationException  
 	 */
 	public void init(final PropertySet _props) throws ObjectConfigurationException {
 		super.init(_props);
 		if (hasProperty(IResquestAwareService.REQUEST_KEY)) {
 			requestId = getProperty(IResquestAwareService.REQUEST_KEY);
 		}
 		if (hasProperty(IResquestAwareService.SEARCHER_KEY)) {
 			userSearcher = getDefaultSearcher(getProperty(IResquestAwareService.SEARCHER_KEY));
 		}
 	}
 
 	/**
 	 * @param _searcherName User Name provided by Service Parameters
 	 * @return Associated User
 	 */
 	protected User getDefaultSearcher(final String _searcherName) {
 		User searcherUser;
 		try {
 			searcherUser = userManager.getUser(_searcherName);
 		} catch (EntityNotFoundException e) {
 			log.error("Service configuration error: cannot find user (" + _searcherName + ").");
 			return null;
 		}
 		return searcherUser;
 	}
 
 	/**
 	 * @return A SearchRequest depending on Service Parameters
 	 */
 	public SearchRequest getSearchRequest() {
 		SearchRequest sr = null;
 		if (requestId != null && !requestId.equals("-1") && !requestId.equals("")) {
 			sr = getSearchRequest(Long.valueOf(requestId));
 		}
 		return sr;
 	}
 
 	/** 
 	 * @param filterId SearchRequest Id.
 	 * @return SearchRequest retrieved by its id. NULL if the request do not exist. 
 	 */
 	protected SearchRequest getSearchRequest(final Long filterId) {
 		try {
 			return searchRequestManager.getSearchRequest(getUserSearcher(), filterId);
 		} catch (DataAccessException e) {
 			log.error(e, e);
 		}
 		return null;
 	}
 
 	/**
 	 * Returns search results if the user is logged in and search request passed in is not null
 	 * 
 	 * @param _searchRequest Search Request
 	 * @return search results
 	 */
 	protected SearchResults getSearchResults(final SearchRequest _searchRequest) {
 		if (_searchRequest == null) {
 			return null;
 		}
 		try {
 			return searchProvider.search(_searchRequest, getUserSearcher(), PagerFilter.getUnlimitedFilter());
 		} catch (SearchException e) {
 			log.error("Could not get issues", e);
 			return null;
 		}
 	}
 
 	/**
 	 * @return List of Issues
 	 */
 	protected List getIssues() {
 		List issues;
 		SearchRequest srq = getSearchRequest();
 		SearchResults srs = getSearchResults(srq);
 		if (srs != null) {
 			issues = srs.getIssues();
 		} else {
 			issues = Collections.EMPTY_LIST;
 		}
 		return issues;
 	}
 
 }