org.mule.providers.http
Class HttpConnector

java.lang.Object
  org.mule.providers.AbstractConnector
      org.mule.providers.tcp.TcpConnector
          org.mule.providers.http.HttpConnector

All Implemented Interfaces:

org.mule.umo.lifecycle.Disposable, EventListener, ExceptionListener, org.mule.umo.lifecycle.Initialisable, org.mule.umo.provider.UMOConnectable, org.mule.umo.provider.UMOConnector, WorkListener

Direct Known Subclasses:

HttpsConnector, JettyConnector

public class HttpConnector

extends org.mule.providers.tcp.TcpConnector

HttpConnector provides a way of receiving and sending http requests and responses. The UMOConnector itself handles dispatching http requests. The HttpMessageReceiver handles the receiving requests and processing of headers This endpoint recognises the following properties -

• hostname - The hostname to send and receive http requests
• port - The port to listen on. The industry standard is 80 and if this propert is not set it will default to 80
• proxyHostname - If you access the web through a proxy, this holds the server address
• proxyPort - The port the proxy is configured on
• proxyUsername - If the proxy requires authentication supply a username
• proxyPassword - If the proxy requires authentication supply a password

Field Summary

protected org.apache.commons.httpclient.HttpConnectionManager	clientConnectionManager
static String	COOKIE_SPEC_NETSCAPE
static String	COOKIE_SPEC_RFC2109
static String	DEFAULT_HTTP_GET_BODY_PARAM_PROPERTY
static String	HTTP_COOKIE_SPEC_PROPERTY
static String	HTTP_COOKIES_PROPERTY
static String	HTTP_CUSTOM_HEADERS_MAP_PROPERTY
static String	HTTP_ENABLE_COOKIES_PROPERTY
static String	HTTP_GET_BODY_PARAM_PROPERTY
static String	HTTP_METHOD_PROPERTY
static String	HTTP_PARAMS_PROPERTY Allows the user to set a HttpMethodParams object in the client request to be set on the HttpMethod request object
static String	HTTP_POST_BODY_PARAM_PROPERTY
static String	HTTP_REQUEST_PROPERTY
static String	HTTP_STATUS_PROPERTY Event property to pass back the status for the response
static String	HTTP_VERSION_PROPERTY

Fields inherited from class org.mule.providers.tcp.TcpConnector

DEFAULT_BACKLOG, DEFAULT_BUFFER_SIZE, DEFAULT_SOCKET_TIMEOUT, KEEP_SEND_SOCKET_OPEN_PROPERTY

Fields inherited from class org.mule.providers.AbstractConnector

connected, connecting, connectionStrategy, createMultipleTransactedReceivers, DEFAULT_NUM_CONCURRENT_TX_RECEIVERS, defaultInboundTransformer, defaultOutboundTransformer, defaultResponseTransformer, dispatcherFactory, dispatchers, disposed, disposing, exceptionListener, initialised, logger, name, numberOfConcurrentTransactedReceivers, receivers, serviceDescriptor, serviceOverrides, sessionHandler, started, startOnConnect

Fields inherited from interface org.mule.umo.provider.UMOConnector

INT_VALUE_NOT_SET

Constructor Summary

HttpConnector()

Method Summary

protected void	doInitialise()
org.apache.commons.httpclient.HttpConnectionManager	getClientConnectionManager()
String	getCookieSpec()
String	getProtocol()
String	getProxyHostname()
String	getProxyPassword()
int	getProxyPort()
String	getProxyUsername()
protected Object	getReceiverKey(org.mule.umo.UMOComponent component, org.mule.umo.endpoint.UMOEndpoint endpoint) The method determines the key used to store the receiver against.
Map	getReceivers()
boolean	isEnableCookies()
org.mule.umo.provider.UMOMessageReceiver	registerListener(org.mule.umo.UMOComponent component, org.mule.umo.endpoint.UMOEndpoint endpoint)
void	setClientConnectionManager(org.apache.commons.httpclient.HttpConnectionManager clientConnectionManager)
void	setCookieSpec(String cookieSpec)
void	setEnableCookies(boolean enableCookies)
void	setProxyHostname(String host)
void	setProxyPassword(String string)
void	setProxyPort(int port)
void	setProxyUsername(String string)

Methods inherited from class org.mule.providers.tcp.TcpConnector

doConnect, doDisconnect, doDispose, doStart, doStop, getBacklog, getBufferSize, getOutputStream, getReceiveBacklog, getReceiveBufferSize, getReceiveTimeout, getSendBufferSize, getSendSocketLinger, getSendTimeout, getServerSocket, getServerSocketFactory, getSocket, getSocketFactory, getTcpProtocol, getTcpProtocolClassName, isKeepAlive, isKeepSendSocketOpen, isRemoteSyncEnabled, isReuseAddress, isSendTcpNoDelay, isValidateConnections, setBacklog, setBufferSize, setKeepAlive, setKeepSendSocketOpen, setReceiveBacklog, setReceiveBufferSize, setReceiveTimeout, setReuseAddress, setSendBufferSize, setSendSocketLinger, setSendTcpNoDelay, setSendTimeout, setServerSocketFactory, setSocketFactory, setTcpProtocol, setTcpProtocolClassName, setTimeout, setValidateConnections

Methods inherited from class org.mule.providers.AbstractConnector

checkDisposed, connect, createReceiver, destroyReceiver, disconnect, dispatch, dispose, disposeDispatchers, disposeReceivers, disposeWorkManagers, exceptionThrown, fireNotification, getConnectEventId, getConnectionDescription, getConnectionStrategy, getDefaultInboundTransformer, getDefaultOutboundTransformer, getDefaultResponseTransformer, getDispatcherFactory, getDispatcherThreadingProfile, getDispatcherWorkManager, getExceptionListener, getMaxDispatchersActive, getMessageAdapter, getName, getNumberOfConcurrentTransactedReceivers, getReceiver, getReceivers, getReceiverThreadingProfile, getReceiverWorkManager, getReplyToHandler, getScheduler, getServiceDescriptor, getServiceOverrides, getSessionHandler, getStreamMessageAdapter, getSupportedProtocols, handleException, handleWorkException, initFromServiceDescriptor, initialise, initialiseFromUrl, isConnected, isCreateMultipleTransactedReceivers, isDisposed, isDisposing, isEnableMessageEvents, isStarted, lookupReceiver, receive, receive, registerSupportedProtocol, registerSupportedProtocolWithoutPrefix, send, setConnectionStrategy, setCreateMultipleTransactedReceivers, setDefaultInboundTransformer, setDefaultOutboundTransformer, setDefaultResponseTransformer, setDispatcherFactory, setDispatcherThreadingProfile, setEnableMessageEvents, setExceptionListener, setMaxDispatchersActive, setName, setNumberOfConcurrentTransactedReceivers, setReceiverThreadingProfile, setServiceOverrides, setSessionHandler, setSupportedProtocols, startConnector, stopConnector, supportsProtocol, toString, unregisterListener, unregisterSupportedProtocol, workAccepted, workCompleted, workRejected, workStarted

Methods inherited from class java.lang.Object

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

Field Detail

HTTP_STATUS_PROPERTY

public static final String HTTP_STATUS_PROPERTY

Event property to pass back the status for the response

See Also:

Constant Field Values

HTTP_VERSION_PROPERTY

public static final String HTTP_VERSION_PROPERTY

See Also:

Constant Field Values

HTTP_CUSTOM_HEADERS_MAP_PROPERTY

public static final String HTTP_CUSTOM_HEADERS_MAP_PROPERTY

See Also:

Constant Field Values

HTTP_METHOD_PROPERTY

public static final String HTTP_METHOD_PROPERTY

See Also:

Constant Field Values

HTTP_REQUEST_PROPERTY

public static final String HTTP_REQUEST_PROPERTY

See Also:

Constant Field Values

HTTP_PARAMS_PROPERTY

public static final String HTTP_PARAMS_PROPERTY

Allows the user to set a HttpMethodParams object in the client request to be set on the HttpMethod request object

See Also:

Constant Field Values

HTTP_GET_BODY_PARAM_PROPERTY

public static final String HTTP_GET_BODY_PARAM_PROPERTY

See Also:

Constant Field Values

DEFAULT_HTTP_GET_BODY_PARAM_PROPERTY

public static final String DEFAULT_HTTP_GET_BODY_PARAM_PROPERTY

See Also:

Constant Field Values

HTTP_POST_BODY_PARAM_PROPERTY

public static final String HTTP_POST_BODY_PARAM_PROPERTY

See Also:

Constant Field Values

HTTP_COOKIE_SPEC_PROPERTY

public static final String HTTP_COOKIE_SPEC_PROPERTY

See Also:

Constant Field Values

HTTP_COOKIES_PROPERTY

public static final String HTTP_COOKIES_PROPERTY

See Also:

Constant Field Values

HTTP_ENABLE_COOKIES_PROPERTY

public static final String HTTP_ENABLE_COOKIES_PROPERTY

See Also:

Constant Field Values

COOKIE_SPEC_NETSCAPE

public static final String COOKIE_SPEC_NETSCAPE

See Also:

Constant Field Values

COOKIE_SPEC_RFC2109

public static final String COOKIE_SPEC_RFC2109

See Also:

Constant Field Values

clientConnectionManager

protected org.apache.commons.httpclient.HttpConnectionManager clientConnectionManager

Constructor Detail

HttpConnector

public HttpConnector()

Method Detail

doInitialise

protected void doInitialise()
                     throws org.mule.umo.lifecycle.InitialisationException

Throws:

org.mule.umo.lifecycle.InitialisationException

registerListener

public org.mule.umo.provider.UMOMessageReceiver registerListener(org.mule.umo.UMOComponent component,
                                                                 org.mule.umo.endpoint.UMOEndpoint endpoint)
                                                          throws Exception

Throws:

Exception

See Also:

UMOConnector.registerListener(UMOComponent, UMOEndpoint)

getReceiverKey

protected Object getReceiverKey(org.mule.umo.UMOComponent component,
                                org.mule.umo.endpoint.UMOEndpoint endpoint)

The method determines the key used to store the receiver against.

Parameters:

component - the component for which the endpoint is being registered

endpoint - the endpoint being registered for the component

Returns:

the key to store the newly created receiver against

getProtocol

public String getProtocol()

See Also:

UMOConnector.getProtocol()

getProxyHostname

public String getProxyHostname()

Returns:

getProxyPassword

public String getProxyPassword()

Returns:

getProxyPort

public int getProxyPort()

Returns:

getProxyUsername

public String getProxyUsername()

Returns:

setProxyHostname

public void setProxyHostname(String host)

Parameters:

host -

setProxyPassword

public void setProxyPassword(String string)

Parameters:

string -

setProxyPort

public void setProxyPort(int port)

Parameters:

port -

setProxyUsername

public void setProxyUsername(String string)

Parameters:

string -

getReceivers

public Map getReceivers()

getCookieSpec

public String getCookieSpec()

setCookieSpec

public void setCookieSpec(String cookieSpec)

isEnableCookies

public boolean isEnableCookies()

setEnableCookies

public void setEnableCookies(boolean enableCookies)

getClientConnectionManager

public org.apache.commons.httpclient.HttpConnectionManager getClientConnectionManager()

setClientConnectionManager

public void setClientConnectionManager(org.apache.commons.httpclient.HttpConnectionManager clientConnectionManager)