Package org.apache.camel.component.resteasy

Class ResteasyEndpoint

  • All Implemented Interfaces:
    AutoCloseable, org.apache.camel.CamelContextAware, org.apache.camel.cloud.DiscoverableService, 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.4.0",
             scheme="resteasy",
             extendsScheme="http",
             title="Resteasy",
             syntax="resteasy:httpUri",
             category=REST,
             headersClass=ResteasyConstants.class)
@Metadata(excludeProperties="clientConnectionManager,connectionsPerRoute,connectionTimeToLive,httpBinding,httpClientConfigurer,httpConfiguration,httpContext,httpRegistry,maxTotalConnections,connectionRequestTimeout,connectTimeout,socketTimeout,cookieStore,x509HostnameVerifier,sslContextParameters,clientBuilder,httpClient,httpClientOptions,proxyHost,proxyMethod,proxyPort,authDomain,authenticationPreemptive,authHost,authMethod,authMethodPriority,authPassword,authUsername,basicAuth,proxyAuthScheme,proxyAuthMethod,proxyAuthUsername,proxyAuthPassword,proxyAuthHost,proxyAuthPort,proxyAuthDomain,proxyAuthNtHost")
public class ResteasyEndpoint
extends org.apache.camel.component.http.HttpEndpoint
    Expose REST endpoints and access external REST servers.

    • Field Summary

      • Fields inherited from class org.apache.camel.component.http.HttpEndpoint

        sslContextParameters

      • 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
      protected String buildUri()
      Building the final URI from endpoint, which will be used in the Camel-Resteasy producer for Resteasy client.
      org.apache.camel.Consumer createConsumer​(org.apache.camel.Processor processor)  
      org.apache.camel.Producer createProducer()  
      Boolean getBasicAuth()  
      org.apache.camel.spi.HeaderFilterStrategy getHeaderFilterStrategy()  
      String getHost()  
      String getPassword()  
      int getPort()  
      String getProtocol()  
      String getProxyClientClass()  
      String getProxyMethod()  
      String getResteasyMethod()  
      String getServletName()  
      Boolean getSetHttpResponseDuringProcessing()  
      Boolean getSkipServletProcessing()  
      String getUriPattern()  
      String getUsername()  
      void setBasicAuth​(Boolean basicAuth)
      Sets the flag to basicAuth on endpoint
      void setHeaderFilterStrategy​(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)  
      void setHost​(String host)
      Sets the host
      void setPassword​(String password)
      Sets the password
      void setPort​(int port)
      Sets the port
      void setProtocol​(String protocol)
      Sets the protocol
      void setProxyClientClass​(String proxyClientClass)
      Sets the resteasy proxyClientClass
      void setProxyMethod​(String proxyMethod)
      Sets the proxy method defined in an interface
      void setResteasyMethod​(String resteasyMethod)
      Sets the resteasy method to process the request
      void setServletName​(String servletName)
      Sets the servlet name
      void setSetHttpResponseDuringProcessing​(Boolean setHttpResponseDuringProcessing)
      Sets the flag to use the endpoint where you can either populate camel exchange from servlet response or use request itself which may be thought as if it is a proxy.
      void setSkipServletProcessing​(Boolean skipServletProcessing)
      Sets the flag to use skip servlet processing and let camel take over processing
      void setUriPattern​(String uriPattern)
      Sets the uriPattern
      void setUsername​(String username)
      Sets the username

      • Methods inherited from class org.apache.camel.component.http.HttpEndpoint

        createHttpClient, createPollingConsumer, doStop, getClientBuilder, getClientConnectionManager, getClientConnectionsPoolStatsAvailable, getClientConnectionsPoolStatsLeased, getClientConnectionsPoolStatsMax, getClientConnectionsPoolStatsPending, getComponent, getConnectionRequestTimeout, getConnectionsPerRoute, getConnectTimeout, getCookieStore, getCustomHostHeader, getHttpClient, getHttpClientConfigurer, getHttpClientOptions, getHttpContext, getMaxTotalConnections, getSocketTimeout, getSslContextParameters, getUserAgent, getX509HostnameVerifier, isAuthenticationPreemptive, isClearExpiredCookies, isDeleteWithBody, isFollowRedirects, isGetWithBody, isSkipRequestHeaders, isSkipResponseHeaders, isUseSystemProperties, setAuthenticationPreemptive, setClearExpiredCookies, setClientBuilder, setClientConnectionManager, setConnectionRequestTimeout, setConnectionsPerRoute, setConnectTimeout, setCookieHandler, setCookieStore, setCustomHostHeader, setDeleteWithBody, setFollowRedirects, setGetWithBody, setHttpClient, setHttpClientConfigurer, setHttpClientOptions, setHttpContext, setMaxTotalConnections, setSkipRequestHeaders, setSkipResponseHeaders, setSocketTimeout, setSslContextParameters, setUserAgent, setUseSystemProperties, setX509HostnameVerifier

      • Methods inherited from class org.apache.camel.http.common.HttpCommonEndpoint

        canConnect, connect, disconnect, getAuthDomain, getAuthHost, getAuthMethod, getAuthMethodPriority, getAuthPassword, getAuthUsername, getBinding, getCookieHandler, getHttpBinding, getHttpMethod, getHttpMethodRestrict, getHttpUri, getOkStatusCodeRange, getPath, getProxyAuthDomain, getProxyAuthHost, getProxyAuthMethod, getProxyAuthNtHost, getProxyAuthPassword, getProxyAuthPort, getProxyAuthScheme, getProxyAuthUsername, getProxyHost, getProxyPort, getResponseBufferSize, getServiceProperties, isAsync, isBridgeEndpoint, isChunked, isConnectionClose, isCopyHeaders, isDisableStreamCache, isEagerCheckContentAvailable, isIgnoreResponseBody, isLenientProperties, isMapHttpMessageBody, isMapHttpMessageFormUrlEncodedBody, isMapHttpMessageHeaders, isMatchOnUriPrefix, isMuteException, isOptionsEnabled, isPreserveHostHeader, isThrowExceptionOnFailure, isTraceEnabled, isTransferException, setAsync, setAuthDomain, setAuthHost, setAuthMethod, setAuthMethodPriority, setAuthPassword, setAuthUsername, setBridgeEndpoint, setChunked, setConnectionClose, setCopyHeaders, setDisableStreamCache, setEagerCheckContentAvailable, setHttpBinding, setHttpMethod, setHttpMethodRestrict, setHttpUri, setIgnoreResponseBody, setMapHttpMessageBody, setMapHttpMessageFormUrlEncodedBody, setMapHttpMessageHeaders, setMatchOnUriPrefix, setMuteException, setOkStatusCodeRange, setOptionsEnabled, setPreserveHostHeader, setProxyAuthDomain, setProxyAuthHost, setProxyAuthMethod, setProxyAuthNtHost, setProxyAuthPassword, setProxyAuthPort, setProxyAuthScheme, setProxyAuthUsername, setProxyHost, setProxyPort, setResponseBufferSize, setThrowExceptionOnFailure, setTraceEnabled, setTransferException

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

        configureConsumer, configureExchange, configurePollingConsumer, configureProperties, createAsyncProducer, createEndpointUri, createExchange, createExchange, doInit, doStart, equals, getCamelContext, getEndpointKey, getEndpointUri, getExceptionHandler, getExchangePattern, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, hashCode, isAutowiredEnabled, isBridgeErrorHandler, isLazyStartProducer, 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

        getEndpointBaseUri, isSingletonProducer

      • 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

    • Method Detail

      • createProducer

        public org.apache.camel.Producer createProducer()
                                         throws Exception
        Specified by:
        createProducer in interface org.apache.camel.Endpoint
        Overrides:
        createProducer in class org.apache.camel.component.http.HttpEndpoint
        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
        Overrides:
        createConsumer in class org.apache.camel.component.http.HttpEndpoint
        Throws:
        Exception

      • getHeaderFilterStrategy

        public org.apache.camel.spi.HeaderFilterStrategy getHeaderFilterStrategy()
        Specified by:
        getHeaderFilterStrategy in interface org.apache.camel.spi.HeaderFilterStrategyAware
        Overrides:
        getHeaderFilterStrategy in class org.apache.camel.http.common.HttpCommonEndpoint

      • setHeaderFilterStrategy

        public void setHeaderFilterStrategy​(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)
        Specified by:
        setHeaderFilterStrategy in interface org.apache.camel.spi.HeaderFilterStrategyAware
        Overrides:
        setHeaderFilterStrategy in class org.apache.camel.http.common.HttpCommonEndpoint

      • getProxyMethod

        public String getProxyMethod()

      • setProxyMethod

        public void setProxyMethod​(String proxyMethod)
        Sets the proxy method defined in an interface

      • getSetHttpResponseDuringProcessing

        public Boolean getSetHttpResponseDuringProcessing()

      • setSetHttpResponseDuringProcessing

        public void setSetHttpResponseDuringProcessing​(Boolean setHttpResponseDuringProcessing)
        Sets the flag to use the endpoint where you can either populate camel exchange from servlet response or use request itself which may be thought as if it is a proxy.

      • getSkipServletProcessing

        public Boolean getSkipServletProcessing()

      • setSkipServletProcessing

        public void setSkipServletProcessing​(Boolean skipServletProcessing)
        Sets the flag to use skip servlet processing and let camel take over processing

      • getProxyClientClass

        public String getProxyClientClass()

      • setProxyClientClass

        public void setProxyClientClass​(String proxyClientClass)
        Sets the resteasy proxyClientClass

      • getServletName

        public String getServletName()

      • setServletName

        public void setServletName​(String servletName)
        Sets the servlet name

      • getResteasyMethod

        public String getResteasyMethod()

      • setResteasyMethod

        public void setResteasyMethod​(String resteasyMethod)
        Sets the resteasy method to process the request

      • getProtocol

        public String getProtocol()
        Overrides:
        getProtocol in class org.apache.camel.http.common.HttpCommonEndpoint

      • setProtocol

        public void setProtocol​(String protocol)
        Sets the protocol

      • getHost

        public String getHost()

      • setHost

        public void setHost​(String host)
        Sets the host

      • getPort

        public int getPort()
        Overrides:
        getPort in class org.apache.camel.http.common.HttpCommonEndpoint

      • setPort

        public void setPort​(int port)
        Sets the port

      • getUriPattern

        public String getUriPattern()

      • setUriPattern

        public void setUriPattern​(String uriPattern)
        Sets the uriPattern

      • getBasicAuth

        public Boolean getBasicAuth()

      • setBasicAuth

        public void setBasicAuth​(Boolean basicAuth)
        Sets the flag to basicAuth on endpoint

      • getUsername

        public String getUsername()

      • setUsername

        public void setUsername​(String username)
        Sets the username

      • getPassword

        public String getPassword()

      • setPassword

        public void setPassword​(String password)
        Sets the password

      • buildUri

        protected String buildUri()
        Building the final URI from endpoint, which will be used in the Camel-Resteasy producer for Resteasy client.