b4j.core.session

Class HttpBugzillaSession

java.lang.Object

b4j.core.session.AbstractAuthorizedSession

b4j.core.session.AbstractHttpSession

b4j.core.session.HttpBugzillaSession

All Implemented Interfaces:

Configurable, Session

public class HttpBugzillaSession
extends AbstractHttpSession

Implements Bugzilla access via HTTP. Use this session object when you cannot access Bugzilla directly per JDBC. This implementation does not implement access via proxy yet.

Author:

Ralph Schuster

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	HttpBugzillaSession.BugzillaBugIterator Implementation of a bug iterator.
protected class	HttpBugzillaSession.XmlParser Does the actual meat by parsing the XML response.

Field Summary

Fields

Modifier and Type	Field and Description
static int	BUGZILLA_GET_ATTACHMENT Constant for requesting URL connection to get attachment content
static int	BUGZILLA_LOGIN Constant for requesting URL connection to login page
static int	BUGZILLA_LOGOUT Constant for requesting URL connection to logout page
static int	BUGZILLA_SEARCH Constant for requesting URL connection to search result page
static int	BUGZILLA_SHOW_BUG Constant for requesting URL connection to show bug page
protected static String[]	PAGES The URL paths to the Bugzilla pages

Constructor Summary

Constructors

Constructor and Description
HttpBugzillaSession() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the previously established Bugzilla session.
InputStream	getAttachment(Attachment attachment) Returns an input stream that will contain the attachment's content.
protected HttpURLConnection	getConnection(int bugzillaPage) Makes a request to Bugzilla without any GET parameters.
protected HttpURLConnection	getConnection(int bugzillaPage, String getParams) Makes a request to Bugzilla including eventual GET parameters.
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 session with configured Bugzilla instance.
Iterator<Issue>	searchBugs(SearchData searchData, SearchResultCountCallback callback) Performs a search for Bugzilla bugs.

Methods inherited from class b4j.core.session.AbstractHttpSession

addCookie, applyCookies, configure, debugResponse, dump, getBaseUrl, getBugzillaVersion, getConnection, 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

BUGZILLA_LOGIN

public static final int BUGZILLA_LOGIN

Constant for requesting URL connection to login page

See Also:

Constant Field Values

BUGZILLA_SEARCH

public static final int BUGZILLA_SEARCH

Constant for requesting URL connection to search result page

See Also:

Constant Field Values

BUGZILLA_LOGOUT

public static final int BUGZILLA_LOGOUT

Constant for requesting URL connection to logout page

See Also:

Constant Field Values

BUGZILLA_SHOW_BUG

public static final int BUGZILLA_SHOW_BUG

Constant for requesting URL connection to show bug page

See Also:

Constant Field Values

BUGZILLA_GET_ATTACHMENT

public static final int BUGZILLA_GET_ATTACHMENT

Constant for requesting URL connection to get attachment content

See Also:

Constant Field Values

PAGES

protected static final String[] PAGES

The URL paths to the Bugzilla pages

Constructor Detail

HttpBugzillaSession

public HttpBugzillaSession()

Default constructor.

Method Detail

getMinimumBugzillaVersion

public String getMinimumBugzillaVersion()

Returns the minimum Bugzilla version this session class supports.

Returns:

minimum version of supported Bugzilla software.

See Also:

MINIMUM_BUGZILLA_VERSION

getMaximumBugzillaVersion

public String getMaximumBugzillaVersion()

Returns the maximum Bugzilla version this session class supports.

Returns:

maximum version of supported Bugzilla software.

See Also:

MAXIMUM_BUGZILLA_VERSION

open

public boolean open()

Opens the session with configured Bugzilla instance.

Returns:

true when session could be established successfully, false otherwise

close

public void close()

Closes the previously established Bugzilla session.

Specified by:

close in interface Session

Overrides:

close in class AbstractHttpSession

getIssue

public Issue getIssue(String id)

Returns the given issue

Parameters:

id - id of issue

Returns:

issue

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)

Performs a search for Bugzilla bugs. This method returns an iterator over all bug records found. The returned iterator will query its data when the first call to its Iterator.next() method is made. A separate thread will then be spawned to retrieve the required 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(int 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(int bugzillaPage,
                              String getParams)

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

Parameters:

bugzillaPage - - ID of page to make the request to

Returns:

HTTP connection object

getDefaultSearchParameters

public static UrlParameters getDefaultSearchParameters()

Returns default search parameters. DO NOT modify these defaults!

Returns:

default search parameters.