org.apache.camel.component.file
Class GenericFileComponent<T>

java.lang.Object
  org.apache.camel.support.ServiceSupport
      org.apache.camel.impl.DefaultComponent
          org.apache.camel.component.file.GenericFileComponent<T>

All Implemented Interfaces:

CamelContextAware, Component, Service, ShutdownableService, StatefulService, SuspendableService

Direct Known Subclasses:

FileComponent

public abstract class GenericFileComponent<T>
extends DefaultComponent

Base class file component. To be extended.

Field Summary

protected org.slf4j.Logger

log

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

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

Constructor Summary

GenericFileComponent()

GenericFileComponent(CamelContext context)

Method Summary

protected abstract void	afterPropertiesSet(GenericFileEndpoint<T> endpoint) A factory method for derived file components to perform validation of properties
protected abstract GenericFileEndpoint<T>	buildFileEndpoint(String uri, String remaining, Map<String,Object> parameters) A factory method for derived file components to create the endpoint
protected GenericFileEndpoint<T>	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

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

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

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

doResume, doShutdown, doSuspend, getStatus, getVersion, isRunAllowed, isStarted, isStarting, isStopped, isStopping, 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

Field Detail

log

protected org.slf4j.Logger log

Constructor Detail

GenericFileComponent

public GenericFileComponent()

GenericFileComponent

public GenericFileComponent(CamelContext context)

Method Detail

createEndpoint

protected GenericFileEndpoint<T> 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

buildFileEndpoint

protected abstract GenericFileEndpoint<T> buildFileEndpoint(String uri,
                                                            String remaining,
                                                            Map<String,Object> parameters)
                                                     throws Exception

A factory method for derived file components to create the endpoint

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 - can be thrown

afterPropertiesSet

protected abstract void afterPropertiesSet(GenericFileEndpoint<T> endpoint)
                                    throws Exception

A factory method for derived file components to perform validation of properties

Parameters:

endpoint - the endpoint

Throws:

Exception - can be thrown in case of validation errors