Package org.apache.camel.component.netty

Class NettyEndpoint

java.lang.Object
org.apache.camel.support.service.BaseService
org.apache.camel.support.service.ServiceSupport
org.apache.camel.support.DefaultEndpoint
org.apache.camel.component.netty.NettyEndpoint
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.StatefulService, org.apache.camel.SuspendableService
@UriEndpoint(firstVersion="2.14.0", scheme="netty", title="Netty", syntax="netty:protocol://host:port", category=NETWORKING, headersClass=NettyConstants.class) public class NettyEndpoint extends org.apache.camel.support.DefaultEndpoint implements org.apache.camel.AsyncEndpoint, org.apache.camel.spi.EndpointServiceLocation
Socket level networking using TCP or UDP with Netty 4.x.

  • 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
    NettyEndpoint(String endpointUri, NettyComponent component, NettyConfiguration configuration)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.apache.camel.Consumer
    createConsumer(org.apache.camel.Processor processor)
     
    protected String
    createEndpointUri()
     
    org.apache.camel.Producer
    createProducer()
     
    protected void
    enrichWithClientCertInformation(SSLSession sslSession, org.apache.camel.Message message)
    Enriches the message with client certificate details such as subject name, serial number etc.
    NettyComponent
    getComponent()
     
    NettyConfiguration
    getConfiguration()
     
    String
    getServiceProtocol()
     
    String
    getServiceUrl()
     
    protected SSLSession
    getSSLSession(io.netty.channel.ChannelHandlerContext ctx)
     
    boolean
    isSynchronous()
     
    void
    setConfiguration(NettyConfiguration configuration)
     
    void
    setSynchronous(boolean synchronous)
    Sets whether synchronous processing should be strictly used
    void
    updateMessageHeader(org.apache.camel.Message in, io.netty.channel.ChannelHandlerContext ctx)
     

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

    configureConsumer, configureExchange, configurePollingConsumer, configureProperties, createAsyncProducer, 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

  • Method Details

    • 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

    • isSynchronous

      public boolean isSynchronous()

    • setSynchronous

      public void setSynchronous(boolean synchronous)
      Sets whether synchronous processing should be strictly used

    • 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

    • createProducer

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

    • getComponent

      public NettyComponent getComponent()
      Specified by:
      getComponent in interface org.apache.camel.ComponentAware
      Overrides:
      getComponent in class org.apache.camel.support.DefaultEndpoint

    • getConfiguration

      public NettyConfiguration getConfiguration()

    • setConfiguration

      public void setConfiguration(NettyConfiguration configuration)

    • createEndpointUri

      protected String createEndpointUri()
      Overrides:
      createEndpointUri in class org.apache.camel.support.DefaultEndpoint

    • getSSLSession

      protected SSLSession getSSLSession(io.netty.channel.ChannelHandlerContext ctx)

    • updateMessageHeader

      public void updateMessageHeader(org.apache.camel.Message in, io.netty.channel.ChannelHandlerContext ctx)

    • enrichWithClientCertInformation

      protected void enrichWithClientCertInformation(SSLSession sslSession, org.apache.camel.Message message)
      Enriches the message with client certificate details such as subject name, serial number etc.

      If the certificate is unverified then the headers is not enriched.

      Parameters:
      sslSession - the SSL session
      message - the message to enrich