org.apache.xmlrpc.common
Interface XmlRpcHttpRequestConfig

All Superinterfaces:

XmlRpcConfig, XmlRpcHttpConfig, XmlRpcRequestConfig, XmlRpcStreamConfig, XmlRpcStreamRequestConfig

All Known Subinterfaces:

XmlRpcHttpClientConfig

All Known Implementing Classes:

RequestData, XmlRpcClientConfigImpl, XmlRpcHttpRequestConfigImpl

public interface XmlRpcHttpRequestConfig
extends XmlRpcStreamRequestConfig, XmlRpcHttpConfig

Extension of XmlRpcClientConfig for HTTP based transport. Provides details like server URL, user credentials, and so on.

Field Summary

Fields inherited from interface org.apache.xmlrpc.common.XmlRpcStreamConfig

UTF8_ENCODING

Method Summary

java.lang.String	getBasicPassword() Returns the password being used for basic HTTP authentication.
java.lang.String	getBasicUserName() Returns the user name being used for basic HTTP authentication.
int	getConnectionTimeout() Returns the connection timeout in milliseconds.
int	getReplyTimeout() Return the reply timeout in milliseconds.

Methods inherited from interface org.apache.xmlrpc.common.XmlRpcStreamRequestConfig

isEnabledForExceptions, isGzipCompressing, isGzipRequesting

Methods inherited from interface org.apache.xmlrpc.common.XmlRpcHttpConfig

getBasicEncoding, isContentLengthOptional

Methods inherited from interface org.apache.xmlrpc.common.XmlRpcStreamConfig

getEncoding

Methods inherited from interface org.apache.xmlrpc.XmlRpcConfig

getTimeZone, isEnabledForExtensions

Method Detail

getBasicUserName

java.lang.String getBasicUserName()

Returns the user name being used for basic HTTP authentication.

Returns:

User name or null, if no basic HTTP authentication is being used.

getBasicPassword

java.lang.String getBasicPassword()

Returns the password being used for basic HTTP authentication.

Returns:

Password or null, if no basic HTTP authentication is beind used.

Throws:

java.lang.IllegalStateException - A user name is configured, but no password.

getConnectionTimeout

int getConnectionTimeout()

Returns the connection timeout in milliseconds. Note, that this value may or may not be used, depending on the transport factory. Transport factories, which are known to use this value: XmlRpcCommonsTransportFactory, and XmlRpcSun15HttpTransportFactory. On the other hand, transport factories which are known not to use this value: XmlRpcSunHttpTransportFactory, XmlRpcSun14HttpTransportFactory, XmlRpcLiteHttpTransportFactory, and XmlRpcLite14HttpTransport.

Returns:

connection timeout in milliseconds or 0 if no set

getReplyTimeout

int getReplyTimeout()

Return the reply timeout in milliseconds. Note, that this value may or may not be used, depending on the transport factory. Transport factories, which are known to use this value: XmlRpcCommonsTransportFactory, and XmlRpcSun15HttpTransportFactory. On the other hand, transport factories which are known not to use this value: XmlRpcSunHttpTransportFactory, XmlRpcSun14HttpTransportFactory, XmlRpcLiteHttpTransportFactory, and XmlRpcLite14HttpTransport.

Returns:

reply timeout in milliseconds or 0 if no set