org.xins.client
Class XINSCallConfig

java.lang.Object
  extended byorg.xins.common.service.CallConfig
      extended byorg.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.26 $ $Date: 2008/12/22 09:40:37 $
Author:
Ernst de Haan, Anthony Goubard
See Also:
Serialized Form

Constructor Summary
XINSCallConfig()
          Constructs a new XINSCallConfig object.
 
Method Summary
 String describe()
          Describes this configuration.
 boolean getFollowRedirect()
          Returns the action performed when a redirect is returned from the server.
 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 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

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.


See http://www.xins.org/.