org.jboss.pull.shared.connectors.jira

Class JiraHelper

java.lang.Object

org.jboss.pull.shared.connectors.common.AbstractCommonIssueHelper

org.jboss.pull.shared.connectors.jira.JiraHelper

All Implemented Interfaces:

IssueHelper

public class JiraHelper
extends AbstractCommonIssueHelper
implements IssueHelper

Author:

navssurtani

Field Summary

Fields inherited from class org.jboss.pull.shared.connectors.common.AbstractCommonIssueHelper

fromUtil

Constructor Summary

Constructors

Constructor and Description
JiraHelper(String configurationFileProperty, String configurationFileDefault)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	accepts(URL url) A method to test if underlying implementatio accepts a given issue.n.
Issue	findIssue(URL url) Finds a given Issue based on a URL parameter.
boolean	updateStatus(URL url, Enum status) Update the status ofan Issuee.

Methods inherited from class java.lang.Object

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

Constructor Detail

JiraHelper

public JiraHelper(String configurationFileProperty,
          String configurationFileDefault)
           throws Exception

Throws:

Exception

Method Detail

findIssue

public Issue findIssue(URL url)
                throws IllegalArgumentException

Description copied from interface: IssueHelper

Finds a given Issue based on a URL parameter. Any client should make sure that IssueHelper.accepts(java.net.URL) is called first.

Specified by:

findIssue in interface IssueHelper

Parameters:

url - - the issue URL

Returns:

- the corresponding Issue or null if no Issue is found

Throws:

IllegalArgumentException - - if the String is incorrect. This will be if the remote server rejects the request.

accepts

public boolean accepts(URL url)

Description copied from interface: IssueHelper

A method to test if underlying implementatio accepts a given issue.n.

Specified by:

accepts in interface IssueHelper

Parameters:

url - - the issue URL

Returns:

- whether or not the url is accepted by the underlying issue tracking system.

updateStatus

public boolean updateStatus(URL url,
                   Enum status)

Description copied from interface: IssueHelper

Update the status ofan Issuee. Before calling this method, IssueHelper.accepts(java.net.URL) should be called

Specified by:

updateStatus in interface IssueHelper

Parameters:

url - - the issue URL

status - - the status to update to

Returns:

- whether or not the status was updated successfully.