com.goldencode.p2j.net

Class HighLevelObject

java.lang.Object

com.goldencode.p2j.net.HighLevelObject

Direct Known Subclasses:

DirectoryEdit.ServerDirectory

public class HighLevelObject
extends java.lang.Object

Base class for remote objects which provides some useful utility methods.

Field Summary

Fields

Modifier and Type	Field and Description
private static CentralLogger	LOG Logger
protected Session	session Session which represents connection.
private int	timeout The timeout for synchronous calls.

Constructor Summary

Constructors

Constructor and Description
HighLevelObject(Session session) Constructs an instance using the given transport.
HighLevelObject(Session session, int timeout) Constructs an instance using the given transport and timeout.

Method Summary

Modifier and Type	Method and Description
void	forward(RoutingKey key, java.lang.Object[] parms) Convenience wrapper for Queue.forward(com.goldencode.p2j.net.Message).
RoutingKey	getKey(java.lang.String group, java.lang.String method) Get the routing key instance that represents the given group and method at the remote side of the session.
int	getTimeout() Get the transaction timeout in milliseconds.
void	setTimeout(int timeout) Set the transaction timeout in milliseconds.
java.lang.Object	transact(RoutingKey key, java.lang.Object[] parms) Convenience wrapper for Queue.transact(com.goldencode.p2j.net.Message, int).

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static CentralLogger LOG

Logger

session

protected Session session

Session which represents connection.

timeout

private int timeout

The timeout for synchronous calls.

Constructor Detail

HighLevelObject

public HighLevelObject(Session session)

Constructs an instance using the given transport.

Parameters:

session - Session with properly initialized transport.

HighLevelObject

public HighLevelObject(Session session,
                       int timeout)

Constructs an instance using the given transport and timeout.

Parameters:

session - Session with properly initialized transport.

timeout - The transaction timeout in milliseconds.

Method Detail

getTimeout

public int getTimeout()

Get the transaction timeout in milliseconds.

Returns:

The timeout in milliseconds.

setTimeout

public void setTimeout(int timeout)

Set the transaction timeout in milliseconds.

Parameters:

timeout - The timeout in milliseconds.

getKey

public RoutingKey getKey(java.lang.String group,
                         java.lang.String method)
                  throws java.lang.Exception

Get the routing key instance that represents the given group and method at the remote side of the session.

Parameters:

group - Group name.

method - Method name.

Returns:

The instance of the routing key which corresponds to given the group and method.

Throws:

java.lang.Exception - If any problem happens during processing of the request.

forward

public void forward(RoutingKey key,
                    java.lang.Object[] parms)

Convenience wrapper for Queue.forward(com.goldencode.p2j.net.Message).

Parameters:

key - An instance of RoutingKey which points to method to call at remote side.

parms - Method parameters.

transact

public java.lang.Object transact(RoutingKey key,
                                 java.lang.Object[] parms)
                          throws java.lang.Exception

Convenience wrapper for Queue.transact(com.goldencode.p2j.net.Message, int).

Parameters:

key - The routing key which represents the method to call at the remote side.

parms - Method parameters.

Returns:

The transaction result.

Throws:

java.lang.Exception - If any problem occurs during Queue.transact(com.goldencode.p2j.net.Message, int).