Class SpaceProxy

java.lang.Object

org.jpos.space.SpaceProxy

All Implemented Interfaces:

Remote, Configurable, RemoteSpace

public class SpaceProxy
extends Object
implements RemoteSpace, Configurable

RMI Space Proxy

Since:

1.4.9

Constructor Summary

Constructors

Constructor	Description
SpaceProxy()	Constructs a proxy backed by the default jPOS space.
SpaceProxy(String spaceUri)	Constructs a proxy backed by the space resolved from spaceUri.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
Set	getKeySet()	Returns the underlying local-space key set when available.
int	hashCode()
Serializable	in(Serializable key)	Take an entry from the space, waiting forever until one exists.
Serializable	in(Serializable key, long timeout)	Take an entry from the space, waiting a limited amount of time until one exists.
Serializable	inp(Serializable key)	In probe takes an entry from the space if one exists, return null otherwise.
void	out(Serializable key, Serializable value)	Write a new entry into the Space
void	out(Serializable key, Serializable value, long timeout)	Write a new leased entry into the Space.
Serializable	rd(Serializable key)	Read an entry from the space, waiting forever until one exists.
Serializable	rd(Serializable key, long timeout)	Read an entry from the space, waiting a limited amount of time until one exists.
Serializable	rdp(Serializable key)	Read probe reads an entry from the space if one exists, return null otherwise.
void	setConfiguration(Configuration cfg)	Configures this object with the supplied Configuration.
void	shutdown()	Unexports this proxy from the RMI runtime, retrying once after a brief delay.
String	toString()

Methods inherited from class Object

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

Constructor Details

SpaceProxy

public SpaceProxy()
           throws RemoteException

Constructs a proxy backed by the default jPOS space.

Throws:

RemoteException - if RMI export fails

SpaceProxy

public SpaceProxy(String spaceUri)
           throws RemoteException

Constructs a proxy backed by the space resolved from spaceUri.

Parameters:

spaceUri - SpaceFactory-style space URI

Throws:

RemoteException - if RMI export fails

Method Details

out

public void out(Serializable key,
 Serializable value)
         throws RemoteException

Description copied from interface: RemoteSpace

Write a new entry into the Space

Specified by:

out in interface RemoteSpace

Parameters:

key - Entry's key

value - Object value

Throws:

RemoteException - if the RMI call fails

out

public void out(Serializable key,
 Serializable value,
 long timeout)
         throws RemoteException

Description copied from interface: RemoteSpace

Write a new leased entry into the Space. Entry will remain valid for a limited amount of time.

Specified by:

out in interface RemoteSpace

Parameters:

key - Entry's key

value - Object value

timeout - entry valid time

Throws:

RemoteException - if the RMI call fails

in

public Serializable in(Serializable key)
                throws RemoteException

Description copied from interface: RemoteSpace

Take an entry from the space, waiting forever until one exists.

Specified by:

in in interface RemoteSpace

Parameters:

key - Entry's key

Returns:

value

Throws:

RemoteException - if the RMI call fails

rd

public Serializable rd(Serializable key)
                throws RemoteException

Description copied from interface: RemoteSpace

Read an entry from the space, waiting forever until one exists.

Specified by:

rd in interface RemoteSpace

Parameters:

key - Entry's key

Returns:

value

Throws:

RemoteException - if the RMI call fails

in

public Serializable in(Serializable key,
 long timeout)
                throws RemoteException

Description copied from interface: RemoteSpace

Take an entry from the space, waiting a limited amount of time until one exists.

Specified by:

in in interface RemoteSpace

Parameters:

key - Entry's key

timeout - millis to wait

Returns:

value or null

Throws:

RemoteException - if the RMI call fails

rd

public Serializable rd(Serializable key,
 long timeout)
                throws RemoteException

Description copied from interface: RemoteSpace

Read an entry from the space, waiting a limited amount of time until one exists.

Specified by:

rd in interface RemoteSpace

Parameters:

key - Entry's key

timeout - millis to wait

Returns:

value or null

Throws:

RemoteException - if the RMI call fails

inp

public Serializable inp(Serializable key)
                 throws RemoteException

Description copied from interface: RemoteSpace

In probe takes an entry from the space if one exists, return null otherwise.

Specified by:

inp in interface RemoteSpace

Parameters:

key - Entry's key

Returns:

value or null

Throws:

RemoteException - if the RMI call fails

rdp

public Serializable rdp(Serializable key)
                 throws RemoteException

Description copied from interface: RemoteSpace

Read probe reads an entry from the space if one exists, return null otherwise.

Specified by:

rdp in interface RemoteSpace

Parameters:

key - Entry's key

Returns:

value or null

Throws:

RemoteException - if the RMI call fails

shutdown

public void shutdown()

Unexports this proxy from the RMI runtime, retrying once after a brief delay.

setConfiguration

public void setConfiguration(Configuration cfg)
                      throws ConfigurationException

Description copied from interface: Configurable

Configures this object with the supplied Configuration.

Specified by:

setConfiguration in interface Configurable

Parameters:

cfg - Configuration object

Throws:

ConfigurationException - if the configuration is invalid

getKeySet

public Set getKeySet()

Returns the underlying local-space key set when available.

Returns:

the live key set, or null when the proxied space is not local

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object