org.mule.module.http.internal.request

Class DefaultHttpRequesterConfig

java.lang.Object

org.mule.AbstractAnnotatedObject

org.mule.module.http.internal.request.DefaultHttpRequesterConfig

All Implemented Interfaces:

AnnotatedObject, MuleContextAware, Initialisable, Startable, Stoppable, NamedObject, HttpRequesterConfig

public class DefaultHttpRequesterConfig
extends AbstractAnnotatedObject
implements HttpRequesterConfig, Initialisable, Stoppable, Startable, MuleContextAware

Field Summary

Fields

Modifier and Type	Field and Description
static String	OBJECT_HTTP_CLIENT_FACTORY

Fields inherited from interface org.mule.api.AnnotatedObject

PROPERTY_NAME

Fields inherited from interface org.mule.api.lifecycle.Startable

PHASE_NAME

Fields inherited from interface org.mule.api.lifecycle.Stoppable

PHASE_NAME

Fields inherited from interface org.mule.api.lifecycle.Initialisable

PHASE_NAME

Constructor Summary

Constructors

Constructor and Description
DefaultHttpRequesterConfig()

Method Summary

Methods

Modifier and Type	Method and Description
RamlApiConfiguration	getApiConfiguration()
HttpAuthentication	getAuthentication()
String	getBasePath()
TcpClientSocketProperties	getClientSocketProperties()
CookieManager	getCookieManager()
String	getFollowRedirects()
String	getHost()
HttpClient	getHttpClient()
String	getName()
String	getParseResponse()
String	getPort()
ProxyConfig	getProxyConfig()
String	getRequestStreamingMode()
String	getResponseTimeout()
String	getScheme()
String	getSendBodyMode()
TlsContextFactory	getTlsContext()
void	initialise()
boolean	isEnableCookies()
void	setApiConfiguration(RamlApiConfiguration apiConfiguration)
void	setAuthentication(HttpAuthentication authentication)
void	setBasePath(String basePath)
void	setClientSocketProperties(TcpClientSocketProperties clientSocketProperties)
void	setConnectionIdleTimeout(int connectionIdleTimeout)
void	setEnableCookies(boolean enableCookies)
void	setFollowRedirects(String followRedirects)
void	setHost(String host)
void	setMaxConnections(int maxConnections)
void	setMuleContext(MuleContext muleContext)
void	setName(String name)
void	setParseResponse(String parseResponse)
void	setPort(String port)
void	setProtocol(HttpConstants.Protocols protocol)
void	setProxyConfig(ProxyConfig proxyConfig)
void	setRequestStreamingMode(String requestStreamingMode)
void	setResponseTimeout(String responseTimeout)
void	setSendBodyMode(String sendBodyMode)
void	setTlsContext(TlsContextFactory tlsContext)
void	setUsePersistentConnections(boolean usePersistentConnections)
void	start()
void	stop()

Methods inherited from class org.mule.AbstractAnnotatedObject

getAnnotation, getAnnotations, setAnnotations

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.api.AnnotatedObject

getAnnotation, getAnnotations, setAnnotations

Field Detail

OBJECT_HTTP_CLIENT_FACTORY

public static final String OBJECT_HTTP_CLIENT_FACTORY

See Also:

Constant Field Values

Constructor Detail

DefaultHttpRequesterConfig

public DefaultHttpRequesterConfig()

Method Detail

initialise

public void initialise()
                throws InitialisationException

Specified by:

initialise in interface Initialisable

Throws:

InitialisationException

stop

public void stop()
          throws MuleException

Specified by:

stop in interface Stoppable

Throws:

MuleException

getScheme

public String getScheme()

getHttpClient

public HttpClient getHttpClient()

getCookieManager

public CookieManager getCookieManager()

getBasePath

public String getBasePath()

Specified by:

getBasePath in interface HttpRequesterConfig

Returns:

the base path

setBasePath

public void setBasePath(String basePath)

getName

public String getName()

Specified by:

getName in interface NamedObject

setName

public void setName(String name)

getHost

public String getHost()

Specified by:

getHost in interface HttpRequesterConfig

Returns:

the host to be called

setHost

public void setHost(String host)

getPort

public String getPort()

Specified by:

getPort in interface HttpRequesterConfig

Returns:

the port to connect to

setPort

public void setPort(String port)

getAuthentication

public HttpAuthentication getAuthentication()

Specified by:

getAuthentication in interface HttpRequesterConfig

Returns:

authentication mechanism when making request

setAuthentication

public void setAuthentication(HttpAuthentication authentication)

getTlsContext

public TlsContextFactory getTlsContext()

Specified by:

getTlsContext in interface HttpRequesterConfig

Returns:

the tls configuration when using HTTPS

setTlsContext

public void setTlsContext(TlsContextFactory tlsContext)

getApiConfiguration

public RamlApiConfiguration getApiConfiguration()

setApiConfiguration

public void setApiConfiguration(RamlApiConfiguration apiConfiguration)

getFollowRedirects

public String getFollowRedirects()

Specified by:

getFollowRedirects in interface HttpRequesterConfig

Returns:

configuration for enabling or disabling follow redirects. It may be dynamic.

setFollowRedirects

public void setFollowRedirects(String followRedirects)

getClientSocketProperties

public TcpClientSocketProperties getClientSocketProperties()

setClientSocketProperties

public void setClientSocketProperties(TcpClientSocketProperties clientSocketProperties)

getProxyConfig

public ProxyConfig getProxyConfig()

Specified by:

getProxyConfig in interface HttpRequesterConfig

Returns:

http proxy configuration to be used

setProxyConfig

public void setProxyConfig(ProxyConfig proxyConfig)

getRequestStreamingMode

public String getRequestStreamingMode()

Specified by:

getRequestStreamingMode in interface HttpRequesterConfig

Returns:

the streaming mode for making the request. Defines if the request will be sent using Transfer-Encoding: chunked. It may be dynamic

setRequestStreamingMode

public void setRequestStreamingMode(String requestStreamingMode)

getSendBodyMode

public String getSendBodyMode()

Specified by:

getSendBodyMode in interface HttpRequesterConfig

Returns:

if the request will contain or not a body. It may be dynamic.

setSendBodyMode

public void setSendBodyMode(String sendBodyMode)

getParseResponse

public String getParseResponse()

Specified by:

getParseResponse in interface HttpRequesterConfig

Returns:

mode for parsing a response. It may contain an expression if it's dynamic.

setParseResponse

public void setParseResponse(String parseResponse)

getResponseTimeout

public String getResponseTimeout()

Specified by:

getResponseTimeout in interface HttpRequesterConfig

Returns:

maximum time to wait for a response

setResponseTimeout

public void setResponseTimeout(String responseTimeout)

start

public void start()
           throws MuleException

Specified by:

start in interface Startable

Throws:

MuleException

setMaxConnections

public void setMaxConnections(int maxConnections)

setUsePersistentConnections

public void setUsePersistentConnections(boolean usePersistentConnections)

setConnectionIdleTimeout

public void setConnectionIdleTimeout(int connectionIdleTimeout)

isEnableCookies

public boolean isEnableCookies()

setEnableCookies

public void setEnableCookies(boolean enableCookies)

setMuleContext

public void setMuleContext(MuleContext muleContext)

Specified by:

setMuleContext in interface MuleContextAware

setProtocol

public void setProtocol(HttpConstants.Protocols protocol)