org.adroitlogic.ultraesb.transport.http
Class HttpNIOListener

java.lang.Object
  org.adroitlogic.ultraesb.core.config.AbstractConfigurationElement
      org.adroitlogic.ultraesb.transport.base.AbstractTransportListener
          org.adroitlogic.ultraesb.transport.http.HttpNIOListener

All Implemented Interfaces:

ConfigurationElement, org.adroitlogic.ultraesb.transport.base.ManagementSupport, org.springframework.beans.factory.BeanNameAware, org.springframework.context.ApplicationContextAware

Direct Known Subclasses:

HttpsNIOListener

public class HttpNIOListener
extends org.adroitlogic.ultraesb.transport.base.AbstractTransportListener
implements org.adroitlogic.ultraesb.transport.base.ManagementSupport

The HTTP transport listener

Sets the following message properties in addition to setting the request URI as the destination

• HttpConstants.METHOD - the HTTP method i.e. POST, GET, HEAD, PUT, DELETE, OPTIONS, TRACE
• HttpNIOListener.USERNAME - if HTTP basic or digest authentication was used, the user name
• HttpNIOListener.USERROLES - if HTTP basic or digest authentication was used, the user roles
• HttpConstants.QUERY_STRING - the HTTP query string

Nested Class Summary

Nested classes/interfaces inherited from interface org.adroitlogic.ultraesb.api.ConfigurationElement

ConfigurationElement.State

Field Summary

Fields inherited from class org.adroitlogic.ultraesb.transport.base.AbstractTransportListener

logger, metrics, properties, transportName

Fields inherited from class org.adroitlogic.ultraesb.core.config.AbstractConfigurationElement

config, ctx, debugOn, derivedName, id, outdated, state

Constructor Summary

HttpNIOListener(FileCache fileCache)
Default constructor, with a reference to the FileCache to use

Method Summary

void	setBindAddress(java.lang.String bindAddress) The bind address to use, on a multiple network interface node
void	setCompressionMinSize(long compressionMinSize) Set the minimum size of the response entity to enable compression when supported by the client (default 2Kbytes)
void	setConnectionDebugHeaders(java.util.Set connectionDebugHeaders) Sets the list of HTTP headers to be dumped on a connection failure, when connection debugging is enabled
void	setContinueOnCheckedExceptions(boolean continueOnCheckedExceptions) Control behavior of engine on checked exceptions
void	setContinueOnRuntimeExceptions(boolean continueOnRuntimeExceptions) Control behavior of engine on runtime exceptions (WARNING: It maybe dangerous to ignore runtime exceptions)
void	setDefaultContextPath(java.lang.String defaultContextPath) Set the default context path for services exposed over HTTP
void	setEnableConnectionDebug(boolean enableConnectionDebug) Debug connection information on errors
void	setMaxPayloadSize(long maxPayloadSize) The maximum payload size to accept - defaults to 1M
void	setNoCompression(boolean noCompression) Turn off use of Gzip compression even if the request contains an Accept-Encoding header
void	setPort(int port) The HTTP transport listen port - default is 80
void	setReplaceOriginServer(boolean replaceOriginServer) Replace the origin server header for proxied requests, to UltraESB
void	setRequestFilters(java.util.List requestFilters) One or more request filters - to support ?wsdl, ?xsd etc on service endpoints
void	setResumeNewConnectionsAt(int resumeNewConnectionsAt) Bound at which to resume normal operations from maintenance mode when open connections increased
void	setStopNewConnectionsAt(int stopNewConnectionsAt) Set the upper bound on the open connections at a given time, after which the transport will reject new connections
void	setZeroCopyEnabled(boolean zeroCopyEnabled) Use Zero-Copy when reading requests
void	toDetailedViewExt(org.adroitlogic.ultraesb.jmx.view.TransportView view) Extension point for additional attributes

Methods inherited from class org.adroitlogic.ultraesb.transport.base.AbstractTransportListener

getAvgSizeReceived, getAvgSizeSent, getBytesReceived, getBytesSent, getDetails, getFaultsReceiving, getFaultsSending, getLastResetTime, getMaxSizeReceived, getMaxSizeSent, getMessagesReceived, getMessagesSent, getMetricsWindow, getMinSizeReceived, getMinSizeSent, getReceiveErrorCodeTable, getSendErrorCodeTable, getTimeoutsReceiving, getTimeoutsSending, init, resetStatistics, setProperties, toBasicView, toDetailedView

Methods inherited from class org.adroitlogic.ultraesb.core.config.AbstractConfigurationElement

equals, getAppCtx, getDerivedName, getId, getState, hashCode, isDebugOn, isStarted, maintenanceShutdown, markAsOutdated, pause, resume, setApplicationContext, setBeanName, setConfig, setDebugOn, setDerivedName, setId, setState, start, stop, throwIllegalStateException, undeploy

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.adroitlogic.ultraesb.transport.base.ManagementSupport

getAvgSizeReceived, getAvgSizeSent, getBytesReceived, getBytesSent, getFaultsReceiving, getFaultsSending, getLastResetTime, getMaxSizeReceived, getMaxSizeSent, getMessagesReceived, getMessagesSent, getMetricsWindow, getMinSizeReceived, getMinSizeSent, getReceiveErrorCodeTable, getSendErrorCodeTable, getTimeoutsReceiving, getTimeoutsSending, maintenanceShutdown, pause, resetStatistics, resume

Constructor Detail

HttpNIOListener

public HttpNIOListener(FileCache fileCache)

Default constructor, with a reference to the FileCache to use

Parameters:

fileCache - the file cache to use

Method Detail

setPort

public void setPort(int port)

The HTTP transport listen port - default is 80

Parameters:

port - HTTP listen port

setBindAddress

public void setBindAddress(java.lang.String bindAddress)

The bind address to use, on a multiple network interface node

Parameters:

bindAddress - bind address to listen

setRequestFilters

public void setRequestFilters(java.util.List requestFilters)

One or more request filters - to support ?wsdl, ?xsd etc on service endpoints

Parameters:

requestFilters - a list of service filters to attach to this listener

See Also:

RequestFilter

setConnectionDebugHeaders

public void setConnectionDebugHeaders(java.util.Set connectionDebugHeaders)

Sets the list of HTTP headers to be dumped on a connection failure, when connection debugging is enabled

Parameters:

connectionDebugHeaders - a set of HTTP header names, or a single entry 'none' or 'all'

setReplaceOriginServer

public void setReplaceOriginServer(boolean replaceOriginServer)

Replace the origin server header for proxied requests, to UltraESB

Parameters:

replaceOriginServer - false disables the replacing (Default is true)

setEnableConnectionDebug

public void setEnableConnectionDebug(boolean enableConnectionDebug)

Debug connection information on errors

Parameters:

enableConnectionDebug - enable when true

setZeroCopyEnabled

public void setZeroCopyEnabled(boolean zeroCopyEnabled)

Use Zero-Copy when reading requests

Parameters:

zeroCopyEnabled - true uses Zero-Copy reads (default)

setStopNewConnectionsAt

public void setStopNewConnectionsAt(int stopNewConnectionsAt)

Set the upper bound on the open connections at a given time, after which the transport will reject new connections

Parameters:

stopNewConnectionsAt - maximum open connections

setResumeNewConnectionsAt

public void setResumeNewConnectionsAt(int resumeNewConnectionsAt)

Bound at which to resume normal operations from maintenance mode when open connections increased

Parameters:

resumeNewConnectionsAt - bound at which to resume normal operations after hitting stopNewConnectionsAt

setMaxPayloadSize

public void setMaxPayloadSize(long maxPayloadSize)

The maximum payload size to accept - defaults to 1M

Parameters:

maxPayloadSize - maximum payload size to accept

setDefaultContextPath

public void setDefaultContextPath(java.lang.String defaultContextPath)

Set the default context path for services exposed over HTTP

Parameters:

defaultContextPath - the context path to use (default '/service/')

setNoCompression

public void setNoCompression(boolean noCompression)

Turn off use of Gzip compression even if the request contains an Accept-Encoding header

Parameters:

noCompression - true fully disables all use of response compression

setCompressionMinSize

public void setCompressionMinSize(long compressionMinSize)

Set the minimum size of the response entity to enable compression when supported by the client (default 2Kbytes)

Parameters:

compressionMinSize - size in bytes

setContinueOnRuntimeExceptions

public void setContinueOnRuntimeExceptions(boolean continueOnRuntimeExceptions)

Control behavior of engine on runtime exceptions (WARNING: It maybe dangerous to ignore runtime exceptions)

Parameters:

continueOnRuntimeExceptions - if true, ignores runtime exceptions

setContinueOnCheckedExceptions

public void setContinueOnCheckedExceptions(boolean continueOnCheckedExceptions)

Control behavior of engine on checked exceptions

Parameters:

continueOnCheckedExceptions - if true, ignores checked exceptions

toDetailedViewExt

public void toDetailedViewExt(org.adroitlogic.ultraesb.jmx.view.TransportView view)

Extension point for additional attributes

Overrides:

toDetailedViewExt in class org.adroitlogic.ultraesb.transport.base.AbstractTransportListener