Class SpaceLet

java.lang.Object

org.jpos.q2.QBeanSupport

org.jpos.q2.qbean.SpaceLet

All Implemented Interfaces:

AutoCloseable, Configurable, QBean, QBeanSupportMBean, QPersist, Space

public class SpaceLet
extends QBeanSupport
implements Space

QBean that adapts a Space for scripted access via BeanShell, allowing incoming/outgoing operations to be intercepted by configured BSH snippets.

Field Summary

Fields inherited from class QBeanSupport

cfg, log, scheduledThreadPoolExecutor

Modifier and Type	Field	Description
protected Configuration	cfg	Configuration applied to this bean by the container.
protected Log	log	Logger associated with this bean.
protected ScheduledThreadPoolExecutor	scheduledThreadPoolExecutor	Lazily-allocated scheduler shared with subclasses; see QBeanSupport.getScheduledThreadPoolExecutor().

Fields inherited from interface QBean

DESTROYED, FAILED, STARTED, STARTING, stateString, STOPPED, STOPPING

Modifier and Type	Field	Description
static final int	DESTROYED	QBean has been destroyed.
static final int	FAILED	QBean has failed.
static final int	STARTED	QBean is running.
static final int	STARTING	QBean is in the process of starting.
static final String[]	stateString	Human-readable names for each QBean state, indexed by state constant.
static final int	STOPPED	QBean is stopped.
static final int	STOPPING	QBean is in the process of stopping.

Constructor Summary

Constructors

Constructor	Description
SpaceLet()	Default constructor; no instance state to initialise.

Method Summary

Modifier and Type	Method	Description
boolean	existAny(Object[] keys)	Returns true if any of the given keys are present in the space.
boolean	existAny(Object[] keys, long timeout)	Returns true if any of the given keys become available within the timeout.
Object	in(Object key)	Take an entry from the space, waiting forever until one exists.
Object	in(Object key, long timeout)	Take an entry from the space, waiting a limited amount of time until one exists.
void	initService()	Called during the init lifecycle phase; subclasses may override.
Object	inp(Object key)	In probe takes an entry from the space if one exists, return null otherwise.
void	nrd(Object key)	Nrd (not read) waits forever until Key is not present in space. Resolution for expiring entries is implementation dependant, but a minimum one-second is suggested.
Object	nrd(Object key, long timeout)	Nrd (not read) waits up to timeout until Key is not present in space. Resolution for expiring entries is implementation dependant, but a minimum one-second is suggested.
void	out(Object key, Object value)	Write a new entry into the Space
void	out(Object key, Object value, long timeout)	Write a new entry into the Space, with an timeout value
void	push(Object key, Object value)	Write a new entry at the head of a queue.
void	push(Object key, Object value, long timeout)	Write a new entry at the head of the queue with a timeout value
void	put(Object key, Object value)	Write a single entry at the head of the queue discarding the other entries
void	put(Object key, Object value, long timeout)	Write a single entry at the head of the queue discarding the other entries, with timeout.
Object	rd(Object key)	Read an entry from the space, waiting forever until one exists.
Object	rd(Object key, long timeout)	Read an entry from the space, waiting a limited amount of time until one exists.
Object	rdp(Object key)	Read probe reads an entry from the space if one exists, return null otherwise.
void	startService()	Called during the start lifecycle phase; subclasses may override.
void	stopService()	Called during the stop lifecycle phase; subclasses may override.

Methods inherited from class QBeanSupport

addAttr, close, createElement, defaultRealm, destroy, destroyService, getAttrs, getAttrs, getConfiguration, getDump, getFactory, getLoader, getLoaderURLS, getLog, getLogger, getName, getPersist, getProperties, getProperty, getRealm, getScheduledThreadPoolExecutor, getServer, getState, getStateAsString, init, isModified, running, setAttr, setConfiguration, setLogger, setModified, setName, setPersist, setProperty, setRealm, setServer, setState, start, stop

Modifier and Type	Method	Description
protected void	addAttr(org.jdom2.Element e, String name, Object obj, String type)	Appends an <attr> child element with name/type/value to e.
protected void	close(Closeable... closeables)	Closes a sequence of Closeable resources, logging any failures as a warning.
protected org.jdom2.Element	createElement(String name, Class mbeanClass)	Builds a JDOM Element reflecting the bean's persistent attributes, driven by the JavaBean introspection of mbeanClass.
protected String	defaultRealm()	Returns the default realm for this bean; subclasses may override.
void	destroy()	destroy the service
protected void	destroyService()	Called during the destroy lifecycle phase; subclasses may override.
protected Iterator	getAttrs()	Iterates over top-level <attr> children of the persisted element.
protected Iterator	getAttrs(String parent)	Iterates over <attr> children nested under the given parent element name.
Configuration	getConfiguration()	Returns the configuration applied to this bean.
String	getDump()	Returns a textual dump of this bean's state.
QFactory	getFactory()	Returns the QFactory associated with the hosting Q2 server.
QClassLoader	getLoader()	Returns the QClassLoader for this bean.
URL[]	getLoaderURLS()	Returns the URLs registered with the class loader.
Log	getLog()	Returns the Log used by this bean.
String	getLogger()	Returns the logger name.
String	getName()	Returns the bean name.
org.jdom2.Element	getPersist()	Returns the persistent configuration element for this QBean.
protected Iterator	getProperties(String parent)	Iterates over <property> children nested under the given parent element name.
protected String	getProperty(Iterator props, String name)	Returns the value of the named property from an iterator of <property> elements.
String	getRealm()	Returns the logging realm.
protected ScheduledThreadPoolExecutor	getScheduledThreadPoolExecutor()	Lazily creates and returns a ScheduledThreadPoolExecutor for use by subclasses.
Q2	getServer()	Returns the Q2 server instance.
int	getState()	Returns the current state of this QBean.
String	getStateAsString()	Returns the current state as a human-readable string.
void	init()	init the service
boolean	isModified()	Returns true if this QBean's configuration has been modified since last save.
boolean	running()	Indicates whether this bean is currently starting or running.
protected void	setAttr(Iterator attrs, String name, Object obj)	Updates the value of the named attribute within an iterator of <attr> elements.
void	setConfiguration(Configuration cfg)	Configures this object with the supplied Configuration.
void	setLogger(String loggerName)	Sets the logger by name.
void	setModified(boolean modified)	Marks this bean's persistent state as modified or in sync.
void	setName(String name)	Sets the bean name.
void	setPersist(org.jdom2.Element persist)	Sets the persistent configuration element.
protected void	setProperty(Iterator props, String name, String value)	Updates the value attribute of the named property within an iterator of <property> elements.
void	setRealm(String realm)	Sets the logging realm.
void	setServer(Q2 server)	Sets the Q2 server instance for this QBean.
void	setState(int state)	Sets the lifecycle state of this bean.
void	start()	start the service
void	stop()	stop the service

Methods inherited from class Object

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

Methods inherited from interface Space

close

Modifier and Type	Method	Description
default void	close()

Constructor Details

SpaceLet

public SpaceLet()

Default constructor; no instance state to initialise.

Method Details

initService

public void initService()
                 throws ConfigurationException

Description copied from class: QBeanSupport

Called during the init lifecycle phase; subclasses may override.

Overrides:

initService in class QBeanSupport

Throws:

ConfigurationException

startService

public void startService()

Description copied from class: QBeanSupport

Called during the start lifecycle phase; subclasses may override.

Overrides:

startService in class QBeanSupport

stopService

public void stopService()

Description copied from class: QBeanSupport

Called during the stop lifecycle phase; subclasses may override.

Overrides:

stopService in class QBeanSupport

out

public void out(Object key,
 Object value)

Description copied from interface: Space

Write a new entry into the Space

Specified by:

out in interface Space

Parameters:

key - Entry's key

value - Object value

out

public void out(Object key,
 Object value,
 long timeout)

Description copied from interface: Space

Write a new entry into the Space, with an timeout value

Specified by:

out in interface Space

Parameters:

key - Entry's key

value - Object value

timeout - timeout value in millis

push

public void push(Object key,
 Object value)

Description copied from interface: Space

Write a new entry at the head of a queue.

Specified by:

push in interface Space

Parameters:

key - Entry's key

value - Object value

push

public void push(Object key,
 Object value,
 long timeout)

Description copied from interface: Space

Write a new entry at the head of the queue with a timeout value

Specified by:

push in interface Space

Parameters:

key - Entry's key

value - Object value

timeout - timeout value in millis

put

public void put(Object key,
 Object value)

Description copied from interface: Space

Write a single entry at the head of the queue discarding the other entries

Specified by:

put in interface Space

Parameters:

key - Entry's key

value - Object value

put

public void put(Object key,
 Object value,
 long timeout)

Description copied from interface: Space

Write a single entry at the head of the queue discarding the other entries, with timeout.

Specified by:

put in interface Space

Parameters:

key - Entry's key

value - Object value

timeout - timeout value in millis

in

public Object in(Object key)

Description copied from interface: Space

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

Specified by:

in in interface Space

Parameters:

key - Entry's key

Returns:

value

rd

public Object rd(Object key)

Description copied from interface: Space

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

Specified by:

rd in interface Space

Parameters:

key - Entry's key

Returns:

value

in

public Object in(Object key,
 long timeout)

Description copied from interface: Space

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

Specified by:

in in interface Space

Parameters:

key - Entry's key

timeout - millis to wait

Returns:

value or null

rd

public Object rd(Object key,
 long timeout)

Description copied from interface: Space

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

Specified by:

rd in interface Space

Parameters:

key - Entry's key

timeout - millis to wait

Returns:

value or null

inp

public Object inp(Object key)

Description copied from interface: Space

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

Specified by:

inp in interface Space

Parameters:

key - Entry's key

Returns:

value or null

rdp

public Object rdp(Object key)

Description copied from interface: Space

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

Specified by:

rdp in interface Space

Parameters:

key - Entry's key

Returns:

value or null

existAny

public boolean existAny(Object[] keys)

Description copied from interface: Space

Returns true if any of the given keys are present in the space.

Specified by:

existAny in interface Space

Parameters:

keys - array of keys to check

Returns:

true if one or more keys are available in the space

existAny

public boolean existAny(Object[] keys,
 long timeout)

Description copied from interface: Space

Returns true if any of the given keys become available within the timeout.

Specified by:

existAny in interface Space

Parameters:

keys - array of keys to check

timeout - to wait for any of the entries to become available in millis

Returns:

true if one or more keys are available in the space

nrd

public void nrd(Object key)

Description copied from interface: Space

Nrd (not read) waits forever until Key is not present in space.
Resolution for expiring entries is implementation dependant, but a minimum one-second is suggested.

Specified by:

nrd in interface Space

Parameters:

key - Entry's key

nrd

public Object nrd(Object key,
 long timeout)

Description copied from interface: Space

Nrd (not read) waits up to timeout until Key is not present in space.
Resolution for expiring entries is implementation dependant, but a minimum one-second is suggested.

Specified by:

nrd in interface Space

Parameters:

key - Entry's key

timeout - millis to wait

Returns:

value or null