Package org.apache.camel.component.box

Class BoxEndpoint

  • All Implemented Interfaces:
    AutoCloseable, org.apache.camel.ApiEndpoint, 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.StatefulService, org.apache.camel.support.component.PropertiesInterceptor, org.apache.camel.support.component.PropertyNamesInterceptor, org.apache.camel.SuspendableService
    @UriEndpoint(firstVersion="2.14.0",
             scheme="box",
             title="Box",
             syntax="box:apiName/methodName",
             apiSyntax="apiName/methodName",
             consumerPrefix="consumer",
             category={CLOUD,FILE,API},
             lenientProperties=true)
@Metadata(excludeProperties="startScheduler,initialDelay,delay,timeUnit,useFixedDelay,pollStrategy,runLoggingLevel,sendEmptyMessageWhenIdle,greedy,scheduler,schedulerProperties,scheduledExecutorService,backoffMultiplier,backoffIdleThreshold,backoffErrorThreshold,repeatCount,bridgeErrorHandler")
public class BoxEndpoint
extends org.apache.camel.support.component.AbstractApiEndpoint<BoxApiName,​BoxConfiguration>
    Upload, download and manage files, folders, groups, collaborations, etc. on box.com.

    • Field Summary

      • Fields inherited from class org.apache.camel.support.component.AbstractApiEndpoint

        apiName, inBody, log, methodHelper, methodName

      • 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 void afterConfigureProperties()  
      org.apache.camel.Consumer createConsumer​(org.apache.camel.Processor processor)  
      org.apache.camel.Producer createProducer()  
      protected void doStart()  
      Object getApiProxy​(org.apache.camel.support.component.ApiMethod method, Map<String,​Object> args)  
      com.box.sdk.BoxAPIConnection getBoxConnection()
      The BoxAPIConnection of endpoint.
      BoxComponent getComponent()  
      protected org.apache.camel.support.component.ApiMethodPropertiesHelper<BoxConfiguration> getPropertiesHelper()  
      protected String getThreadProfileName()  

      • Methods inherited from class org.apache.camel.support.component.AbstractApiEndpoint

        configureConsumer, configureProperties, getApiName, getCandidates, getConfiguration, getConfigurationProperties, getConfigurationPropertyNames, getEndpointProperties, getEndpointPropertyNames, getExecutorService, getInBody, getMethodHelper, getMethodName, interceptProperties, interceptPropertyNames, setInBody

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

        configureScheduledPollConsumerProperties, doConfigureConsumer, doStop, getBackoffErrorThreshold, getBackoffIdleThreshold, getBackoffMultiplier, getDefaultDelay, getDelay, getInitialDelay, getPollStrategy, getRepeatCount, getRunLoggingLevel, getScheduledExecutorService, getScheduler, getSchedulerProperties, getTimeUnit, isGreedy, isSendEmptyMessageWhenIdle, isStartScheduler, isUseFixedDelay, setBackoffErrorThreshold, setBackoffIdleThreshold, setBackoffMultiplier, setDelay, setGreedy, setInitialDelay, setPollStrategy, setRepeatCount, setRunLoggingLevel, setScheduledExecutorService, setScheduler, setSchedulerProperties, setSendEmptyMessageWhenIdle, setStartScheduler, setTimeUnit, setUseFixedDelay

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

        configureExchange, configurePollingConsumer, 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, 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, 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

    • Method Detail

      • getComponent

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

      • getBoxConnection

        public com.box.sdk.BoxAPIConnection getBoxConnection()
        The BoxAPIConnection of endpoint.

      • createProducer

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

      • createConsumer

        public org.apache.camel.Consumer createConsumer​(org.apache.camel.Processor processor)
                                         throws Exception
        Throws:
        Exception

      • getPropertiesHelper

        protected org.apache.camel.support.component.ApiMethodPropertiesHelper<BoxConfiguration> getPropertiesHelper()
        Specified by:
        getPropertiesHelper in class org.apache.camel.support.component.AbstractApiEndpoint<BoxApiName,​BoxConfiguration>

      • getThreadProfileName

        protected String getThreadProfileName()
        Specified by:
        getThreadProfileName in class org.apache.camel.support.component.AbstractApiEndpoint<BoxApiName,​BoxConfiguration>

      • afterConfigureProperties

        protected void afterConfigureProperties()
        Specified by:
        afterConfigureProperties in class org.apache.camel.support.component.AbstractApiEndpoint<BoxApiName,​BoxConfiguration>

      • getApiProxy

        public Object getApiProxy​(org.apache.camel.support.component.ApiMethod method,
                          Map<String,​Object> args)
        Specified by:
        getApiProxy in class org.apache.camel.support.component.AbstractApiEndpoint<BoxApiName,​BoxConfiguration>

      • doStart

        protected void doStart()
                throws Exception
        Overrides:
        doStart in class org.apache.camel.support.ScheduledPollEndpoint
        Throws:
        Exception