Class XmlRpcHttpRequestConfigImpl

java.lang.Object
org.apache.xmlrpc.XmlRpcConfigImpl
org.apache.xmlrpc.common.XmlRpcHttpRequestConfigImpl
All Implemented Interfaces:
XmlRpcHttpConfig, XmlRpcHttpRequestConfig, XmlRpcStreamConfig, XmlRpcStreamRequestConfig, XmlRpcConfig, XmlRpcRequestConfig
Direct Known Subclasses:
RequestData, XmlRpcClientConfigImpl
public class XmlRpcHttpRequestConfigImpl extends XmlRpcConfigImpl implements XmlRpcHttpRequestConfig
Default implementation of a request configuration.

  • Field Details

    • gzipCompressing

      private boolean gzipCompressing

    • gzipRequesting

      private boolean gzipRequesting

    • basicUserName

      private String basicUserName

    • basicPassword

      private String basicPassword

    • connectionTimeout

      private int connectionTimeout

    • replyTimeout

      private int replyTimeout

    • enabledForExceptions

      private boolean enabledForExceptions

  • Constructor Details

    • XmlRpcHttpRequestConfigImpl

      public XmlRpcHttpRequestConfigImpl()

  • Method Details

    • setGzipCompressing

      public void setGzipCompressing(boolean pCompressing)
      Sets, whether gzip compression is being used for transmitting the request.
      Parameters:
      pCompressing - True for enabling gzip compression, false otherwise.
      See Also:

    • isGzipCompressing

      public boolean isGzipCompressing()
      Description copied from interface: XmlRpcStreamRequestConfig
      Returns, whether the request stream is being compressed. Note, that the response stream may still be uncompressed.
      Specified by:
      isGzipCompressing in interface XmlRpcStreamRequestConfig
      Returns:
      Whether to use Gzip compression or not. Defaults to false.
      See Also:

    • setGzipRequesting

      public void setGzipRequesting(boolean pRequesting)
      Sets, whether gzip compression is requested for the response.
      Parameters:
      pRequesting - True for requesting gzip compression, false otherwise.
      See Also:

    • isGzipRequesting

      public boolean isGzipRequesting()
      Description copied from interface: XmlRpcStreamRequestConfig
      Returns, whether compression is requested for the response stream. Note, that the request is stull uncompressed, unless XmlRpcStreamRequestConfig.isGzipCompressing() is activated. Also note, that the server may still decide to send uncompressed data.
      Specified by:
      isGzipRequesting in interface XmlRpcStreamRequestConfig
      Returns:
      Whether to use Gzip compression or not. Defaults to false.
      See Also:

    • setBasicUserName

      public void setBasicUserName(String pUser)
      Sets the user name for basic authentication.
      Parameters:
      pUser - The user name.

    • getBasicUserName

      public String getBasicUserName()
      Description copied from interface: XmlRpcHttpRequestConfig
      Returns the user name being used for basic HTTP authentication.
      Specified by:
      getBasicUserName in interface XmlRpcHttpRequestConfig
      Returns:
      User name or null, if no basic HTTP authentication is being used.

    • setBasicPassword

      public void setBasicPassword(String pPassword)
      Sets the password for basic authentication.
      Parameters:
      pPassword - The password.

    • getBasicPassword

      public String getBasicPassword()
      Description copied from interface: XmlRpcHttpRequestConfig
      Returns the password being used for basic HTTP authentication.
      Specified by:
      getBasicPassword in interface XmlRpcHttpRequestConfig
      Returns:
      Password or null, if no basic HTTP authentication is beind used.

    • setConnectionTimeout

      public void setConnectionTimeout(int pTimeout)
      Set the connection timeout in milliseconds.
      Parameters:
      pTimeout - connection timeout, 0 to disable it

    • getConnectionTimeout

      public int getConnectionTimeout()
      Description copied from interface: XmlRpcHttpRequestConfig
      Return the connection timeout in milliseconds
      Specified by:
      getConnectionTimeout in interface XmlRpcHttpRequestConfig
      Returns:
      connection timeout in milliseconds or 0 if no set

    • setReplyTimeout

      public void setReplyTimeout(int pTimeout)
      Set the reply timeout in milliseconds.
      Parameters:
      pTimeout - reply timeout, 0 to disable it

    • getReplyTimeout

      public int getReplyTimeout()
      Description copied from interface: XmlRpcHttpRequestConfig
      Return the reply timeout in milliseconds
      Specified by:
      getReplyTimeout in interface XmlRpcHttpRequestConfig
      Returns:
      reply timeout in milliseconds or 0 if no set

    • setEnabledForExceptions

      public void setEnabledForExceptions(boolean pEnabledForExceptions)
      Sets, whether the response should contain a "faultCause" element in case of errors. The "faultCause" is an exception, which the server has trapped and written into a byte stream as a serializable object.

    • isEnabledForExceptions

      public boolean isEnabledForExceptions()
      Description copied from interface: XmlRpcStreamRequestConfig
      Returns, whether the response should contain a "faultCause" element in case of errors. The "faultCause" is an exception, which the server has trapped and written into a byte stream as a serializable object.
      Specified by:
      isEnabledForExceptions in interface XmlRpcStreamRequestConfig