b4j.core.session

Class XmlRpcJiraSession

java.lang.Object

b4j.core.session.AbstractAuthorizedSession

b4j.core.session.XmlRpcJiraSession

All Implemented Interfaces:

Configurable, Session

public class XmlRpcJiraSession
extends AbstractAuthorizedSession

Provides access to JIRA issues.

Author:

U434983

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	XmlRpcJiraSession.JiraIteratorFromFilters
protected class	XmlRpcJiraSession.JiraIteratorFromKeys

Constructor Summary

Constructors

Constructor and Description
XmlRpcJiraSession() Default constructor

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
protected Issue	createIssue(HashMap<String,Object> map) Converts the XML-RPC response for a singe JIRA issue to an object
InputStream	getAttachment(Attachment attachment) Returns an input stream that will contain the attachment's content.
URL	getBaseUrl() Returns the baseUrl.
String	getBugzillaVersion() Returns the version of JIRA connected to.
String	getCookie() Returns the XMLPRC token for JIRA session.
Issue	getIssue(String id) Returns the given issue
String	getMaximumBugzillaVersion() Returns the maximum JIRA version supported.
String	getMinimumBugzillaVersion() Returns the minimum JIRA version supported.
Proxy	getProxy() Returns the proxy.
AuthorizationCallback	getProxyAuthorizationCallback() Returns the proxyAuthorizationCallback.
String	getTeam(String userId) Returns the team of the user.
String	getUserName(String userid) Returns the name of the given user.
boolean	isLoggedIn() Returns true if connection to JIRA was established.
boolean	open() Opens the JIRA session (login).
void	registerTeamMember(String team, String member) Registers a member for a team.
Issue	requestIssue(String key) Retrieves a specific JIRA issue
protected void	retrieveComments(Issue issue) Retrieves the comments of given issue and add them as long descriptions.
protected void	retrieveIssueTypes() Retrieves all Issue Types.
protected void	retrievePriorities() Retrieves all priorities.
protected void	retrieveResolutions() Retrieves all resolutions.
protected void	retrieveStatuses() Retrieves all statuses.
Iterator<Issue>	searchBugs(SearchData searchData, SearchResultCountCallback callback) Searches for JIRA issues.
void	setBaseUrl(URL baseUrl) Sets the baseUrl.
void	setFields(Issue issue, HashMap<String,Object> map) Sets all fields in Issue according to map retrieved by JIRA's XML-RPC interface.
static String	setIssueType(Issue issue, Map<String,String> valueMap) Sets the issue type's name for the issue.
protected void	setLoggedIn(boolean loggedIn) Sets the login status.
static String	setPriority(Issue issue, Map<String,String> valueMap) Sets the priority's name for the issue.
void	setProxy(Proxy proxy) Sets the proxy.
void	setProxyAuthorizationCallback(AuthorizationCallback proxyAuthorizationCallback) Sets the proxyAuthorizationCallback.
static String	setResolution(Issue issue, Map<String,String> valueMap) Sets the resolution's name for the issue.
static String	setStatus(Issue issue, Map<String,String> valueMap) Sets the status's name for the issue.
protected void	test() A test function.

Methods inherited from class b4j.core.session.AbstractAuthorizedSession

checkBugzillaVersion, createIssue, dump, 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

Constructor Detail

XmlRpcJiraSession

public XmlRpcJiraSession()

Default constructor

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 AbstractAuthorizedSession

Parameters:

config - - configuration object

Throws:

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

registerTeamMember

public void registerTeamMember(String team,
                      String member)

Registers a member for a team.

Parameters:

team - team name

member - member name

close

public void close()

Closes the JIRA session.

See Also:

Session.close()

getBugzillaVersion

public String getBugzillaVersion()

Returns the version of JIRA connected to.

Returns:

version number or null if unknown or not connected

See Also:

Session.getBugzillaVersion()

getMaximumBugzillaVersion

public String getMaximumBugzillaVersion()

Returns the maximum JIRA version supported.

Returns:

maximum version of supported Bugzilla software.

See Also:

Session.getMaximumBugzillaVersion()

getMinimumBugzillaVersion

public String getMinimumBugzillaVersion()

Returns the minimum JIRA version supported.

Returns:

minimum version of supported Bugzilla software.

See Also:

Session.getMinimumBugzillaVersion()

setLoggedIn

protected void setLoggedIn(boolean loggedIn)

Sets the login status.

Parameters:

loggedIn - - the login status to set

isLoggedIn

public boolean isLoggedIn()

Returns true if connection to JIRA was established.

Returns:

true if session was successfully established, false otherwise

See Also:

Session.isLoggedIn()

getCookie

public String getCookie()

Returns the XMLPRC token for JIRA session.

Returns:

the token

open

public boolean open()

Opens the JIRA session (login).

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)

Searches for JIRA issues. Search data must contain either "filterID" to query existing filters, or one or more "key"s of JIRA issues to return. Additional filter criteria can be given by assigning valid values to names of issue attributes returned by JIRA.

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.

See Also:

Session.searchBugs(b4j.core.SearchData, b4j.core.SearchResultCountCallback)

test

protected void test()

A test function.

retrieveIssueTypes

protected void retrieveIssueTypes()
                           throws org.apache.xmlrpc.XmlRpcException

Retrieves all Issue Types.

Throws:

org.apache.xmlrpc.XmlRpcException

retrievePriorities

protected void retrievePriorities()
                           throws org.apache.xmlrpc.XmlRpcException

Retrieves all priorities.

Throws:

org.apache.xmlrpc.XmlRpcException

retrieveStatuses

protected void retrieveStatuses()
                         throws org.apache.xmlrpc.XmlRpcException

Retrieves all statuses.

Throws:

org.apache.xmlrpc.XmlRpcException

retrieveResolutions

protected void retrieveResolutions()
                            throws org.apache.xmlrpc.XmlRpcException

Retrieves all resolutions.

Throws:

org.apache.xmlrpc.XmlRpcException

getUserName

public String getUserName(String userid)

Returns the name of the given user. This will trigger a XML-RPC request if user was not retrieved before.

Parameters:

userid - JIRA ID of user

Returns:

name of user

getTeam

public String getTeam(String userId)

Returns the team of the user.

Parameters:

userId - id of user

Returns:

name of team

See Also:

configure(Configuration)

requestIssue

public Issue requestIssue(String key)

Retrieves a specific JIRA issue

Parameters:

key - JIRA key

Returns:

JIRA issue

retrieveComments

protected void retrieveComments(Issue issue)

Retrieves the comments of given issue and add them as long descriptions.

Parameters:

issue - the issue to retrieve comments for.

createIssue

protected Issue createIssue(HashMap<String,Object> map)

Converts the XML-RPC response for a singe JIRA issue to an object

Parameters:

map - XML-RPC response map

Returns:

JIRA issue

setFields

public void setFields(Issue issue,
             HashMap<String,Object> map)

Sets all fields in Issue according to map retrieved by JIRA's XML-RPC interface. Do not call unless you know what you do :)

Parameters:

issue - issue

map - map returned from XML-RPC interface

setPriority

public static String setPriority(Issue issue,
                 Map<String,String> valueMap)

Sets the priority's name for the issue.

Parameters:

issue - JIRA issue

valueMap - maps priority IDs to names

Returns:

the priority name

setStatus

public static String setStatus(Issue issue,
               Map<String,String> valueMap)

Sets the status's name for the issue.

Parameters:

issue - JIRA issue

valueMap - maps status IDs to names

Returns:

the status name

setResolution

public static String setResolution(Issue issue,
                   Map<String,String> valueMap)

Sets the resolution's name for the issue.

Parameters:

issue - JIRA issue

valueMap - maps resolution IDs to names

Returns:

the resolution name

setIssueType

public static String setIssueType(Issue issue,
                  Map<String,String> valueMap)

Sets the issue type's name for the issue.

Parameters:

issue - JIRA issue

valueMap - maps issue type IDs to names

Returns:

the issue type name

getBaseUrl

public URL getBaseUrl()

Returns the baseUrl.

Returns:

the baseUrl

setBaseUrl

public void setBaseUrl(URL baseUrl)

Sets the baseUrl.

Parameters:

baseUrl - the baseUrl to set

getProxy

public Proxy getProxy()

Returns the proxy.

Returns:

the proxy

setProxy

public void setProxy(Proxy proxy)

Sets the proxy.

Parameters:

proxy - the proxy to set

getProxyAuthorizationCallback

public AuthorizationCallback getProxyAuthorizationCallback()

Returns the proxyAuthorizationCallback.

Returns:

the proxyAuthorizationCallback

setProxyAuthorizationCallback

public void setProxyAuthorizationCallback(AuthorizationCallback proxyAuthorizationCallback)

Sets the proxyAuthorizationCallback.

Parameters:

proxyAuthorizationCallback - the proxyAuthorizationCallback to set