Package org.apache.camel.component.platform.http

Class PlatformHttpEndpoint

java.lang.Object

org.apache.camel.support.service.BaseService

org.apache.camel.support.service.ServiceSupport

org.apache.camel.support.DefaultEndpoint

org.apache.camel.component.platform.http.PlatformHttpEndpoint

All Implemented Interfaces:

AutoCloseable, org.apache.camel.AsyncEndpoint, org.apache.camel.CamelContextAware, org.apache.camel.ComponentAware, org.apache.camel.Endpoint, org.apache.camel.IsSingleton, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.EndpointServiceLocation, org.apache.camel.spi.HasCamelContext, org.apache.camel.spi.HasId, org.apache.camel.spi.HeaderFilterStrategyAware, org.apache.camel.StatefulService, org.apache.camel.SuspendableService

@UriEndpoint(firstVersion="3.0.0",
             scheme="platform-http",
             title="Platform HTTP",
             syntax="platform-http:path",
             category=HTTP,
             consumerOnly=true)
@Metadata(annotations="protocol=http")
public class PlatformHttpEndpoint
extends org.apache.camel.support.DefaultEndpoint
implements org.apache.camel.AsyncEndpoint, org.apache.camel.spi.HeaderFilterStrategyAware, org.apache.camel.spi.EndpointServiceLocation

Expose HTTP endpoints using the HTTP server available in the current platform.

Field Summary

Fields inherited from class org.apache.camel.support.service.BaseService

BUILT, FAILED, INITIALIZED, INITIALIZING, lock, NEW, SHUTDOWN, SHUTTING_DOWN, STARTED, STARTING, status, STOPPED, STOPPING, SUSPENDED, SUSPENDING

Constructor Summary

Constructors

Constructor	Description
PlatformHttpEndpoint(String uri, String remaining, org.apache.camel.Component component)

Method Summary

Modifier and Type	Method	Description
DefaultPlatformHttpConsumer	createConsumer(org.apache.camel.Processor processor)
protected PlatformHttpConsumer	createPlatformHttpConsumer(org.apache.camel.Processor processor)
org.apache.camel.Producer	createProducer()
PlatformHttpComponent	getComponent()
String	getConsumes()
CookieConfiguration	getCookieConfiguration()
String	getFileNameExtWhitelist()
org.apache.camel.spi.HeaderFilterStrategy	getHeaderFilterStrategy()
String	getHttpMethodRestrict()
String	getPath()
PlatformHttpEngine	getPlatformHttpEngine()
String	getProduces()
long	getRequestTimeout()
String	getServiceProtocol()
String	getServiceUrl()
boolean	isHandleWriteResponseError()
boolean	isHttpProxy()
boolean	isMatchOnUriPrefix()
boolean	isMuteException()
boolean	isPopulateBodyWithForm()
boolean	isReturnHttpRequestHeaders()
boolean	isUseBodyHandler()
boolean	isUseCookieHandler()
boolean	isUseStreaming()
void	setConsumes(String consumes)
void	setCookieConfiguration(CookieConfiguration cookieConfiguration)
void	setFileNameExtWhitelist(String fileNameExtWhitelist)
void	setHandleWriteResponseError(boolean handleWriteResponseError)
void	setHeaderFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)
void	setHttpMethodRestrict(String httpMethodRestrict)
void	setMatchOnUriPrefix(boolean matchOnUriPrefix)
void	setMuteException(boolean muteException)
void	setPlatformHttpEngine(PlatformHttpEngine platformHttpEngine)
void	setPopulateBodyWithForm(boolean populateBodyWithForm)
void	setProduces(String produces)
void	setRequestTimeout(long requestTimeout)
void	setReturnHttpRequestHeaders(boolean returnHttpRequestHeaders)
void	setUseBodyHandler(boolean useBodyHandler)
void	setUseCookieHandler(boolean useCookieHandler)
void	setUseStreaming(boolean useStreaming)

Methods inherited from class org.apache.camel.support.DefaultEndpoint

configureConsumer, configureExchange, configurePollingConsumer, configureProperties, createAsyncProducer, createEndpointUri, createExchange, createExchange, createPollingConsumer, doInit, equals, getCamelContext, getEndpointKey, getEndpointUri, getExceptionHandler, getExchangePattern, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, hashCode, isAutowiredEnabled, isBridgeErrorHandler, isLazyStartProducer, isLenientProperties, isPollingConsumerBlockWhenFull, isPollingConsumerCopy, isSingleton, setAutowiredEnabled, setBridgeErrorHandler, setCamelContext, setComponent, setEndpointUri, setEndpointUriIfNotSpecified, setExceptionHandler, setExchangePattern, setLazyStartProducer, setPollingConsumerBlockTimeout, setPollingConsumerBlockWhenFull, setPollingConsumerCopy, setPollingConsumerQueueSize, setProperties, toString

Methods inherited from class org.apache.camel.support.service.BaseService

build, doBuild, doFail, doLifecycleChange, doResume, doShutdown, doStart, doStop, doSuspend, fail, getInternalLock, getStatus, init, isBuild, isInit, isNew, isRunAllowed, isShutdown, isStarted, isStarting, isStartingOrStarted, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.camel.ComponentAware

getComponent, setComponent

Methods inherited from interface org.apache.camel.Endpoint

configureExchange, configureProperties, createAsyncProducer, createExchange, createExchange, createPollingConsumer, getCamelContext, getEndpointBaseUri, getEndpointKey, getEndpointUri, getExchangePattern, isLenientProperties, isRemote, isSingletonProducer, setCamelContext

Methods inherited from interface org.apache.camel.spi.EndpointServiceLocation

getServiceMetadata

Methods inherited from interface org.apache.camel.IsSingleton

isSingleton

Methods inherited from interface org.apache.camel.Service

build, close, init, start, stop

Methods inherited from interface org.apache.camel.ShutdownableService

shutdown

Methods inherited from interface org.apache.camel.StatefulService

getStatus, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isSuspending

Methods inherited from interface org.apache.camel.SuspendableService

isSuspended, resume, suspend

Constructor Details

PlatformHttpEndpoint

public PlatformHttpEndpoint(String uri,
 String remaining,
 org.apache.camel.Component component)

Method Details

getComponent

public PlatformHttpComponent getComponent()

Specified by:

getComponent in interface org.apache.camel.ComponentAware

Overrides:

getComponent in class org.apache.camel.support.DefaultEndpoint

getServiceUrl

public String getServiceUrl()

Specified by:

getServiceUrl in interface org.apache.camel.spi.EndpointServiceLocation

getServiceProtocol

public String getServiceProtocol()

Specified by:

getServiceProtocol in interface org.apache.camel.spi.EndpointServiceLocation

createProducer

public org.apache.camel.Producer createProducer()
                                         throws Exception

Specified by:

createProducer in interface org.apache.camel.Endpoint

Throws:

Exception

createConsumer

public DefaultPlatformHttpConsumer createConsumer(org.apache.camel.Processor processor)
                                           throws Exception

Specified by:

createConsumer in interface org.apache.camel.Endpoint

Throws:

Exception

createPlatformHttpConsumer

protected PlatformHttpConsumer createPlatformHttpConsumer(org.apache.camel.Processor processor)
                                                   throws Exception

Throws:

Exception

getHeaderFilterStrategy

public org.apache.camel.spi.HeaderFilterStrategy getHeaderFilterStrategy()

Specified by:

getHeaderFilterStrategy in interface org.apache.camel.spi.HeaderFilterStrategyAware

setHeaderFilterStrategy

public void setHeaderFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)

Specified by:

setHeaderFilterStrategy in interface org.apache.camel.spi.HeaderFilterStrategyAware

getPath

public String getPath()

getPlatformHttpEngine

public PlatformHttpEngine getPlatformHttpEngine()

setPlatformHttpEngine

public void setPlatformHttpEngine(PlatformHttpEngine platformHttpEngine)

isMatchOnUriPrefix

public boolean isMatchOnUriPrefix()

setMatchOnUriPrefix

public void setMatchOnUriPrefix(boolean matchOnUriPrefix)

getHttpMethodRestrict

public String getHttpMethodRestrict()

setHttpMethodRestrict

public void setHttpMethodRestrict(String httpMethodRestrict)

getFileNameExtWhitelist

public String getFileNameExtWhitelist()

setFileNameExtWhitelist

public void setFileNameExtWhitelist(String fileNameExtWhitelist)

getConsumes

public String getConsumes()

setConsumes

public void setConsumes(String consumes)

getProduces

public String getProduces()

setProduces

public void setProduces(String produces)

isMuteException

public boolean isMuteException()

setMuteException

public void setMuteException(boolean muteException)

isUseStreaming

public boolean isUseStreaming()

setUseStreaming

public void setUseStreaming(boolean useStreaming)

getCookieConfiguration

public CookieConfiguration getCookieConfiguration()

setCookieConfiguration

public void setCookieConfiguration(CookieConfiguration cookieConfiguration)

isUseCookieHandler

public boolean isUseCookieHandler()

setUseCookieHandler

public void setUseCookieHandler(boolean useCookieHandler)

isHttpProxy

public boolean isHttpProxy()

isReturnHttpRequestHeaders

public boolean isReturnHttpRequestHeaders()

setReturnHttpRequestHeaders

public void setReturnHttpRequestHeaders(boolean returnHttpRequestHeaders)

isHandleWriteResponseError

public boolean isHandleWriteResponseError()

setHandleWriteResponseError

public void setHandleWriteResponseError(boolean handleWriteResponseError)

isPopulateBodyWithForm

public boolean isPopulateBodyWithForm()

setPopulateBodyWithForm

public void setPopulateBodyWithForm(boolean populateBodyWithForm)

isUseBodyHandler

public boolean isUseBodyHandler()

setUseBodyHandler

public void setUseBodyHandler(boolean useBodyHandler)

getRequestTimeout

public long getRequestTimeout()

setRequestTimeout

public void setRequestTimeout(long requestTimeout)