org.apache.camel.component.box

Class BoxComponent

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultComponent

org.apache.camel.impl.UriEndpointComponent

org.apache.camel.util.component.AbstractApiComponent<BoxApiName,BoxConfiguration,BoxApiCollection>

org.apache.camel.component.box.BoxComponent

All Implemented Interfaces:

CamelContextAware, Component, Service, ShutdownableService, EndpointCompleter, StatefulService, SuspendableService

public class BoxComponent
extends AbstractApiComponent<BoxApiName,BoxConfiguration,BoxApiCollection>

Represents the component that manages BoxEndpoint.

Field Summary

Fields inherited from class org.apache.camel.util.component.AbstractApiComponent

apiNameClass, collection, configuration

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

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

Constructor Summary

Constructors

Constructor and Description
BoxComponent()
BoxComponent(CamelContext context)

Method Summary

Modifier and Type	Method and Description
protected Endpoint	createEndpoint(String uri, String methodName, BoxApiName apiName, BoxConfiguration endpointConfiguration)
void	doShutdown() Implementations override this method to perform customized shutdown.
protected void	doStart() Implementations override this method to support customized start/stop.
protected void	doStop() Implementations override this method to support customized start/stop.
protected BoxApiName	getApiName(String apiNameStr)
CachedBoxClient	getBoxClient()
BoxConfiguration	getConfiguration() To use the shared configuration
void	setConfiguration(BoxConfiguration configuration) To use the shared configuration

Methods inherited from class org.apache.camel.util.component.AbstractApiComponent

completeEndpointPath, createEndpoint, createEndpointConfiguration, getApiNameOrNull, getCompletedMethods

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

createComponentConfiguration, createParameterConfigurationMap, getEndpointClass, getParameterConfigurationMap, populateParameterConfigurationMap, setEndpointClass

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

afterConfiguration, createConfiguration, createEndpoint, getAndRemoveOrResolveReferenceParameter, getAndRemoveOrResolveReferenceParameter, getAndRemoveParameter, getAndRemoveParameter, getCamelContext, ifStartsWithReturnRemainder, preProcessUri, resolveAndRemoveReferenceListParameter, resolveAndRemoveReferenceListParameter, resolveAndRemoveReferenceParameter, resolveAndRemoveReferenceParameter, setCamelContext, setProperties, setProperties, useIntrospectionOnEndpoint, useRawUri, validateParameters, validateURI

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

BoxComponent

public BoxComponent()

BoxComponent

public BoxComponent(CamelContext context)

Method Detail

getApiName

protected BoxApiName getApiName(String apiNameStr)
                         throws IllegalArgumentException

Specified by:

getApiName in class AbstractApiComponent<BoxApiName,BoxConfiguration,BoxApiCollection>

Throws:

IllegalArgumentException

createEndpoint

protected Endpoint createEndpoint(String uri,
                                  String methodName,
                                  BoxApiName apiName,
                                  BoxConfiguration endpointConfiguration)

Specified by:

createEndpoint in class AbstractApiComponent<BoxApiName,BoxConfiguration,BoxApiCollection>

getBoxClient

public CachedBoxClient getBoxClient()

setConfiguration

public void setConfiguration(BoxConfiguration configuration)

To use the shared configuration

Overrides:

setConfiguration in class AbstractApiComponent<BoxApiName,BoxConfiguration,BoxApiCollection>

getConfiguration

public BoxConfiguration getConfiguration()

To use the shared configuration

Overrides:

getConfiguration in class AbstractApiComponent<BoxApiName,BoxConfiguration,BoxApiCollection>

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 DefaultComponent

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 DefaultComponent

Throws:

Exception

See Also:

ServiceSupport.doStart()

doShutdown

public void doShutdown()
                throws Exception

Description copied from class: ServiceSupport

Implementations override this method to perform customized shutdown.

Overrides:

doShutdown in class ServiceSupport

Throws:

Exception