How to configure timeout duration at client side for axis2 web services?

May 7, 2011 · by · in Axis2, Web Services · 4 Comments

Axis2 uses CommonsHTTPTransportSender by default, which is based on commons-httpclient-3.1. At transport level, there’re two types of timeouts that can be set:

1. Socket Timeout
2. Connection Timeout

Here’s how you can configure the above ones:

Way #1: Configuring timeouts in axis2.xml

Socket Timeout
<parameter name=”SO_TIMEOUT”>some_integer_value</parameter>

Connection timeout
<parameter name=”CONNECTION_TIMEOUT”>some_integer_value</parameter>

Way #2: Configuring timeouts in code

…
Options options = new Options();
options.setProperty(HTTPConstants.SO_TIMEOUT, new Integer(timeOutInMilliSeconds));
options.setProperty(HTTPConstants.CONNECTION_TIMEOUT, new Integer(timeOutInMilliSeconds));

// or
options.setTimeOutInMilliSeconds(timeOutInMilliSeconds);
…

Real-life code: How to set timeout for a Axis2 Stub?


 long timeout = 2 * 60 * 1000; // Two minutes
 Stub stub = new TestStub();
 stub._getServiceClient().getOptions().setTimeOutInMilliSeconds(soTimeout);

 //or

 long timeout = 2 * 60 * 1000; // Two minutes
 Stub stub = new TestStub();
 stub._getServiceClient().getOptions().setProperty(
                  HTTPConstants.SO_TIMEOUT, new Integer(timeOutInMilliSeconds));
 stub._getServiceClient().getOptions().setProperty(
                  HTTPConstants.CONNECTION_TIMEOUT, new Integer(timeOutInMilliSeconds));

Reference

Axis2 HTTP Transport – http://axis.apache.org/axis2/java/core/docs/http-transport.html

Tags: , , , , ,

4 comments

  1. Romy · · Reply→

    What is the default if I don’t set a timeout?

    1. Singaram Subramanian · · Reply→

      I think it must be an infinite time unless we set it

  2. Mouhammed Soueidane · · Reply→

    Something doesn’t make sense. In your code, you’re setting three timeouts:
    1- stub._getServiceClient().getOptions().setTimeOutInMilliSeconds(soTimeout);

    2- stub._getServiceClient().getOptions().setProperty(
    HTTPConstants.SO_TIMEOUT, new Integer(timeOutInMilliSeconds));

    3- stub._getServiceClient().getOptions().setProperty(
    HTTPConstants.CONNECTION_TIMEOUT, new Integer(timeOutInMilliSeconds));

    Don’t the first and the second timeout refer to an SO timeout? If that’s correct, then why setting it twice?

    1. Singaram Subramanian · · Reply→

      Didn’t you notice an //or in the code?

Leave a comment