| Element | Description | Class |
|---|---|---|
| component | a JBI component that interacts with the file system. It hosts endpoints that reads data from and writes data to the file system. | org.apache.servicemix.file.FileComponent |
| poller | A polling endpoint which looks for a file or files in a directory and sends the files into the JBI bus as messages, deleting the files by default when they are processed. | org.apache.servicemix.file.FilePollerEndpoint |
| sender | An endpoint which receives messages from the NMR and writes the message to the file system. | org.apache.servicemix.file.FileSenderEndpoint |
| Element | Type | Description |
|---|---|---|
| endpoints | (poller | sender)* | a list of beans defining the endpoints hosted by the component |
| executor | <spring:bean/> | |
| executorFactory | <spring:bean/> |
| Attribute | Type | Description |
|---|---|---|
| archive | xs:string | the relative path of the directory where processed files will be archived |
| autoCreateDirectory | xs:boolean | specifies if directories are created. The defualt is true. |
| concurrentPolling | xs:boolean | |
| delay | xs:long | |
| deleteFile | xs:boolean | specifies if files are deleted after the endpoint processes them. The defualt is true. |
| endpoint | xs:string | |
| file | xs:string | the relative path of the file to poll. This can be a directory or a file. If it is a directory, all files in the directory, or its subdirectories, will be processed by the endpoint. If it is a file, olny files matching the filename will be processed. |
| firstTime | xs:date | |
| interfaceName | xs:QName | |
| period | xs:long | |
| recursive | xs:boolean | specifies if subdirectories are polled. The defualt is true. |
| service | xs:QName | |
| targetEndpoint | xs:string | |
| targetInterface | xs:QName | |
| targetOperation | xs:QName | |
| targetService | xs:QName | |
| targetUri | xs:string |
| Element | Type | Description |
|---|---|---|
| component | component | |
| definition | <spring:bean/> | |
| description | <spring:bean/> | |
| filter | <spring:bean/> | the bean defining the class implementing the file filtering strategy |
| lockManager | <spring:bean/> | the bean defining the class implementing the file locking strategy |
| marshaler | <spring:bean/> | the bean defining the class used to marshal data from the file system |
| scheduler | <spring:bean/> | |
| serviceUnit | <spring:bean/> |
| Attribute | Type | Description |
|---|---|---|
| append | xs:boolean | specifies if data is appended to existing files. The defualt is false. |
| autoCreateDirectory | xs:boolean | specifies if directories are created. The defualt is true. |
| directory | xs:string | the relative path of the directory to which the endpoint writes files |
| endpoint | xs:string | |
| interfaceName | xs:QName | |
| service | xs:QName | |
| tempFilePrefix | xs:string | a string that will be attached to the begining of any temporary file names. Temporary file names are generated when the endpoint cannot determine the name of the file from the message data. |
| tempFileSuffix | xs:string | a string that will be appended to any temporary file names. Temporary file names are generated when the endpoint cannot determine the name of the file from the message data. |
| Element | Type | Description |
|---|---|---|
| component | component | |
| definition | <spring:bean/> | |
| description | <spring:bean/> | |
| marshaler | <spring:bean/> | the bean defining the class used to marshal messages to the file system |
| serviceUnit | <spring:bean/> |