de.jakop.lotus.domingo.http

Class DominoHttpClient

java.lang.Object

de.jakop.lotus.domingo.monitor.AbstractMonitorEnabled

de.jakop.lotus.domingo.http.DominoHttpClient

All Implemented Interfaces:

MonitorEnabled, Serializable

public final class DominoHttpClient
extends AbstractMonitorEnabled
implements Serializable

An Http client for communication with Lotus Domino.

Author:

Kurt Riede

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DominoHttpClient(DNotesMonitor monitor, String host, String username, String password) Constructor.

Method Summary

Modifier and Type	Method and Description
DominoGetMethod	createGetMethod(String pathInfo) Creates and returns a new Http GET method.
DominoPostMethod	createPost(String pathInfo) Creates and returns a new Http POST method.
int	executeMethod(DominoHttpMethod method) Executes the given HTTP method.
int	executeMethod(org.apache.commons.httpclient.HostConfiguration hostConfiguration, org.apache.commons.httpclient.HttpMethod method) Executes the given HTTP method using custom host configuration.
int	executeMethod(org.apache.commons.httpclient.HostConfiguration hostConfiguration, org.apache.commons.httpclient.HttpMethod method, org.apache.commons.httpclient.HttpState state) Executes the given HTTP method using the given custom host configuration with the given custom HTTP state.
String	getCanonicalUserName() Returns the name of the current user in the canonical format.
String	getCommonUserName() Returns the name of the current user in the common format.
String	getHost() Returns the host name of the server.
int	getPort() Returns the port of the server.
String	getProtocol() Returns the protocol for the connection, either http or https.
String	getUserName() Returns the current user name.
void	login() Login to the Lotus Domino server.

Methods inherited from class de.jakop.lotus.domingo.monitor.AbstractMonitorEnabled

getMonitor, setMonitor

Methods inherited from class java.lang.Object

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

Constructor Detail

DominoHttpClient

public DominoHttpClient(DNotesMonitor monitor,
                        String host,
                        String username,
                        String password)
                 throws MalformedURLException

Constructor.

Parameters:

monitor - the monitor

host - the host for the session to connect

username - the username for login

password - the password for login

Throws:

MalformedURLException - if the host is not valid

Method Detail

login

public void login()
           throws IOException

Login to the Lotus Domino server.

Throws:

IOException - if the login fails

getProtocol

public String getProtocol()

Returns the protocol for the connection, either http or https.

Returns:

protocol

getHost

public String getHost()

Returns the host name of the server.

Returns:

host name

getPort

public int getPort()

Returns the port of the server.

Returns:

port

getUserName

public String getUserName()

Returns the current user name.

Returns:

username

getCommonUserName

public String getCommonUserName()

Returns the name of the current user in the common format.

Returns:

username in common format

getCanonicalUserName

public String getCanonicalUserName()

Returns the name of the current user in the canonical format.

Returns:

username in canonical format

executeMethod

public int executeMethod(org.apache.commons.httpclient.HostConfiguration hostConfiguration,
                         org.apache.commons.httpclient.HttpMethod method,
                         org.apache.commons.httpclient.HttpState state)
                  throws IOException

Executes the given HTTP method using the given custom host configuration with the given custom HTTP state.

Parameters:

hostConfiguration - The host configuration to use. If null, the host configuration returned by HttpClient.getHostConfiguration() will be used

method - the HTTP method to execute.

state - the HTTP state to use when executing the method. If null, the state returned by HttpClient.getState() will be used.

Returns:

the method's response code

Throws:

IOException - If an I/O (transport) error occurs. Some transport exceptions can be recovered from.

executeMethod

public int executeMethod(org.apache.commons.httpclient.HostConfiguration hostConfiguration,
                         org.apache.commons.httpclient.HttpMethod method)
                  throws IOException

Executes the given HTTP method using custom host configuration.

Parameters:

hostConfiguration - The host configuration to use. If null, the host configuration returned by HttpClient.getHostConfiguration() will be used

method - the HTTP method to execute

Returns:

the method's response code

Throws:

IOException - If an I/O (transport) error occurs. Some transport exceptions can be recovered from.

executeMethod

public int executeMethod(DominoHttpMethod method)
                  throws IOException

Executes the given HTTP method.

Parameters:

method - the HTTP method to execute

Returns:

the method's response code

Throws:

IOException - If an I/O (transport) error occurs. Some transport exceptions can be recovered from.

createPost

public DominoPostMethod createPost(String pathInfo)

Creates and returns a new Http POST method.

Parameters:

pathInfo - the path on the server

Returns:

new POST method

createGetMethod

public DominoGetMethod createGetMethod(String pathInfo)

Creates and returns a new Http GET method.

Parameters:

pathInfo - the path on the server

Returns:

new GET method