org.xins.client

Class XINSCallConfig

java.lang.Object

org.xins.common.service.CallConfig

org.xins.client.XINSCallConfig

All Implemented Interfaces:

Serializable

public final class XINSCallConfig
extends CallConfig

Call configuration for the XINS service caller. The HTTP method can be configured. By default it is set to POST.

This class is not thread safe

Since:

XINS 1.1.0

Version:

$Revision: 1.28 $ $Date: 2013/01/05 10:19:26 $

Author:

Ernst de Haan, Anthony Goubard

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
XINSCallConfig() Constructs a new XINSCallConfig object.

Method Summary

Methods

Modifier and Type	Method and Description
String	describe() Describes this configuration.
boolean	getFollowRedirect() Returns the action performed when a redirect is returned from the server.
HttpClient	getHttpClient() Gets the HttpClient to use to call the URL.
HTTPMethod	getHTTPMethod() Returns the HTTP method associated with this configuration.
void	setFollowRedirect(boolean follow) Sets the action to perform if a redirect is returned from the server.
void	setHttpClient(HttpClient httpClient) Sets the HttpClient to use to call the URL.
void	setHTTPMethod(HTTPMethod method) Sets the HTTP method associated with this configuration.

Methods inherited from class org.xins.common.service.CallConfig

isFailOverAllowed, setFailOverAllowed, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

XINSCallConfig

public XINSCallConfig()

Constructs a new XINSCallConfig object.

Method Detail

getHTTPMethod

public HTTPMethod getHTTPMethod()

Returns the HTTP method associated with this configuration.

Returns:

the HTTP method, never null.

setHTTPMethod

public void setHTTPMethod(HTTPMethod method)
                   throws IllegalArgumentException

Sets the HTTP method associated with this configuration.

Parameters:

method - the HTTP method to be associated with this configuration, cannot be null.

Throws:

IllegalArgumentException - if method == null.

getFollowRedirect

public boolean getFollowRedirect()

Returns the action performed when a redirect is returned from the server.

Returns:

true if it should call the redirected link, false if it should fail.

Since:

XINS 2.2

setFollowRedirect

public void setFollowRedirect(boolean follow)

Sets the action to perform if a redirect is returned from the server.

Parameters:

follow - true if it should call the redirected link, false if it should fail.

Since:

XINS 2.2

getHttpClient

public HttpClient getHttpClient()

Gets the HttpClient to use to call the URL. If no HttpClient has been set or created, a default one is created and returned.

Returns:

the http client, cannot be null.

Since:

XINS 3.1

setHttpClient

public void setHttpClient(HttpClient httpClient)

Sets the HttpClient to use to call the URL. If null the default HttpClient will be used.

Parameters:

httpClient - the http client, can be null.

Since:

XINS 3.1

describe

public String describe()

Describes this configuration.

Overrides:

describe in class CallConfig

Returns:

the description of this configuration, should never be null, should never be empty and should never start or end with whitespace characters.