org.apache.camel.component.ref

Class RefComponent

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultComponent

org.apache.camel.component.ref.RefComponent

All Implemented Interfaces:

CamelContextAware, Component, Service, ShutdownableService, StatefulService, SuspendableService

public class RefComponent
extends DefaultComponent

Component for lookup of existing endpoints bound in the Registry.

This component uses the ref: notation instead of the mostly common uri: notation.

Field Summary

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

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

Constructor Summary

Constructors

Constructor and Description
RefComponent()

Method Summary

Methods

Modifier and Type	Method and Description
protected Endpoint	createEndpoint(String uri, String remaining, Map<String,Object> parameters) A factory method allowing derived components to create a new endpoint from the given URI, remaining path and optional parameters
protected Endpoint	lookupEndpoint(String name, Map<String,Object> parameters) Looks up a mandatory endpoint for a given name.

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

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

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, toString, wait, wait, wait

Constructor Detail

RefComponent

public RefComponent()

Method Detail

createEndpoint

protected Endpoint createEndpoint(String uri,
                      String remaining,
                      Map<String,Object> parameters)
                           throws Exception

Description copied from class: DefaultComponent

A factory method allowing derived components to create a new endpoint from the given URI, remaining path and optional parameters

Specified by:

createEndpoint in class DefaultComponent

Parameters:

uri - the full URI of the endpoint

remaining - the remaining part of the URI without the query parameters or component prefix

parameters - the optional parameters passed in

Returns:

a newly created endpoint or null if the endpoint cannot be created based on the inputs

Throws:

Exception - is thrown if error creating the endpoint

lookupEndpoint

protected Endpoint lookupEndpoint(String name,
                      Map<String,Object> parameters)

Looks up a mandatory endpoint for a given name.

Derived classes could use this name as a logical name and look it up on some registry.

The default implementation will do a mandatory look up the name in the Registry.

Throws:

NoSuchBeanException - if not found in the Registry