b4j.core.session

Class AbstractAuthorizedSession

java.lang.Object

b4j.core.session.AbstractAuthorizedSession

All Implemented Interfaces:

Configurable, Session

Direct Known Subclasses:

AbstractHttpSession, MySQLBugzillaSession, XmlRpcJiraSession

public abstract class AbstractAuthorizedSession
extends Object
implements Session

This is the base class for all authorization-based sessions (which usually is required for Bugzilla access, regardless what way you use). This abstract implementation takes care of login and password retrieval out of configuration definitions. Configuration usually tells what classes shall be used for callback. Each callback itself has it's own configuration methodology.

Author:

Ralph Schuster

Constructor Summary

Constructors

Constructor and Description
AbstractAuthorizedSession() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkBugzillaVersion() Checks the Bugzilla version connected to.
void	configure(org.apache.commons.configuration.Configuration config) Configures the session.
Issue	createIssue() Creates an instance of Issue.
void	dump() Debugs information into log.
AuthorizationCallback	getAuthorizationCallback() Returns the authorizationCallback.
Class<?>	getBugzillaBugClass() Returns the bugzillaBugClass.
org.slf4j.Logger	getLog() Returns the logger.
protected String	getLogin() Returns the login name as told by the callback handler.
protected String	getPassword() Returns the password as told by the callback handler.
void	setAuthorizationCallback(AuthorizationCallback authorizationCallback) Sets the authorizationCallback.
void	setBugzillaBugClass(Class<?> bugzillaBugClass) Sets the bugzillaBugClass.

Methods inherited from class java.lang.Object

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

Methods inherited from interface b4j.core.Session

close, getAttachment, getBugzillaVersion, getIssue, getMaximumBugzillaVersion, getMinimumBugzillaVersion, isLoggedIn, open, searchBugs

Constructor Detail

AbstractAuthorizedSession

public AbstractAuthorizedSession()

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. This implementation looks for an element <AuthorizationCallback>. It defines the implementation class that will deliver login name and password. If no class was given or class is "null" then the content of the tag must contain two elements <:login> and <password>.

The default Issue implementation class to be used can also be configured using the <Issue> tag, e.g.

<Issue class="b4j.core.DefaultIssue"/>

If the tag is missing or class is empty then DefaultIssue is assumed.

Specified by:

configure in interface Configurable

Parameters:

config - - configuration object

Throws:

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

getAuthorizationCallback

public AuthorizationCallback getAuthorizationCallback()

Returns the authorizationCallback.

Returns:

the authorizationCallback

setAuthorizationCallback

public void setAuthorizationCallback(AuthorizationCallback authorizationCallback)

Sets the authorizationCallback.

Parameters:

authorizationCallback - the authorizationCallback to set

getBugzillaBugClass

public Class<?> getBugzillaBugClass()

Returns the bugzillaBugClass.

Returns:

the bugzillaBugClass

setBugzillaBugClass

public void setBugzillaBugClass(Class<?> bugzillaBugClass)

Sets the bugzillaBugClass.

Parameters:

bugzillaBugClass - the bugzillaBugClass to set

createIssue

public Issue createIssue()

Creates an instance of Issue. This method returns a fresh instance of Issue. The implementation class is defined by the configuration.

Returns:

new instance of Issue

getLog

public org.slf4j.Logger getLog()

Returns the logger.

Returns:

the log

dump

public void dump()

Debugs information into log.

Specified by:

dump in interface Session

getLogin

protected String getLogin()

Returns the login name as told by the callback handler.

Returns:

login name

getPassword

protected String getPassword()

Returns the password as told by the callback handler.

Returns:

the password

checkBugzillaVersion

protected void checkBugzillaVersion()

Checks the Bugzilla version connected to. The method will throw an UnsupportedVersionException if the version does not match.