Element Summary

ElementDescriptionClass
basicAuthCredentialsThis class contains parameters needed to send basic authentication credentialsorg.apache.servicemix.http.BasicAuthCredentials
componentan HTTP JBI component. The component is responsible for hosting HTTP endpoints.org.apache.servicemix.http.HttpComponent
configurationconfiguration for the Jetty instance used by an HTTP endpointorg.apache.servicemix.http.HttpConfiguration
consumerPlain HTTP consumer endpoint. This endpoint can be used to handle plain HTTP request (without SOAP) or to be able to process the request in a non standard way. For HTTP requests, a WSDL2 HTTP binding can be used.org.apache.servicemix.http.endpoints.HttpConsumerEndpoint
endpointthe base element for all HTTP endpointsorg.apache.servicemix.http.HttpEndpoint
providerA plain HTTP provider. This type of endpoint can be used to send non-SOAP requests to HTTP endpoints.org.apache.servicemix.http.endpoints.HttpProviderEndpoint
proxyParametersparameters needed to send HTTP requests through a proxyorg.apache.servicemix.http.ProxyParameters
serializedMarshalera consumer-side marshaler for handling Java serialized contentorg.apache.servicemix.http.endpoints.SerializedMarshaler
soap-consumeran HTTP consumer endpoint that is optimized to work with SOAP messagesorg.apache.servicemix.http.endpoints.HttpSoapConsumerEndpoint
soap-provideran HTTP provider endpoint that is optimaized to work with SOAP messages.org.apache.servicemix.http.endpoints.HttpSoapProviderEndpoint
sslParametersThis class contains all parameters needed to create an SSL server or client socket.org.apache.servicemix.http.SslParameters

Element Detail

Element: basicAuthCredentials

AttributeTypeDescription
passwordxs:stringthe password to use for authentication
usernamexs:stringthe username to use for authentication

Element: component

AttributeTypeDescription
hostxs:stringthe host name
pathxs:string
portxs:integerthe port number. The default is 80.
protocolxs:stringthe protocol being used. Valid values are http: and https:
ElementTypeDescription
authenticationService<spring:bean/>the authentication service object used by a component
client<spring:bean/>the Apache Commons HTTP client used by a component
configurationconfigurationthe HTTP configuration information used to establish HTTP connections
connectionPool<spring:bean/>a Jetty HTTP client instance maintaining a thread pool for client-side connections
endpoints(consumer | endpoint | provider | soap-consumer | soap-provider)*the endpoints hosted by a component
executor<spring:bean/>
executorFactory<spring:bean/>
keystoreManager<spring:bean/>the keystore manager object used by a component
server<spring:bean/>

Element: configuration

AttributeTypeDescription
authenticationServiceNamexs:stringthe JNDI name of the authentication service object. The default is java:comp/env/smx/AuthenticationService.
connectorMaxIdleTimexs:integerthe number of miliseconds a connection will be idle before timing out. The default is 30000.
consumerProcessorSuspendTimexs:integerthe number of miliseconds Jetty will susspend the processing of a request. The default is 60000.
jettyClientPerProviderxs:booleanSpecifies if HTTP provider endpoints share a Jetty client or use per-endpoint Jetty clients. The default setting is
jettyClientThreadPoolSizexs:integerthe maximum number of threads in the client-side threadpool. The default setting is 16.
jettyConnectorClassNamexs:stringthe classname of the Jetty connector used by the endpoint
jettyManagementxs:boolean
jettyThreadPoolSizexs:integerthe maximum number of threads in the server-side threadpool. The default setting is 255.
keystoreManagerNamexs:stringthe JNDI name of the keystore manager object. The default is java:comp/env/smx/KeystoreManager.
managedxs:boolean
mappingxs:string
maxConnectionsPerHostxs:integerthe maximum number of concurent connections allowed from a host. The default is 65536.
maxTotalConnectionsxs:integerthe maximum number of total concurent connections allowed to an endpoint. The default is 65536.
proxyHostxs:stringthe default proxy host name used to send requests. This can be overridden by each endpoint.
proxyPortxs:integerthe default proxy port used to send requests. This can be overridden by each endpoint.
retryCountxs:integerthe number of times a request will be attempted without succees before an error is created. The default is 3. If streaming is enabled, the value will always be 0.
streamingEnabledxs:booleanSpecifies if client-side requests use HTTP streaming.
wantHeadersFromHttpIntoExchangexs:booleanSpecifies if the HTTP provider will copy the HTTP request headers into the JBI exchange. The default is
ElementTypeDescription
authenticationService<spring:bean/>the authentication service object. This property takes precedence over
keystoreManager<spring:bean/>the keystore object. This property takes precedence over

Element: consumer

AttributeTypeDescription
authMethodxs:stringa string naming the scheme used for authenticating users
defaultMepxs:stringa URI representing the endpoint's default MEP. The default is
endpointxs:string
interfaceNamexs:QName
locationURIxs:stringthe URI at which the endpoint listens for requests
servicexs:QName
targetEndpointxs:string
targetInterfacexs:QName
targetOperationxs:QName
targetServicexs:QName
targetUrixs:string
timeoutxs:longthe timeout is specified in milliseconds. The default value is 0 which
ElementTypeDescription
componentcomponent
definition<spring:bean/>
description<spring:bean/>
marshalerserializedMarshalerthe bean used to marshal HTTP messages. The default is a
serviceUnit<spring:bean/>
sslsslParametersa bean containing the SSL configuration properties

Element: endpoint

AttributeTypeDescription
authMethodxs:stringa string naming the scheme used for authenticating users
defaultMepxs:string
defaultOperationxs:QName
dynamicxs:boolean
endpointxs:string
interfaceNamexs:QName
locationURIxs:stringthe URI to which a provider endpoint sends requests
rolexs:stringHTTP endpoints can be either consumers or providers. Specifying
roleAsStringxs:string
servicexs:QName
soapxs:boolean
soapActionxs:string
soapVersionxs:string
synchronousxs:boolean
targetEndpointxs:string
targetInterfaceNamexs:QName
targetServicexs:QName
timeoutxs:integerthe number of milliseconds before the endpoint times out. The default value is 0 which means that the endpoint will never timeout.
wantContentTypeHeaderFromExchangeIntoHttpRequestxs:booleanSpecifies if the HTTP provider will copy the HTTP request headers into the JBI
ElementTypeDescription
basicAuthenticationbasicAuthCredentialsauthentication data for using basic HTTP authentication.
binding<spring:bean/>
definition<spring:bean/>
description<spring:bean/>
policies(<spring:bean/>)*
proxyproxyParametersconfiguration used to establish a proxy for sending HTTP requests. This configuration overrides that which is set at the component level.
serviceUnit<spring:bean/>
sslsslParametersa bean containing the SSL configuration properties
wsdlResource<spring:bean/>

Element: provider

AttributeTypeDescription
clientSoTimeoutxs:integerthe number of milliseconds the endpoint will block while attempting to read a request. The default value is 60000. Setting this to 0 specifies that the endpoint will never timeout.
endpointxs:string
interfaceNamexs:QName
locationURIxs:stringthe URI to which the endpoint sends requests
proxyHostxs:stringthe host name of the HTTP proxy
proxyPasswordxs:stringthe password for the HTTP proxy authentication
proxyPortxs:integerthe host port of the HTTP proxy (defaults to 80)
proxyUsernamexs:stringthe user name for the HTTP proxy authentication
servicexs:QName
ElementTypeDescription
componentcomponent
definition<spring:bean/>
description<spring:bean/>
marshaler<spring:bean/>the bean used to marshal HTTP messages. The default is a
serviceUnit<spring:bean/>
sslsslParametersthe SSL parameters

Element: proxyParameters

AttributeTypeDescription
proxyHostxs:stringthe proxy's host name
proxyPortxs:integerthe proxy's port number
ElementTypeDescription
proxyCredentialsbasicAuthCredentialsauthentication data for using basic HTTP authentication.

Element: serializedMarshaler

AttributeTypeDescription
defaultMepxs:string

Element: soap-consumer

AttributeTypeDescription
authMethodxs:stringa string naming the scheme used for authenticating users
defaultMepxs:stringa URI representing the endpoint's default MEP. The default is
endpointxs:string
interfaceNamexs:QName
locationURIxs:stringthe URI at which the endpoint listens for requests
servicexs:QName
targetEndpointxs:string
targetInterfacexs:QName
targetOperationxs:QName
targetServicexs:QName
targetUrixs:string
timeoutxs:longthe timeout is specified in milliseconds. The default value is 0 which
useJbiWrapperxs:booleanSpecifies if the JBI wrapper is sent in the body of the message. Default is
validateWsdlxs:booleanSpecifies if the WSDL is checked for WSI-BP compliance. Default is true.
ElementTypeDescription
componentcomponent
definition<spring:bean/>
description<spring:bean/>
marshalerserializedMarshalerthe bean used to marshal HTTP messages. The default is a
policies(<spring:bean/>)*a list of interceptors that will process messages
serviceUnit<spring:bean/>
sslsslParametersa bean containing the SSL configuration properties
wsdl<spring:bean/>the URL of the WSDL document defining the endpoint's messages

Element: soap-provider

AttributeTypeDescription
clientSoTimeoutxs:integerthe number of milliseconds the endpoint will block while attempting to read a request. The default value is 60000. Setting this to 0 specifies that the endpoint will never timeout.
endpointxs:string
interfaceNamexs:QName
locationURIxs:stringthe URI to which the endpoint sends requests
proxyHostxs:stringthe host name of the HTTP proxy
proxyPasswordxs:stringthe password for the HTTP proxy authentication
proxyPortxs:integerthe host port of the HTTP proxy (defaults to 80)
proxyUsernamexs:stringthe user name for the HTTP proxy authentication
servicexs:QName
useJbiWrapperxs:booleanSpecifies if the JBI wrapper is sent in the body of the message. Default is
validateWsdlxs:booleanSpecifies if the WSDL is checked for WSI-BP compliance. Default is true
ElementTypeDescription
componentcomponent
definition<spring:bean/>
description<spring:bean/>
marshaler<spring:bean/>the bean used to marshal HTTP messages. The default is a
policies(<spring:bean/>)*a list of interceptors that will process messages
serviceUnit<spring:bean/>
sslsslParametersthe SSL parameters
wsdl<spring:bean/>the URL of the WSDL document defining the endpoint's messages

Element: sslParameters

AttributeTypeDescription
keyAliasxs:string
keyManagerFactoryAlgorithmxs:string
keyPasswordxs:string
keyStorexs:string
keyStorePasswordxs:string
keyStoreTypexs:string
managedxs:boolean
needClientAuthxs:boolean
protocolxs:string
providerxs:string
trustManagerFactoryAlgorithmxs:string
trustStorexs:string
trustStorePasswordxs:string
trustStoreTypexs:string
wantClientAuthxs:boolean