Element Summary

ElementDescriptionClass
componentVFS Componentorg.apache.servicemix.vfs.VFSComponent
pollerA polling endpoint that looks for a file or files in a virtual file system and sends the files to a target service (via the JBI bus), deleting the files by default when they are processed. The polling endpoint uses a file marshaler to send the data as a JBI message; by default this marshaler expects XML payload. For non-XML payload, e.g. plain-text or binary files, use an alternative marshaler such as the org.apache.servicemix.components.util.BinaryFileMarshalerorg.apache.servicemix.vfs.VFSPollingEndpoint
senderAn endpoint which receives messages from the NMR and writes the message to the virtual file system.org.apache.servicemix.vfs.VFSSendingEndpoint

Element Detail

Element: component

ElementTypeDescription
endpoints(poller | sender)*
executorFactory<spring:bean/>The executor factory to use to create the executor. If none is provided, one will be retrieved from the JBI container when the component is deployed into ServiceMix 3.x, or a default implementation will be used.

Element: poller

AttributeTypeDescription
concurrentExchangexs:boolean
concurrentPollingxs:boolean

Sets whether more than one poll can be active at a time (true means yes). Default value is false.

delayxs:long

Sets the amount of time in milliseconds that the endpoint should wait before making the first poll.

deleteFilexs:booleanSpecifies if files should be deleted after they are processed. Default value is true.
endpointxs:string

Get the endpoint implementation.

firstTimexs:date

Sets the date on which the first poll will be executed. If a delay is also set using setDelay, the delay interval will be added after the date specified.

interfaceNamexs:QName

Get the qualified name of the endpoint interface.

pathxs:stringSpecifies a String object representing the path of the file/folder to be polled.

Examples:
  • file:///home/lhein/pollFolder
  • zip:file:///home/lhein/pollFolder/myFile.zip
  • jar:http://www.myhost.com/files/Examples.jar
  • jar:../lib/classes.jar!/META-INF/manifest.mf
  • tar:gz:http://anyhost/dir/mytar.tar.gz!/mytar.tar!/path/in/tar/README.txt
  • tgz:file://anyhost/dir/mytar.tgz!/somepath/somefile
  • gz:/my/gz/file.gz
  • http://myusername@somehost/index.html
  • webdav://somehost:8080/dist
  • ftp://myusername:mypassword@somehost/pub/downloads/somefile.tgz
  • sftp://myusername:mypassword@somehost/pub/downloads/somefile.tgz
  • smb://somehost/home
  • tmp://dir/somefile.txt
  • res:path/in/classpath/image.png
  • ram:///any/path/to/file.txt
  • mime:file:///your/path/mail/anymail.mime!/filename.pdf
For further details have a look at {@link http://commons.apache.org/vfs/filesystems.html}.

periodxs:long

Sets the number of milliseconds between polling attempts.

recursivexs:boolean
servicexs:QName

Get the service qualified name of the endpoint.

targetEndpointxs:stringthe name of the endpoint to which requests are sent
targetInterfacexs:QNamethe QName of the interface to which requests are sent
targetOperationxs:QNamethe QName of the operation to which requests are sent
targetServicexs:QNamethe QName of the service to which requests are sent
targetUrixs:string

Gets the target URI of the consumer endpoint.

ElementTypeDescription
comparator<spring:bean/>Specifies a Comparator object.
componentcomponentthe default component
fileSystemManager<spring:bean/>sets the file system manager
lockManager<spring:bean/>Bean defining the class implementing the file locking strategy. This bean must be an implementation of the org.apache.servicemix.locks.LockManager interface. By default, this will be set to an instances of org.apache.servicemix.common.locks.impl.SimpleLockManager.
marshaler<spring:bean/>Specifies a FileMarshaler object that will marshal file data into the NMR. The default file marshaller can read valid XML data. FileMarshaler objects are implementations of org.apache.servicemix.components.util.FileMarshaler.
scheduler<spring:bean/>

Sets a custom scheduler implementation if you need more fine-grained control over the polling schedule.

selector<spring:bean/>Specifies a FileSelector object.
serviceUnit<spring:bean/>the service unit

Element: sender

AttributeTypeDescription
endpointxs:string

Get the endpoint implementation.

interfaceNamexs:QName

Get the qualified name of the endpoint interface.

pathxs:stringSpecifies a String object representing the path of the file/folder to be polled.

Examples:
  • file:///home/lhein/pollFolder
  • zip:file:///home/lhein/pollFolder/myFile.zip
  • jar:http://www.myhost.com/files/Examples.jar
  • jar:../lib/classes.jar!/META-INF/manifest.mf
  • tar:gz:http://anyhost/dir/mytar.tar.gz!/mytar.tar!/path/in/tar/README.txt
  • tgz:file://anyhost/dir/mytar.tgz!/somepath/somefile
  • gz:/my/gz/file.gz
  • http://myusername@somehost/index.html
  • webdav://somehost:8080/dist
  • ftp://myusername:mypassword@somehost/pub/downloads/somefile.tgz
  • sftp://myusername:mypassword@somehost/pub/downloads/somefile.tgz
  • smb://somehost/home
  • tmp://dir/somefile.txt
  • res:path/in/classpath/image.png
  • ram:///any/path/to/file.txt
  • mime:file:///your/path/mail/anymail.mime!/filename.pdf
For further details have a look at {@link http://commons.apache.org/vfs/filesystems.html}.

servicexs:QName

Get the service qualified name of the endpoint.

ElementTypeDescription
fileSystemManager<spring:bean/>sets the file system manager
marshaler<spring:bean/>Specifies a FileMarshaler object that will marshal file data into the NMR. The default file marshaller can read valid XML data. FileMarshaler objects are implementations of org.apache.servicemix.components.util.FileMarshaler.