com.qoretechnologies.qorus.AbstractFsRemoteReceive Class Reference

Java wrapper for the OMQ::AbstractFsRemoteReceive class in Qorus. More...

Inheritance diagram for com.qoretechnologies.qorus.AbstractFsRemoteReceive:

Public Member Methods
	AbstractFsRemoteReceive (String remote, String path, String streamType, HashMap< String, Object > options) throws Throwable
	Creates the object and starts receiving file data immediately. More...
	AbstractFsRemoteReceive (String remote, String path, String streamType) throws Throwable
	Creates the object and starts receiving file data immediately. More...
	AbstractFsRemoteReceive (String remote, String path) throws Throwable
	Creates the object and starts receiving file data immediately. More...
	AbstractFsRemoteReceive (String remote, String conn, String path, String streamType, HashMap< String, Object > options) throws Throwable
	Creates the object and starts receiving file data immediately. More...
	AbstractFsRemoteReceive (String remote, String conn, String path, String streamType) throws Throwable
	Creates the object and starts receiving file data immediately. More...
void	rename (String target, boolean man) throws Throwable
	rename/move currently operated file given in path in constructor More...
void	del (String target) throws Throwable
	delete currently operated file given in path in constructor or any other file name More...
void	del () throws Throwable
	delete currently operated file given in path in constructor or any other file name
StreamConfig	config () throws Throwable
	returns the configuration object

Static Public Attributes
static final String	TYPE_FILE = "get-file"
	Raw file transfer.
static final String	TYPE_CSV = "get-csv-data"
	Receive CSV data.
static final String	TYPE_XML = "get-xml-data"
	Receive XML data.

Detailed Description

Java wrapper for the OMQ::AbstractFsRemoteReceive class in Qorus.

Constructor & Destructor Documentation

AbstractFsRemoteReceive() [1/5]

com.qoretechnologies.qorus.AbstractFsRemoteReceive.AbstractFsRemoteReceive ( String  remote, String  path, String  streamType, HashMap< String, Object >  options  ) throws Throwable

inline

Creates the object and starts receiving file data immediately.

Parameters

remote	a string with a remote Qorus connection name as defined in Qorus to Qorus Connections
path	a source (remote) file path
streamType	a string with AbstractFsRemoteReceive_formats
options	optional Streaming API Constructor Options with additional AbstractFsRemoteReceive_options

AbstractFsRemoteReceive() [2/5]

com.qoretechnologies.qorus.AbstractFsRemoteReceive.AbstractFsRemoteReceive ( String  remote, String  path, String  streamType  ) throws Throwable

inline

Creates the object and starts receiving file data immediately.

Parameters

remote	a string with a remote Qorus connection name as defined in Qorus to Qorus Connections
path	a source (remote) file path
streamType	a string with AbstractFsRemoteReceive_formats

AbstractFsRemoteReceive() [3/5]

com.qoretechnologies.qorus.AbstractFsRemoteReceive.AbstractFsRemoteReceive ( String  remote, String  path  ) throws Throwable

inline

Creates the object and starts receiving file data immediately.

Parameters

remote	a string with a remote Qorus connection name as defined in Qorus to Qorus Connections
path	a source (remote) file path

Note

the stream type is set to TYPE_FILE automatically with this constructor

AbstractFsRemoteReceive() [4/5]

com.qoretechnologies.qorus.AbstractFsRemoteReceive.AbstractFsRemoteReceive ( String  remote, String  conn, String  path, String  streamType, HashMap< String, Object >  options  ) throws Throwable

inline

Creates the object and starts receiving file data immediately.

Parameters

remote	a string with a remote Qorus connection name as defined in Qorus to Qorus Connections
conn	a remote filesystem based user connection name
path	a source (remote) file path, relative to the conn root
streamType	a string with AbstractFsRemoteReceive_formats
options	optional Streaming API Constructor Options with additional AbstractFsRemoteReceive_options

AbstractFsRemoteReceive() [5/5]

com.qoretechnologies.qorus.AbstractFsRemoteReceive.AbstractFsRemoteReceive ( String  remote, String  conn, String  path, String  streamType  ) throws Throwable

inline

Creates the object and starts receiving file data immediately.

Parameters

remote	a string with a remote Qorus connection name as defined in Qorus to Qorus Connections
conn	a remote filesystem based user connection name
path	a source (remote) file path, relative to the conn root
streamType	a string with AbstractFsRemoteReceive_formats

Member Function Documentation

del()

void com.qoretechnologies.qorus.AbstractFsRemoteReceive.del ( String  target ) throws Throwable

inline

delete currently operated file given in path in constructor or any other file name

Parameters

target

an optional new path with filename. Relative to user connection if the user connection constructor is used. If it's empty (NOTHING) the path specified in constructor is used. Otherwise any file name given to this method will be deleted.

rename()

void com.qoretechnologies.qorus.AbstractFsRemoteReceive.rename ( String  target, boolean  man  ) throws Throwable

inline

rename/move currently operated file given in path in constructor

Parameters

target	a new path with filename. Relative to user connection if the user connection constructor is used.
man	rename the file manually by copying the file's data and then deleting the source file, this is sometimes necessary on some OSes when renaming files across filesystem boundaries

Warning

The original file after the rename does not exist anymore if man is set to True. Any additional append() call will result in an exception.

Note

do not call this method before all data have been received

---

The documentation for this class was generated from the following file:

• /builds/qorus/qorus/java/com/qoretechnologies/qorus/AbstractFsRemoteReceive.java