net.razorvine.pyro

Class PyroProxy

java.lang.Object

net.razorvine.pyro.PyroProxy

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

NameServerProxy

public class PyroProxy
extends java.lang.Object
implements java.io.Serializable

Proxy for Pyro objects.

Author:

Irmen de Jong (irmen@razorvine.net)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	PyroProxy.StreamResultIterable

Field Summary

Fields

Modifier and Type	Field and Description
java.util.UUID	correlation_id
java.lang.String	hostname
java.lang.String	objectid
int	port
java.util.Set<java.lang.String>	pyroAttrs
java.lang.Object	pyroHandshake
byte[]	pyroHmacKey
java.util.Set<java.lang.String>	pyroMethods
java.util.Set<java.lang.String>	pyroOneway

Constructor Summary

Constructors

Constructor and Description
PyroProxy() No-args constructor for (un)pickling support
PyroProxy(PyroURI uri) Create a proxy for the remote Pyro object denoted by the uri
PyroProxy(java.lang.String hostname, int port, java.lang.String objectid) Create a proxy for the remote Pyro object on the given host and port, with the given objectid/name.

Method Summary

Modifier and Type	Method and Description
void	__setstate__(java.lang.Object[] args) called by the Unpickler to restore state args(8 or 9): pyroUri, pyroOneway(hashset), pyroMethods(set), pyroAttrs(set), pyroTimeout, pyroHmacKey, pyroHandshake, pyroMaxRetries [,pyroSerializer]
protected void	_handshake() Perform the Pyro protocol connection handshake with the Pyro daemon.
java.util.SortedMap<java.lang.String,byte[]>	annotations() Returns a sorted map with annotations to be sent with each message.
void	call_oneway(java.lang.String method, java.lang.Object... arguments) Call a method on the remote Pyro object this proxy is for, using Oneway call semantics (return immediately).
java.lang.Object	call(java.lang.String method, java.lang.Object... arguments) Call a method on the remote Pyro object this proxy is for.
void	close() Close the network connection of this Proxy.
protected void	connect() (re)connect the proxy to the remote Pyro daemon.
java.lang.Object	getattr(java.lang.String attr) Get the value of a remote attribute.
protected void	getMetadata(java.lang.String objectId) get metadata from server (methods, attrs, oneway, ...) and remember them in some attributes of the proxy
protected java.util.HashSet<java.lang.String>	getSetOfStrings(java.lang.Object strings) Converts the given object into a set of strings.
void	responseAnnotations(java.util.SortedMap<java.lang.String,byte[]> annotations, int msgtype) Process any response annotations (dictionary set by the daemon).
void	setattr(java.lang.String attr, java.lang.Object value) Set a new value on a remote attribute.
void	validateHandshake(java.lang.Object response) Process and validate the initial connection handshake response data received from the daemon.

Methods inherited from class java.lang.Object

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

Field Detail

hostname

public java.lang.String hostname

port

public int port

objectid

public java.lang.String objectid

pyroHmacKey

public byte[] pyroHmacKey

correlation_id

public java.util.UUID correlation_id

pyroHandshake

public java.lang.Object pyroHandshake

pyroMethods

public java.util.Set<java.lang.String> pyroMethods

pyroAttrs

public java.util.Set<java.lang.String> pyroAttrs

pyroOneway

public java.util.Set<java.lang.String> pyroOneway

Constructor Detail

PyroProxy

public PyroProxy()

No-args constructor for (un)pickling support

PyroProxy

public PyroProxy(PyroURI uri)
          throws java.net.UnknownHostException,
                 java.io.IOException

Create a proxy for the remote Pyro object denoted by the uri

Throws:

java.net.UnknownHostException

java.io.IOException

PyroProxy

public PyroProxy(java.lang.String hostname,
                 int port,
                 java.lang.String objectid)
          throws java.net.UnknownHostException,
                 java.io.IOException

Create a proxy for the remote Pyro object on the given host and port, with the given objectid/name.

Throws:

java.net.UnknownHostException

java.io.IOException

Method Detail

connect

protected void connect()
                throws java.net.UnknownHostException,
                       java.io.IOException

(re)connect the proxy to the remote Pyro daemon.

Throws:

java.net.UnknownHostException

java.io.IOException

getMetadata

protected void getMetadata(java.lang.String objectId)
                    throws PickleException,
                           PyroException,
                           java.io.IOException

get metadata from server (methods, attrs, oneway, ...) and remember them in some attributes of the proxy

Throws:

PickleException

PyroException

java.io.IOException

getSetOfStrings

protected java.util.HashSet<java.lang.String> getSetOfStrings(java.lang.Object strings)

Converts the given object into a set of strings. The object must either be a HashSet already, or a different collection type.

call

public java.lang.Object call(java.lang.String method,
                             java.lang.Object... arguments)
                      throws PickleException,
                             PyroException,
                             java.io.IOException

Call a method on the remote Pyro object this proxy is for.

Parameters:

method - the name of the method you want to call

arguments - zero or more arguments for the remote method

Returns:

the result Object from the remote method call (can be anything, you need to typecast/introspect yourself).

Throws:

PickleException

PyroException

java.io.IOException

call_oneway

public void call_oneway(java.lang.String method,
                        java.lang.Object... arguments)
                 throws PickleException,
                        PyroException,
                        java.io.IOException

Call a method on the remote Pyro object this proxy is for, using Oneway call semantics (return immediately).

Parameters:

method - the name of the method you want to call

arguments - zero or more arguments for the remote method

Throws:

PickleException

PyroException

java.io.IOException

getattr

public java.lang.Object getattr(java.lang.String attr)
                         throws PickleException,
                                PyroException,
                                java.io.IOException

Get the value of a remote attribute.

Parameters:

attr - the attribute name

Throws:

PickleException

PyroException

java.io.IOException

setattr

public void setattr(java.lang.String attr,
                    java.lang.Object value)
             throws PickleException,
                    PyroException,
                    java.io.IOException

Set a new value on a remote attribute.

Parameters:

attr - the attribute name

value - the new value for the attribute

Throws:

PickleException

PyroException

java.io.IOException

annotations

public java.util.SortedMap<java.lang.String,byte[]> annotations()

Returns a sorted map with annotations to be sent with each message. Default behavior is to include the current correlation id (if it is set).

close

public void close()

Close the network connection of this Proxy. If you re-use the proxy, it will automatically reconnect.

_handshake

protected void _handshake()
                   throws java.io.IOException

Perform the Pyro protocol connection handshake with the Pyro daemon.

Throws:

java.io.IOException

validateHandshake

public void validateHandshake(java.lang.Object response)
                       throws java.io.IOException

Process and validate the initial connection handshake response data received from the daemon. Simply return without error if everything is ok. Throw an IOException if something is wrong and the connection should not be made.

Throws:

java.io.IOException

responseAnnotations

public void responseAnnotations(java.util.SortedMap<java.lang.String,byte[]> annotations,
                                int msgtype)

Process any response annotations (dictionary set by the daemon). Usually this contains the internal Pyro annotations such as hmac and correlation id, and if you override the annotations method in the daemon, can contain your own annotations as well.

__setstate__

public void __setstate__(java.lang.Object[] args)
                  throws java.io.IOException

called by the Unpickler to restore state args(8 or 9): pyroUri, pyroOneway(hashset), pyroMethods(set), pyroAttrs(set), pyroTimeout, pyroHmacKey, pyroHandshake, pyroMaxRetries [,pyroSerializer]

Throws:

java.io.IOException