org.apache.camel.component.file

Class FileComponent

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultComponent

org.apache.camel.impl.UriEndpointComponent

org.apache.camel.component.file.GenericFileComponent<File>

org.apache.camel.component.file.FileComponent

All Implemented Interfaces:

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

public class FileComponent
extends GenericFileComponent<File>
implements EndpointCompleter

* The File Component provides access to file systems.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_LOCK_FILE_POSTFIX Default camel lock filename postfix
static String	FILE_EXCHANGE_FILE GenericFile property on Camel Exchanges.

Fields inherited from class org.apache.camel.component.file.GenericFileComponent

log

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

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

Constructor Summary

Constructors

Constructor and Description
FileComponent()
FileComponent(CamelContext context)

Method Summary

Modifier and Type	Method and Description
protected void	afterPropertiesSet(GenericFileEndpoint<File> endpoint) A factory method for derived file components to perform validation of properties
protected GenericFileEndpoint<File>	buildFileEndpoint(String uri, String remaining, Map<String,Object> parameters) A factory method for derived file components to create the endpoint
List<String>	completeEndpointPath(ComponentConfiguration configuration, String completionText) Given the configuration and completion text, return a list of possible completion values for a command line, IDE or web based tool.
protected boolean	isValidEndpointCompletion(ComponentConfiguration configuration, String completionText, File file) Returns true if this is a valid file for completion.

Methods inherited from class org.apache.camel.component.file.GenericFileComponent

createEndpoint

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, doStart, doStop, getAndRemoveOrResolveReferenceParameter, getAndRemoveOrResolveReferenceParameter, getAndRemoveParameter, getAndRemoveParameter, getCamelContext, getExtension, getSupportedExtensions, ifStartsWithReturnRemainder, isResolvePropertyPlaceholders, preProcessUri, registerExtension, registerExtension, resolveAndRemoveReferenceListParameter, resolveAndRemoveReferenceListParameter, resolveAndRemoveReferenceParameter, resolveAndRemoveReferenceParameter, setCamelContext, setProperties, setProperties, setResolvePropertyPlaceholders, 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, 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

Constructor Detail

FileComponent

public FileComponent()

FileComponent

public FileComponent(CamelContext context)

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 class GenericFileComponent<File>

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 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 class GenericFileComponent<File>

Parameters:

endpoint - the endpoint

Throws:

Exception - can be thrown in case of validation errors

completeEndpointPath

public List<String> completeEndpointPath(ComponentConfiguration configuration,
                                         String completionText)

Description copied from interface: EndpointCompleter

Given the configuration and completion text, return a list of possible completion values for a command line, IDE or web based tool.

Specified by:

completeEndpointPath in interface EndpointCompleter

Returns:

the list of completion values if any (rather like bash completion, prefix values can be returned - such as just the directories in the current path rather than returning every possible file name on a disk).

isValidEndpointCompletion

protected boolean isValidEndpointCompletion(ComponentConfiguration configuration,
                                            String completionText,
                                            File file)

Returns true if this is a valid file for completion. By default we should ignore files that start with a "."