com.dtolabs.client.utils

Class WebserviceHttpClientFactory

java.lang.Object

com.dtolabs.client.utils.WebserviceHttpClientFactory

public abstract class WebserviceHttpClientFactory
extends java.lang.Object

WebserviceHttpClientFactory creates instances of WebserviceHttpClient. The default implementation of WebserviceHttpClientFactory can be obtained by the getInstance() method. A different implementation can be installed at runtime by the setInstance(WebserviceHttpClientFactory) method, and that instance will be returned by getInstance() .
Once a factory is obtained, the getWebserviceHttpClient(String, String, String, String, java.util.Map) getWebserviceHttpClient} method will return a WebserviceHttpClient instance.

Constructor Summary

Constructors

Constructor and Description
WebserviceHttpClientFactory()

Method Summary

Methods

Modifier and Type	Method and Description
static WebserviceHttpClientFactory	getInstance() Get the Factory instance.
abstract WebserviceHttpClient	getWebserviceHttpClient(java.lang.String urlSpec, java.lang.String basePath, java.lang.String username, java.lang.String password, java.util.Map query) Get a WebserviceHttpClient from the parameters.
abstract WebserviceHttpClient	getWebserviceHttpClient(java.lang.String urlSpec, java.lang.String basePath, java.lang.String username, java.lang.String password, java.util.Map query, java.io.File uploadFile, java.lang.String fileparam) Get a WebserviceHttpClient from the parameters.
abstract WebserviceHttpClient	getWebserviceHttpClient(java.lang.String urlSpec, java.lang.String basePath, java.lang.String username, java.lang.String password, java.util.Map query, java.io.File uploadFile, java.lang.String fileparam, java.io.OutputStream destination, java.lang.String expectedContentType) Get a WebserviceHttpClient from the parameters.
abstract WebserviceHttpClient	getWebserviceHttpClient(java.lang.String urlSpec, java.lang.String basePath, java.lang.String username, java.lang.String password, java.util.Map query, java.util.Map<java.lang.String,? extends java.lang.Object> formData) Get a WebserviceHttpClient from the parameters.
abstract WebserviceHttpClient	getWebserviceHttpClient(java.lang.String urlSpec, java.lang.String basePath, java.lang.String username, java.lang.String password, java.util.Map query, java.io.OutputStream destination, java.lang.String expectedContentType) Get a WebserviceHttpClient from the parameters.
static void	setInstance(WebserviceHttpClientFactory factory) Set the factory instance to use.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebserviceHttpClientFactory

public WebserviceHttpClientFactory()

Method Detail

getInstance

public static WebserviceHttpClientFactory getInstance()

Get the Factory instance.

Returns:

instance of the Factory

setInstance

public static void setInstance(WebserviceHttpClientFactory factory)

Set the factory instance to use. Default factory is used if not set.

Parameters:

factory - the factory

getWebserviceHttpClient

public abstract WebserviceHttpClient getWebserviceHttpClient(java.lang.String urlSpec,
                                           java.lang.String basePath,
                                           java.lang.String username,
                                           java.lang.String password,
                                           java.util.Map query)

Get a WebserviceHttpClient from the parameters.

Parameters:

urlSpec - URL to request

basePath - base context path on the server for the Webservice application

username - username to user

password - password to use

query - query parameters to add to the request

Returns:

WebserviceHttpClient instance

getWebserviceHttpClient

public abstract WebserviceHttpClient getWebserviceHttpClient(java.lang.String urlSpec,
                                           java.lang.String basePath,
                                           java.lang.String username,
                                           java.lang.String password,
                                           java.util.Map query,
                                           java.io.File uploadFile,
                                           java.lang.String fileparam)

Get a WebserviceHttpClient from the parameters.

Parameters:

urlSpec - URL to request

basePath - base context path on the server for the Webservice application

username - username to user

password - password to use

query - query parameters to add to the request

uploadFile - file to upload

fileparam - name of the file upload parameter

Returns:

WebserviceHttpClient instance

getWebserviceHttpClient

public abstract WebserviceHttpClient getWebserviceHttpClient(java.lang.String urlSpec,
                                           java.lang.String basePath,
                                           java.lang.String username,
                                           java.lang.String password,
                                           java.util.Map query,
                                           java.io.File uploadFile,
                                           java.lang.String fileparam,
                                           java.io.OutputStream destination,
                                           java.lang.String expectedContentType)

Get a WebserviceHttpClient from the parameters.

Parameters:

urlSpec - URL to request

basePath - base context path on the server for the Webservice application

username - username to user

password - password to use

query - query parameters to add to the request

uploadFile - file to upload

fileparam - name of the file upload parameter

destination - an OutputStream to which to write the result data

expectedContentType - the content type expected. if the type does not match, no data is written to the outputstream. if null, any type is allowed.

Returns:

WebserviceHttpClient instance

getWebserviceHttpClient

public abstract WebserviceHttpClient getWebserviceHttpClient(java.lang.String urlSpec,
                                           java.lang.String basePath,
                                           java.lang.String username,
                                           java.lang.String password,
                                           java.util.Map query,
                                           java.io.OutputStream destination,
                                           java.lang.String expectedContentType)

Get a WebserviceHttpClient from the parameters.

Parameters:

urlSpec - URL to request

basePath - base context path on the server for the Webservice application

username - username to user

password - password to use

query - query parameters to add to the request

destination - an OutputStream to which to write the result data

expectedContentType - the content type expected. if the type does not match, no data is written to the outputstream. if null, any type is allowed.

Returns:

WebserviceHttpClient instance

getWebserviceHttpClient

public abstract WebserviceHttpClient getWebserviceHttpClient(java.lang.String urlSpec,
                                           java.lang.String basePath,
                                           java.lang.String username,
                                           java.lang.String password,
                                           java.util.Map query,
                                           java.util.Map<java.lang.String,? extends java.lang.Object> formData)

Get a WebserviceHttpClient from the parameters.

Parameters:

urlSpec - URL to request

basePath - base context path on the server for the Webservice application

username - username to user

password - password to use

query - query parameters to add to the request

formData - form data

Returns:

WebserviceHttpClient instance