b4j.core.session

Class HttpJiraSession

java.lang.Object

b4j.core.session.AbstractAuthorizedSession

b4j.core.session.AbstractHttpSession

b4j.core.session.HttpJiraSession

All Implemented Interfaces:

Configurable, Session

public class HttpJiraSession
extends AbstractHttpSession

Author:

Ralph Schuster

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpJiraSession.JiraIssueIterator The iterator class returned.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	JIRA_FILTER
protected static String	JIRA_ISSUE
protected static String	JIRA_LOGIN
protected static String	JIRA_LOGOUT
protected static String	JIRA_MY_ISSUES
protected static String	JIRA_SEARCH

Constructor Summary

Constructors

Constructor and Description
HttpJiraSession()

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the JIRA session.
void	configure(org.apache.commons.configuration.Configuration config) Configuration allows: <jira-home>URL</jira-home> - the JIRA base URL <proxy-host> - HTTP proxy (proxy authorization not possible yet) <team name="NAME"> <Member name="FULLNAME">UID</Member> </Team> - team and member UID associations
InputStream	getAttachment(Attachment attachment) Returns an input stream that will contain the attachment's content.
protected HttpURLConnection	getConnection(String bugzillaPage) Makes a request to Bugzilla without any GET parameters.
protected HttpURLConnection	getConnection(String jiraPage, String getParams, Map<String,String> requestProperties, boolean isGet) Makes a request to Bugzilla including eventual GET parameters.
protected Map<String,String>	getDefaultRequestProperties() Returns default properties for JIRA access.
static UrlParameters	getDefaultSearchParameters() Returns default search parameters.
Issue	getIssue(String id) Returns the given issue
String	getMaximumBugzillaVersion() Returns the maximum Bugzilla version this session class supports.
String	getMinimumBugzillaVersion() Returns the minimum Bugzilla version this session class supports.
boolean	open() Opens the HTTP Session.
Iterator<Issue>	searchBugs(SearchData searchData, SearchResultCountCallback callback) Performs a search for Bugzilla bugs.

Methods inherited from class b4j.core.session.AbstractHttpSession

addCookie, applyCookies, debugResponse, dump, getBaseUrl, getBugzillaVersion, getConnection, getConnection, getCookies, getProxy, getProxyAuthorizationCallback, isLoggedIn, retrieveCookies, setBaseUrl, setBugzillaVersion, setLoggedIn, setProxy, setProxyAuthorizationCallback

Methods inherited from class b4j.core.session.AbstractAuthorizedSession

checkBugzillaVersion, createIssue, getAuthorizationCallback, getBugzillaBugClass, getLog, getLogin, getPassword, setAuthorizationCallback, setBugzillaBugClass

Methods inherited from class java.lang.Object

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

Field Detail

JIRA_LOGIN

protected static String JIRA_LOGIN

JIRA_LOGOUT

protected static String JIRA_LOGOUT

JIRA_SEARCH

protected static String JIRA_SEARCH

JIRA_MY_ISSUES

protected static String JIRA_MY_ISSUES

JIRA_FILTER

protected static String JIRA_FILTER

JIRA_ISSUE

protected static String JIRA_ISSUE

Constructor Detail

HttpJiraSession

public HttpJiraSession()

Method Detail

configure

public void configure(org.apache.commons.configuration.Configuration config)
               throws org.apache.commons.configuration.ConfigurationException

Configuration allows:
<jira-home>URL</jira-home> - the JIRA base URL
<proxy-host> - HTTP proxy (proxy authorization not possible yet)
<team name="NAME">
<Member name="FULLNAME">UID</Member>
</Team> - team and member UID associations

Specified by:

configure in interface Configurable

Overrides:

configure in class AbstractHttpSession

Parameters:

config - - configuration object

Throws:

org.apache.commons.configuration.ConfigurationException - - when configuration fails

close

public void close()

Closes the JIRA session.

Specified by:

close in interface Session

Overrides:

close in class AbstractHttpSession

See Also:

Session.close()

getMaximumBugzillaVersion

public String getMaximumBugzillaVersion()

Description copied from interface: Session

Returns the maximum Bugzilla version this session class supports. Can return null if no upper limits must be enforced.

Returns:

maximum version of supported Bugzilla software.

getMinimumBugzillaVersion

public String getMinimumBugzillaVersion()

Description copied from interface: Session

Returns the minimum Bugzilla version this session class supports. Can return null if no lower limits must be enforced.

Returns:

minimum version of supported Bugzilla software.

getDefaultRequestProperties

protected Map<String,String> getDefaultRequestProperties()

Returns default properties for JIRA access.

open

public boolean open()

Opens the HTTP Session.

Returns:

true when session could be established successfully, false otherwise

See Also:

Session.open()

getIssue

public Issue getIssue(String id)

Description copied from interface: Session

Returns the given issue

Parameters:

id - id of issue

Returns:

issue

See Also:

Session.getIssue(java.lang.String)

getAttachment

public InputStream getAttachment(Attachment attachment)
                          throws IOException

Returns an input stream that will contain the attachment's content. A calle is responsible to close the stream again.

Parameters:

attachment - attachment to retrieve.

Throws:

IOException - when the IO stream cannot be created

searchBugs

public Iterator<Issue> searchBugs(SearchData searchData,
                         SearchResultCountCallback callback)

Description copied from interface: Session

Performs a search for Bugzilla bugs. This method returns an iterator over all bug records found. Implementations should not make a query for all actual record data here as callers might not want to retrieve this data. Instead the iterator's next() function should retrieve these details.

Parameters:

searchData - - all search parameters

callback - - a callback object that will retrieve the number of bugs found for this search

Returns:

iterator on all bugs fulfilling the criteria expressed by search parameters.

getConnection

protected HttpURLConnection getConnection(String bugzillaPage)

Makes a request to Bugzilla without any GET parameters.

Parameters:

bugzillaPage - - ID of page to make the request to.

Returns:

HTTP connection object

getConnection

protected HttpURLConnection getConnection(String jiraPage,
                              String getParams,
                              Map<String,String> requestProperties,
                              boolean isGet)

Makes a request to Bugzilla including eventual GET parameters. The method applies all cookies registered previously to allow a successful session connection.

Overrides:

getConnection in class AbstractHttpSession

Parameters:

jiraPage - URL path to request

getParams - param string to be appended

requestProperties - properties of the request

isGet - true when a GET request shall be prepared, fals for a POST request

Returns:

HTTP connection object

getDefaultSearchParameters

public static UrlParameters getDefaultSearchParameters()

Returns default search parameters. DO NOT modify these defaults!

Returns:

default search parameters.