b4j.core.session

Class AbstractHttpSession

java.lang.Object

b4j.core.session.AbstractAuthorizedSession

b4j.core.session.AbstractHttpSession

All Implemented Interfaces:

Configurable, Session

Direct Known Subclasses:

HttpBugzillaSession, HttpJiraSession

public abstract class AbstractHttpSession
extends AbstractAuthorizedSession

Implements an abstract HTTP session including usage with proxies.

Author:

Ralph Schuster

Constructor Summary

Constructors

Constructor and Description
AbstractHttpSession()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addCookie(HttpCookie cookie) Adds a cookie to the session.
protected void	applyCookies(HttpURLConnection con) Applies the registered cookies with this connection.
void	close() Closes the previously established Bugzilla session.
void	configure(org.apache.commons.configuration.Configuration config) Configures the session.
void	debugResponse(HttpURLConnection con) Debugs the response from a connection.
void	dump() Debugs information into log.
URL	getBaseUrl()
String	getBugzillaVersion() Returns the bugzilla version this session object is connected to.
protected HttpURLConnection	getConnection(String urlPath, String params) Makes a request to Bugzilla including eventual GET parameters.
protected HttpURLConnection	getConnection(String urlPath, String params, Map<String,String> requestProperties) Makes a request to Bugzilla including eventual GET parameters.
protected HttpURLConnection	getConnection(String urlPath, String params, Map<String,String> requestProperties, boolean isGet) Makes a request to Bugzilla including eventual GET parameters.
Iterator<HttpCookie>	getCookies() Returns all cookies from the Bugzilla session
Proxy	getProxy()
AuthorizationCallback	getProxyAuthorizationCallback()
boolean	isLoggedIn() Returns true when session is connected to Bugzilla.
protected boolean	retrieveCookies(URLConnection con) Retrieves and saves the cookies from the URL connection.
void	setBaseUrl(URL baseUrl)
protected void	setBugzillaVersion(String s) Sets the Bugzilla version connected to.
protected void	setLoggedIn(boolean loggedIn) Sets the login status.
void	setProxy(Proxy proxy)
void	setProxyAuthorizationCallback(AuthorizationCallback proxyAuthorizationCallback)

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

Methods inherited from interface b4j.core.Session

getAttachment, getIssue, getMaximumBugzillaVersion, getMinimumBugzillaVersion, open, searchBugs

Constructor Detail

AbstractHttpSession

public AbstractHttpSession()

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" and "bugzilla-home" to contain account information and HTTP URL.

A proxy can be configured by using "proxy-host" element. Use the colon to separate host and port information.

Proxy authorization is configured by element <ProxyAuthorizationCallback>. It defines the implementation class that will deliver login name and password.

Specified by:

configure in interface Configurable

Overrides:

configure in class AbstractAuthorizedSession

Parameters:

config - - configuration object

Throws:

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

close

public void close()

Closes the previously established Bugzilla session.

getBaseUrl

public URL getBaseUrl()

Returns:

the baseUrl

setBaseUrl

public void setBaseUrl(URL baseUrl)

Parameters:

baseUrl - the baseUrl to set

getProxy

public Proxy getProxy()

Returns:

the proxy

setProxy

public void setProxy(Proxy proxy)

Parameters:

proxy - the proxy to set

getProxyAuthorizationCallback

public AuthorizationCallback getProxyAuthorizationCallback()

Returns:

the proxyAuthorizationCallback

setProxyAuthorizationCallback

public void setProxyAuthorizationCallback(AuthorizationCallback proxyAuthorizationCallback)

Parameters:

proxyAuthorizationCallback - the proxyAuthorizationCallback to set

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

setBugzillaVersion

protected void setBugzillaVersion(String s)

Sets the Bugzilla version connected to.

Parameters:

s - new version

isLoggedIn

public boolean isLoggedIn()

Returns true when session is connected to Bugzilla.

Returns:

true if session was successfully established, false otherwise

setLoggedIn

protected void setLoggedIn(boolean loggedIn)

Sets the login status.

Parameters:

loggedIn - - the login status to set

getCookies

public Iterator<HttpCookie> getCookies()

Returns all cookies from the Bugzilla session

Returns:

iterator on all cookies

addCookie

protected void addCookie(HttpCookie cookie)

Adds a cookie to the session.

Parameters:

cookie - - the cookie to add

getConnection

protected HttpURLConnection getConnection(String urlPath,
                              String params)

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

Parameters:

urlPath - URL path to request

params - param string to be appended

Returns:

HTTP connection object

getConnection

protected HttpURLConnection getConnection(String urlPath,
                              String params,
                              Map<String,String> requestProperties)

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

Parameters:

urlPath - URL path to request

params - param string to be appended

requestProperties - properties of the request

Returns:

HTTP connection object

getConnection

protected HttpURLConnection getConnection(String urlPath,
                              String params,
                              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.

Parameters:

urlPath - URL path to request

params - param string to be appended

requestProperties - properties of the request

isGet - true when a GET request shall be prepared, false if this will be a POST request.

Returns:

HTTP connection object

retrieveCookies

protected boolean retrieveCookies(URLConnection con)
                           throws MalformedURLException

Retrieves and saves the cookies from the URL connection.

Parameters:

con - - the HTTP connection

Returns:

true when cookies were found, false otherwise

Throws:

MalformedURLException - - when the URL had a problem

applyCookies

protected void applyCookies(HttpURLConnection con)

Applies the registered cookies with this connection.

Parameters:

con - - HTTP connection object

debugResponse

public void debugResponse(HttpURLConnection con)

Debugs the response from a connection. All headers and the content will be dumped into the log.

Parameters:

con - - HTTP connection to dump

dump

public void dump()

Debugs information into log.

Specified by:

dump in interface Session

Overrides:

dump in class AbstractAuthorizedSession