monq.net

Class PipelineRequest

java.lang.Object

monq.net.PipelineRequest

public class PipelineRequest
extends java.lang.Object

Encapsulates a request for contact to a FilterServiceFactory. In addition to the host and port to contact, key/value pairs can be added as parameters for that server with put(). These key values pairs will be send to the contacted host as a request.

Objects of this class have a name to support adding parameters by looking up the name in a repository or property set of parameters.

Version:

$Revision: 1.4 $, $Date: 2005-11-22 15:13:06 $

Author:

© 2005 Harald Kirsch

See Also:

DistPipeFilter, DistFilter

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	KEYRE is the regular that must be matched by a key passed to put().

Constructor Summary

Constructors

Constructor and Description
PipelineRequest(PipelineRequest other) returns copy of the given PipelineRequest.
PipelineRequest(java.lang.String host, int port) calls the three parameter constructor with name=null.
PipelineRequest(java.lang.String name, java.lang.String host, int port) creates a PipelineRequest to contact the given host on the given port.

Method Summary

Modifier and Type	Method and Description
void	clear() deletes all key/value pairs that were stored with put().
java.lang.String	getHost() returns the hostname to contact as it was specified in the constructor.
java.lang.String	getName() retuns the name as set with in the constructor or the string getHost()+":"+getPort().
java.lang.String	getPort() returns the port to contact as it was specified in the constructor.
void	put(java.lang.String key, java.lang.String value) add a parameter to this request.
void	putParams(java.util.Map<java.lang.String,java.lang.String> params) puts all key/value pairs that were stored via put() into params.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

KEYRE

public static final java.lang.String KEYRE

is the regular that must be matched by a key passed to put(). Follow the link to below to see the actual value.

See Also:

Constant Field Values

Constructor Detail

PipelineRequest

public PipelineRequest(java.lang.String name,
                       java.lang.String host,
                       int port)

creates a PipelineRequest to contact the given host on the given port. Use put() to add key/value pairs to the request.

PipelineRequest

public PipelineRequest(java.lang.String host,
                       int port)

calls the three parameter constructor with name=null.

PipelineRequest

public PipelineRequest(PipelineRequest other)

returns copy of the given PipelineRequest.

Method Detail

put

public void put(java.lang.String key,
                java.lang.String value)

add a parameter to this request. The key/value pair is send upstream as soon as a connection is made with this object. The key must match the regular expression KEYRE.

Throws:

java.lang.IllegalStateException - if the key does not match KEYRE.

getName

public java.lang.String getName()

retuns the name as set with in the constructor or the string getHost()+":"+getPort().

getHost

public java.lang.String getHost()

returns the hostname to contact as it was specified in the constructor.

getPort

public java.lang.String getPort()

returns the port to contact as it was specified in the constructor.

putParams

public void putParams(java.util.Map<java.lang.String,java.lang.String> params)

puts all key/value pairs that were stored via put() into params.

clear

public void clear()

deletes all key/value pairs that were stored with put().