Fuse ESB Enterprise 7.0 XML Schemas

http://servicemix.apache.org/vfs/1.0
element poller

Model
<poller
  comparator = string
  component = string
  concurrentExchange = boolean
  concurrentPolling = boolean
  delay = long
  deleteFile = boolean
  endpoint = string
  fileSystemManager = string
  firstTime = date
  id = ID
  interfaceName = QName
  lockManager = string
  marshaler = string
  path = string
  period = long
  recursive = boolean
  scheduler = string
  selector = string
  service = QName
  serviceUnit = string
  targetEndpoint = string
  targetInterface = QName
  targetOperation = QName
  targetService = QName
  targetUri = string
  (any attribute from any namespace other than http://servicemix.apache.org/vfs/1.0)>
comparator?, component?, fileSystemManager?, lockManager?, marshaler?, scheduler?, selector?, serviceUnit?, (any element from any namespace other than http://servicemix.apache.org/vfs/1.0)
</poller>
Disallowed substitutions (block)
none (extensions, restrictions and substitutions are allowed)
Substitution group exclusion (final)
none (extensions and restrictions are allowed)
Content Type
element-only content, not nillable.
Usage
This element can be the root element of XML instance documents.
This element can be a child of the following elements: component/endpoints, component/endpoints, component/endpoints, component/endpoints, component/endpoints, component/endpoints.
Documentation
        A 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
<code>org.apache.servicemix.components.util.BinaryFileMarshaler</code>
      

Nested Element Summary
sequence
anonymous type derived from anyTypecomparator optional
           Specifies a <code>Comparator</code> object.
anonymous type derived from anyTypecomponent optional
           the default component
anonymous type derived from anyTypefileSystemManager optional
           sets the file system manager
anonymous type derived from anyTypelockManager optional
          Bean defining the class implementing the file locking strategy.
anonymous type derived from anyTypemarshaler optional
          Specifies a <code>FileMarshaler</code> object that will marshal file data into the NMR.
anonymous type derived from anyTypescheduler optional
          <p> Sets a custom scheduler implementation if you need more fine-grained control over the polling schedule.
anonymous type derived from anyTypeselector optional
           Specifies a <code>FileSelector</code> object.
anonymous type derived from anyTypeserviceUnit optional
           the service unit


Attribute Summary
stringcomparator
           Specifies a <code>Comparator</code> object.
stringcomponent
           the default component
booleanconcurrentExchange
           
booleanconcurrentPolling
          <p> Sets whether more than one poll can be active at a time (true means yes).
longdelay
          <p> Sets the amount of time in milliseconds that the endpoint should wait before making the first poll.
booleandeleteFile
          Specifies if files should be deleted after they are processed.
stringendpoint
          <p> Get the endpoint implementation.
stringfileSystemManager
           sets the file system manager
datefirstTime
          <p> Sets the date on which the first poll will be executed.
IDid
           
QNameinterfaceName
          <p> Get the qualified name of the endpoint interface.
stringlockManager
          Bean defining the class implementing the file locking strategy.
stringmarshaler
          Specifies a <code>FileMarshaler</code> object that will marshal file data into the NMR.
stringpath
          Specifies a <code>String</code> object representing the path of the file/folder to be polled.<br /><br /> <b><u>Examples:</u></b><br /> <ul> <li>file:///home/lhein/pollFolder</li> <li>zip:file:///home/lhein/pollFolder/myFile.zip</li> <li>jar:http://www.myhost.com/files/Examples.jar</li> <li>jar:../lib/classes.jar!/META-INF/manifest.mf</li> <li>tar:gz:http://anyhost/dir/mytar.tar.gz!/mytar.tar!/path/in/tar/README.txt</li> <li>tgz:file://anyhost/dir/mytar.tgz!/somepath/somefile</li> <li>gz:/my/gz/file.gz</li> <li>http://myusername@somehost/index.html</li> <li>webdav://somehost:8080/dist</li> <li>ftp://myusername:mypassword@somehost/pub/downloads/somefile.tgz</li> <li>sftp://myusername:mypassword@somehost/pub/downloads/somefile.tgz</li> <li>smb://somehost/home</li> <li>tmp://dir/somefile.txt</li> <li>res:path/in/classpath/image.png</li> <li>ram:///any/path/to/file.txt</li> <li>mime:file:///your/path/mail/anymail.mime!/filename.pdf</li> </ul> For further details have a look at {@link http://commons.apache.org/vfs/filesystems.html}.
longperiod
          <p> Sets the number of milliseconds between polling attempts.
booleanrecursive
           
stringscheduler
          <p> Sets a custom scheduler implementation if you need more fine-grained control over the polling schedule.
stringselector
           Specifies a <code>FileSelector</code> object.
QNameservice
          <p> Get the service qualified name of the endpoint.
stringserviceUnit
           the service unit
stringtargetEndpoint
           the name of the endpoint to which requests are sent
QNametargetInterface
           the QName of the interface to which requests are sent
QNametargetOperation
           the QName of the operation to which requests are sent
QNametargetService
           the QName of the service to which requests are sent
stringtargetUri
          <p> Gets the target URI of the consumer endpoint.

Attribute Detail

comparator

Documentation
            Specifies a <code>Comparator</code> object.
          
Definition

Defined with global type string

Model
string
Attribute Usage
optional
Fundamental Facets
equality, non-numeric, unbounded, unordered, countable infinite value space
White Space Processing
collapse

component

Documentation
            the default component
          
Definition

Defined with global type string

Model
string
Attribute Usage
optional
Fundamental Facets
equality, non-numeric, unbounded, unordered, countable infinite value space
White Space Processing
collapse

concurrentExchange

Definition

Defined with global type boolean

Model
boolean
Attribute Usage
optional
Fundamental Facets
equality, non-numeric, unbounded, unordered, finit value space
White Space Processing
collapse

concurrentPolling

Documentation
            <p>
Sets whether more than one poll can be active at a time (true means yes). Default value is <code>false</code>.
</p>
          
Definition

Defined with global type boolean

Model
boolean
Attribute Usage
optional
Fundamental Facets
equality, non-numeric, unbounded, unordered, finit value space
White Space Processing
collapse

delay

Documentation
            <p>
Sets the amount of time in milliseconds that the endpoint should wait before making the first poll.
</p>
          
Definition

Defined with global type long

Model
long
Attribute Usage
optional
Fundamental Facets
equality, numeric, bounded, totaly ordered, countable infinite value space
White Space Processing
collapse

deleteFile

Documentation
            Specifies if files should be deleted after they are processed. Default
value is <code>true</code>.
          
Definition

Defined with global type boolean

Model
boolean
Attribute Usage
optional
Fundamental Facets
equality, non-numeric, unbounded, unordered, finit value space
White Space Processing
collapse

endpoint

Documentation
            <p>
Get the endpoint implementation.
</p>
          
Definition

Defined with global type string

Model
string
Attribute Usage
optional
Fundamental Facets
equality, non-numeric, unbounded, unordered, countable infinite value space
White Space Processing
collapse

fileSystemManager

Documentation
            sets the file system manager
          
Definition

Defined with global type string

Model
string
Attribute Usage
optional
Fundamental Facets
equality, non-numeric, unbounded, unordered, countable infinite value space
White Space Processing
collapse

firstTime

Documentation
            <p>
Sets the date on which the first poll will be executed. If a delay is
also set using <code>setDelay</code>, the delay interval will be added
after the date specified.
</p>
          
Definition

Defined with global type date

Model
date
Attribute Usage
optional
Fundamental Facets
equality, non-numeric, unbounded, partialy ordered, countable infinite value space
White Space Processing
collapse

id

Definition

Defined with global type ID

Model
ID
Attribute Usage
optional
Fundamental Facets
equality, non-numeric, unbounded, unordered, countable infinite value space
White Space Processing
collapse

interfaceName

Documentation
            <p>
Get the qualified name of the endpoint interface.
</p>
          
Definition

Defined with global type QName

Model
QName
Attribute Usage
optional
Fundamental Facets
equality, non-numeric, unbounded, unordered, countable infinite value space
White Space Processing
collapse

lockManager

Documentation
            Bean defining the class implementing the file locking strategy. This bean
must be an implementation of the
<code>org.apache.servicemix.locks.LockManager</code> interface. By
default, this will be set to an instances of
<code>org.apache.servicemix.common.locks.impl.SimpleLockManager</code>.
          
Definition

Defined with global type string

Model
string
Attribute Usage
optional
Fundamental Facets
equality, non-numeric, unbounded, unordered, countable infinite value space
White Space Processing
collapse

marshaler

Documentation
            Specifies a <code>FileMarshaler</code> object that will marshal file data
into the NMR. The default file marshaller can read valid XML data.
<code>FileMarshaler</code> objects are implementations of
<code>org.apache.servicemix.components.util.FileMarshaler</code>.
          
Definition

Defined with global type string

Model
string
Attribute Usage
optional
Fundamental Facets
equality, non-numeric, unbounded, unordered, countable infinite value space
White Space Processing
collapse

path

Documentation
            Specifies a <code>String</code> object representing the path of the
file/folder to be polled.<br /><br />
<b><u>Examples:</u></b><br />
<ul>
<li>file:///home/lhein/pollFolder</li>
<li>zip:file:///home/lhein/pollFolder/myFile.zip</li>
<li>jar:http://www.myhost.com/files/Examples.jar</li>
<li>jar:../lib/classes.jar!/META-INF/manifest.mf</li>
<li>tar:gz:http://anyhost/dir/mytar.tar.gz!/mytar.tar!/path/in/tar/README.txt</li>
<li>tgz:file://anyhost/dir/mytar.tgz!/somepath/somefile</li>
<li>gz:/my/gz/file.gz</li>
<li>http://myusername@somehost/index.html</li>
<li>webdav://somehost:8080/dist</li>
<li>ftp://myusername:mypassword@somehost/pub/downloads/somefile.tgz</li>
<li>sftp://myusername:mypassword@somehost/pub/downloads/somefile.tgz</li>
<li>smb://somehost/home</li>
<li>tmp://dir/somefile.txt</li>
<li>res:path/in/classpath/image.png</li>
<li>ram:///any/path/to/file.txt</li>
<li>mime:file:///your/path/mail/anymail.mime!/filename.pdf</li>
</ul>

For further details have a look at {@link http://commons.apache.org/vfs/filesystems.html}.
<br /><br />
          
Definition

Defined with global type string

Model
string
Attribute Usage
optional
Fundamental Facets
equality, non-numeric, unbounded, unordered, countable infinite value space
White Space Processing
collapse

period

Documentation
            <p>
Sets the number of milliseconds between polling attempts.
</p>
          
Definition

Defined with global type long

Model
long
Attribute Usage
optional
Fundamental Facets
equality, numeric, bounded, totaly ordered, countable infinite value space
White Space Processing
collapse

recursive

Definition

Defined with global type boolean

Model
boolean
Attribute Usage
optional
Fundamental Facets
equality, non-numeric, unbounded, unordered, finit value space
White Space Processing
collapse

scheduler

Documentation
            <p>
Sets a custom scheduler implementation if you need more fine-grained control over the polling schedule.
</p>
          
Definition

Defined with global type string

Model
string
Attribute Usage
optional
Fundamental Facets
equality, non-numeric, unbounded, unordered, countable infinite value space
White Space Processing
collapse

selector

Documentation
            Specifies a <code>FileSelector</code> object.
          
Definition

Defined with global type string

Model
string
Attribute Usage
optional
Fundamental Facets
equality, non-numeric, unbounded, unordered, countable infinite value space
White Space Processing
collapse

service

Documentation
            <p>
Get the service qualified name of the endpoint.
</p>
          
Definition

Defined with global type QName

Model
QName
Attribute Usage
optional
Fundamental Facets
equality, non-numeric, unbounded, unordered, countable infinite value space
White Space Processing
collapse

serviceUnit

Documentation
            the service unit
          
Definition

Defined with global type string

Model
string
Attribute Usage
optional
Fundamental Facets
equality, non-numeric, unbounded, unordered, countable infinite value space
White Space Processing
collapse

targetEndpoint

Documentation
            the name of the endpoint to which requests are sent
          
Definition

Defined with global type string

Model
string
Attribute Usage
optional
Fundamental Facets
equality, non-numeric, unbounded, unordered, countable infinite value space
White Space Processing
collapse

targetInterface

Documentation
            the QName of the interface to which requests are sent
          
Definition

Defined with global type QName

Model
QName
Attribute Usage
optional
Fundamental Facets
equality, non-numeric, unbounded, unordered, countable infinite value space
White Space Processing
collapse

targetOperation

Documentation
            the QName of the operation to which requests are sent
          
Definition

Defined with global type QName

Model
QName
Attribute Usage
optional
Fundamental Facets
equality, non-numeric, unbounded, unordered, countable infinite value space
White Space Processing
collapse

targetService

Documentation
            the QName of the service to which requests are sent
          
Definition

Defined with global type QName

Model
QName
Attribute Usage
optional
Fundamental Facets
equality, non-numeric, unbounded, unordered, countable infinite value space
White Space Processing
collapse

targetUri

Documentation
            <p>
Gets the target URI of the consumer endpoint.
</p>
          
Definition

Defined with global type string

Model
string
Attribute Usage
optional
Fundamental Facets
equality, non-numeric, unbounded, unordered, countable infinite value space
White Space Processing
collapse

Fuse ESB Enterprise 7.0 XML Schemas

Fuse ESB Enterprise 7.0 XML Schemas