Package com.levigo.jadice.server.nodes

Class StreamInputNode

java.lang.Object

com.levigo.jadice.server.internal.NodeInternal

com.levigo.jadice.server.Node

com.levigo.jadice.server.nodes.StreamInputNode

public class StreamInputNode
extends Node

A Node that takes InputStreams from the client side and makes them available on the server. The underlying transport mechanism is made transparent due to this class.

The sequence of this node has four phases:

1. Initiating a new StreamInputNode and configuring the enclosing job
2. Submitting the job
3. Transferring Streams to the server via
   • addStream(InputStream)
   • addStream(InputStream, StreamDescriptor)
   • createOutputStream()
   • createOutputStream(StreamDescriptor)
4. Finally, the method complete() must be called to indicate that no more Streams will follow

As this node is a data source it must not have a predecessor.

Nested Class Summary

Nested classes/interfaces inherited from class com.levigo.jadice.server.Node

Node.Cardinality

Field Summary

Fields inherited from class com.levigo.jadice.server.internal.NodeInternal

limits, subsidiaryNodes

Constructor Summary

Constructors

Constructor	Description
StreamInputNode()

Method Summary

Modifier and Type	Method	Description
void	addStream(Stream stream)	Transmit a Stream to the server.
void	addStream(InputStream is)	Transmit an InputStream (but no meta data about it) to the server.
void	addStream(InputStream is, StreamDescriptor sd)	Transmit an InputStream and meta data about it to the server.
void	complete()	After all Streams were initiated to be sent to the server, this method must be called.
OutputStream	createOutputStream()	Creates an OutputStream.
OutputStream	createOutputStream(StreamDescriptor sd)	Creates an OutputStream.
Node.Cardinality	getInputCardinality()	Return the input cardinality of this node, i.e.
StreamBundle	getStreamBundle()	Get the Streams that the client has sent.
String	getWorkerClassName()	Return the node's associated com.levigo.jadice.server.core.NodeWorker full qualified class's name.
protected void	initialize(CommunicationSide side)

Methods inherited from class com.levigo.jadice.server.Node

addTransportReceiver, appendSuccessor, apply, equals, getJob, getOutputCardinality, getPredecessors, getSubsidiaryNodes, getSuccessors, getTransportSender, getUUID, hashCode, prependPredecessor, remove, validateConfiguration

Methods inherited from class com.levigo.jadice.server.internal.NodeInternal

addSubsidiaryNodes, getJobInternal, getLimit, getLimits, getNodeLimits, setJob, setNodeLimits

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StreamInputNode

public StreamInputNode()

Method Detail

getWorkerClassName

public String getWorkerClassName()

Description copied from class: Node

Return the node's associated com.levigo.jadice.server.core.NodeWorker full qualified class's name. By default, the worker class name is

• The same as the node name with the trailing "Node" replaced by "Worker" if the node name ends in "Node"
• The node class name with an appended "Worker" otherwise.

The package name of the worker class is the name of the Node's package with an appended ".worker".

This behavior can be overridden in concrete subclasses.

Overrides:

getWorkerClassName in class Node

Returns:

the full qualified class name of the worker of this node.

addStream

public void addStream(InputStream is,
                      StreamDescriptor sd)
               throws IOException

Transmit an InputStream and meta data about it to the server.

Must not be called before the underlying job was successfully submitted.

Parameters:

is - An InputStream

sd - The InputStream's meta data

Throws:

IOException - If the stream can't be sent.

See Also:

addStream(Stream)

addStream

public void addStream(Stream stream)
               throws IOException

Transmit a Stream to the server.

Must not be called before the underlying job was successfully submitted.

Parameters:

stream - A Stream

Throws:

IOException - If the stream can't be sent.

IllegalStateException - If you attempt to use this method before the according job has been accepted by a server instance.

Since:

jadice server 4.3.1.17

addStream

public void addStream(InputStream is)
               throws IOException

Transmit an InputStream (but no meta data about it) to the server.

Must not be called before the underlying job was successfully submitted.

Parameters:

is - An InputStream

Throws:

IOException - If the stream can't be sent.

See Also:

addStream(InputStream, StreamDescriptor), addStream(Stream)

createOutputStream

public OutputStream createOutputStream(StreamDescriptor sd)
                                throws IOException

Creates an OutputStream. Data written herein will be directly transfered to the server. As each call on thewrite methods of OutputStream will result in at least one message between client and server, it's preferable to write in larger chunks.

Must not be called before the underlying job was successfully submitted.

Parameters:

sd - The OutputStream's meta data

Returns:

an OutputStream that can be written to

Throws:

IOException - If the stream can't be sent.

createOutputStream

public OutputStream createOutputStream()
                                throws IOException

Creates an OutputStream. Data written herein will be directly transfered to the server. As each call on thewrite methods of OutputStream will result in at least one message between client and server, it's preferable to write in larger chunks.

Must not be called before the underlying job was successfully submitted.

Returns:

an OutputStream that can be written to

Throws:

IOException - If the stream can't be sent.

See Also:

createOutputStream(StreamDescriptor)

complete

public void complete()
              throws IOException

After all Streams were initiated to be sent to the server, this method must be called. So, the server knows that no more Streams will follow. Thereafter, calling the methods

• addStream(InputStream)
• addStream(InputStream, StreamDescriptor)
• createOutputStream()
• createOutputStream(StreamDescriptor)

will cause an error.

Throws:

IOException - If the "End-of-Streams" signal cannot be sent.

IllegalStateException - If you attempt to use this method before the according job has been accepted by a server instance.

getStreamBundle

public StreamBundle getStreamBundle()

Get the Streams that the client has sent. To be used on the server side only...!

Returns:

the Streams sent by the client

initialize

protected void initialize(CommunicationSide side)

Overrides:

initialize in class Node

getInputCardinality

public Node.Cardinality getInputCardinality()

Description copied from class: Node

Return the input cardinality of this node, i.e. how many bundles (not streams!) it expects to process. By default, nodes are "pipe-style", i.e. one input, one output.

Overrides:

getInputCardinality in class Node

Returns:

input cardinality