Package org.apache.camel.component.file
Class FileComponent
- java.lang.Object
-
- org.apache.camel.support.service.BaseService
-
- org.apache.camel.support.service.ServiceSupport
-
- org.apache.camel.support.DefaultComponent
-
- org.apache.camel.component.file.GenericFileComponent<File>
-
- org.apache.camel.component.file.FileComponent
-
- All Implemented Interfaces:
AutoCloseable
,org.apache.camel.CamelContextAware
,org.apache.camel.Component
,org.apache.camel.Service
,org.apache.camel.ShutdownableService
,org.apache.camel.StatefulService
,org.apache.camel.SuspendableService
@Component("file") public class FileComponent extends GenericFileComponent<File>
* The File Component provides access to file systems.
-
-
Field Summary
Fields Modifier and Type Field Description static String
DEFAULT_LOCK_FILE_POSTFIX
Default camel lock filename postfixstatic String
FILE_EXCHANGE_FILE
GenericFile property on Camel Exchanges.-
Fields inherited from class org.apache.camel.component.file.GenericFileComponent
log
-
-
Constructor Summary
Constructors Constructor Description FileComponent()
FileComponent(org.apache.camel.CamelContext context)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
afterPropertiesSet(GenericFileEndpoint<File> endpoint)
A factory method for derived file components to perform validation of propertiesprotected GenericFileEndpoint<File>
buildFileEndpoint(String uri, String remaining, Map<String,Object> parameters)
A factory method for derived file components to create the endpoint-
Methods inherited from class org.apache.camel.component.file.GenericFileComponent
createEndpoint
-
Methods inherited from class org.apache.camel.support.DefaultComponent
afterConfiguration, createEndpoint, createEndpoint, doBuild, doInit, doStart, doStop, getAndRemoveOrResolveReferenceParameter, getAndRemoveOrResolveReferenceParameter, getAndRemoveParameter, getAndRemoveParameter, getCamelContext, getComponentPropertyConfigurer, getDefaultName, getEndpointPropertyConfigurer, getExtension, getSupportedExtensions, ifStartsWithReturnRemainder, isAutowiredEnabled, isBridgeErrorHandler, isLazyStartProducer, registerExtension, registerExtension, resolveAndRemoveReferenceListParameter, resolveAndRemoveReferenceListParameter, resolveAndRemoveReferenceParameter, resolveAndRemoveReferenceParameter, resolveRawParameterValues, setAutowiredEnabled, setBridgeErrorHandler, setCamelContext, setLazyStartProducer, setProperties, setProperties, setProperties, useIntrospectionOnEndpoint, useRawUri, validateParameters, validateURI
-
Methods inherited from class org.apache.camel.support.service.BaseService
build, 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 class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
Field Detail
-
FILE_EXCHANGE_FILE
public static final String FILE_EXCHANGE_FILE
GenericFile property on Camel Exchanges.- See Also:
- Constant Field Values
-
DEFAULT_LOCK_FILE_POSTFIX
public static final String DEFAULT_LOCK_FILE_POSTFIX
Default camel lock filename postfix- See Also:
- Constant Field Values
-
-
Method Detail
-
buildFileEndpoint
protected GenericFileEndpoint<File> buildFileEndpoint(String uri, String remaining, Map<String,Object> parameters) throws Exception
Description copied from class:GenericFileComponent
A factory method for derived file components to create the endpoint- Specified by:
buildFileEndpoint
in classGenericFileComponent<File>
- Parameters:
uri
- the full URI of the endpointremaining
- the remaining part of the URI without the query parameters or component prefixparameters
- 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 void afterPropertiesSet(GenericFileEndpoint<File> endpoint) throws Exception
Description copied from class:GenericFileComponent
A factory method for derived file components to perform validation of properties- Specified by:
afterPropertiesSet
in classGenericFileComponent<File>
- Parameters:
endpoint
- the endpoint- Throws:
Exception
- can be thrown in case of validation errors
-
-