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

Class PlatformHttpEndpoint

  • All Implemented Interfaces:
    AutoCloseable, org.apache.camel.AsyncEndpoint, org.apache.camel.CamelContextAware, org.apache.camel.Endpoint, org.apache.camel.IsSingleton, org.apache.camel.Service, org.apache.camel.ShutdownableService, 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)
public class PlatformHttpEndpoint
extends org.apache.camel.support.DefaultEndpoint
implements org.apache.camel.AsyncEndpoint, org.apache.camel.spi.HeaderFilterStrategyAware
    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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      org.apache.camel.Consumer createConsumer​(org.apache.camel.Processor processor)  
      org.apache.camel.Producer createProducer()  
      PlatformHttpComponent getComponent()  
      String getConsumes()  
      String getFileNameExtWhitelist()  
      org.apache.camel.spi.HeaderFilterStrategy getHeaderFilterStrategy()  
      String getHttpMethodRestrict()  
      String getPath()  
      PlatformHttpEngine getPlatformHttpEngine()  
      String getProduces()  
      boolean isHttpProxy()  
      boolean isMatchOnUriPrefix()  
      boolean isMuteException()  
      void setConsumes​(String consumes)  
      void setFileNameExtWhitelist​(String fileNameExtWhitelist)  
      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 setProduces​(String produces)  

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

        configureConsumer, configureExchange, configurePollingConsumer, configureProperties, createAsyncProducer, createEndpointUri, createExchange, createExchange, createPollingConsumer, doInit, doStart, doStop, 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, doSuspend, fail, getStatus, init, isBuild, isInit, isNew, isRunAllowed, isShutdown, isStarted, isStarting, isStartingOrStarted, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

      • Methods inherited from interface org.apache.camel.Endpoint

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

      • 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 Detail

      • PlatformHttpEndpoint

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

    • Method Detail

      • getComponent

        public PlatformHttpComponent getComponent()
        Overrides:
        getComponent in class org.apache.camel.support.DefaultEndpoint

      • createProducer

        public org.apache.camel.Producer createProducer()
                                         throws Exception
        Specified by:
        createProducer in interface org.apache.camel.Endpoint
        Throws:
        Exception

      • createConsumer

        public org.apache.camel.Consumer createConsumer​(org.apache.camel.Processor processor)
                                         throws Exception
        Specified by:
        createConsumer in interface org.apache.camel.Endpoint
        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()

      • 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)

      • isHttpProxy

        public boolean isHttpProxy()