org.apache.camel.component.box

Class BoxConsumer

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultConsumer

org.apache.camel.component.box.BoxConsumer

All Implemented Interfaces:

EventCallback, Consumer, EndpointAware, RouteAware, Service, ShutdownableService, StatefulService, SuspendableService, PropertyNamesInterceptor, ResultInterceptor

public class BoxConsumer
extends DefaultConsumer
implements PropertyNamesInterceptor, ResultInterceptor, EventCallback

The Box consumer.

Field Summary

Fields inherited from class org.apache.camel.impl.DefaultConsumer

log

Fields inherited from class org.apache.camel.support.ServiceSupport

shutdown, shuttingdown, started, starting, stopped, stopping, suspended, suspending

Constructor Summary

Constructors

Constructor and Description
BoxConsumer(BoxEndpoint endpoint, Processor processor)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doStart() Implementations override this method to support customized start/stop.
protected void	doStop() Implementations override this method to support customized start/stop.
void	interceptPropertyNames(Set<String> propertyNames) Intercept property names used to find API Method.
void	interceptResult(Object result, Exchange resultExchange) Do additional result exchange processing, for example, adding custom headers.
boolean	isSplitResult()
void	onEvent(com.box.boxjavalibv2.dao.BoxEventCollection events)
void	onException(Exception e)
void	setSplitResult(boolean splitResult)
Object	splitResult(Object result) Split a complex result into result elements.

Methods inherited from class org.apache.camel.impl.DefaultConsumer

createUoW, doneUoW, getAsyncProcessor, getEndpoint, getExceptionHandler, getProcessor, getRoute, handleException, handleException, setExceptionHandler, setRoute, toString

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

doResume, doShutdown, doSuspend, getStatus, getVersion, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, resume, shutdown, start, stop, suspend

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.camel.Service

start, stop

Constructor Detail

BoxConsumer

public BoxConsumer(BoxEndpoint endpoint,
           Processor processor)

Method Detail

interceptPropertyNames

public void interceptPropertyNames(Set<String> propertyNames)

Description copied from interface: PropertyNamesInterceptor

Intercept property names used to find API Method. Used to add any custom/hidden method arguments, which MUST be provided in interceptProperties() override.

Specified by:

interceptPropertyNames in interface PropertyNamesInterceptor

Parameters:

propertyNames - argument names.

onEvent

public void onEvent(com.box.boxjavalibv2.dao.BoxEventCollection events)
             throws Exception

Specified by:

onEvent in interface EventCallback

Throws:

Exception

onException

public void onException(Exception e)

Specified by:

onException in interface EventCallback

doStart

protected void doStart()
                throws Exception

Description copied from class: ServiceSupport

Implementations override this method to support customized start/stop.

Important: See ServiceSupport.doStop() for more details.

Overrides:

doStart in class DefaultConsumer

Throws:

Exception

See Also:

ServiceSupport.doStop()

doStop

protected void doStop()
               throws Exception

Description copied from class: ServiceSupport

Implementations override this method to support customized start/stop.

Important: Camel will invoke this ServiceSupport.doStop() method when the service is being stopped. This method will also be invoked if the service is still in uninitialized state (eg has not been started). The method is always called to allow the service to do custom logic when the service is being stopped, such as when CamelContext is shutting down.

Overrides:

doStop in class DefaultConsumer

Throws:

Exception

See Also:

ServiceSupport.doStart()

isSplitResult

public boolean isSplitResult()

setSplitResult

public void setSplitResult(boolean splitResult)

splitResult

public Object splitResult(Object result)

Description copied from interface: ResultInterceptor

Split a complex result into result elements.

Specified by:

splitResult in interface ResultInterceptor

Parameters:

result - API method invocation result

Returns:

either the same result if it cannot be split, or an array object with split results

interceptResult

public void interceptResult(Object result,
                   Exchange resultExchange)

Description copied from interface: ResultInterceptor

Do additional result exchange processing, for example, adding custom headers.

Specified by:

interceptResult in interface ResultInterceptor

Parameters:

result - result of API method invocation.

resultExchange - result as a Camel exchange, may be a split result from Arrays or Collections.