b4j.core.session

Class MySQLBugzillaSession

java.lang.Object

b4j.core.session.AbstractAuthorizedSession

b4j.core.session.MySQLBugzillaSession

All Implemented Interfaces:

Configurable, Session

public class MySQLBugzillaSession
extends AbstractAuthorizedSession

Implements Bugzilla session via direct MySQL Connection.

Author:

Ralph Schuster

Constructor Summary

Constructors

Constructor and Description
MySQLBugzillaSession() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the previously established Bugzilla session.
void	configure(org.apache.commons.configuration.Configuration config) Configures the session.
InputStream	getAttachment(Attachment attachment) Returns an input stream that will contain the attachment's content.
String	getBugzillaVersion() Returns the bugzilla version this session object is connected to.
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	isLoggedIn() Returns true when session is connected to Bugzilla.
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.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

MySQLBugzillaSession

public MySQLBugzillaSession()

Default constructor.

Method Detail

configure

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

Configures the session. The method is called to initialize the session object from a configuration. The configuration object must ensure to contain the elements "login", "password", "mysql-driver", "mysql-host", "mysql-port" and "mysql-database" to contain MySQL account information and MySQL database instance information.

Specified by:

configure in interface Configurable

Overrides:

configure in class AbstractAuthorizedSession

Parameters:

config - - configuration object

Throws:

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

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.

getBugzillaVersion

public String getBugzillaVersion()

Returns the bugzilla version this session object is connected to. Can return null if version is unknown.

Returns:

version number or null if unknown or not connected

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

isLoggedIn

public boolean isLoggedIn()

Returns true when session is connected to Bugzilla.

Returns:

true if session was successfully established, false otherwise

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)

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.