Class SpaceFactory

java.lang.Object

org.jpos.space.SpaceFactory

public class SpaceFactory
extends Object

Creates a space based on a space URI.

A space URI has three parts:

• scheme
• name
• optional parameter

Examples:

  // default unnamed space (tspace:default)
  Space sp = SpaceFactory.getSpace ();

  // transient space named "test"
  Space sp = SpaceFactory.getSpace ("transient:test");

  // lspace (Loom-optimized) named "test"
  Space sp = SpaceFactory.getSpace ("lspace:test");

  // persistent space named "test"
  Space sp = SpaceFactory.getSpace ("persistent:test");

  // jdbm space named test
  Space sp = SpaceFactory.getSpace ("jdbm:test");

  // jdbm space named test, storage located in /tmp/test
  Space sp = SpaceFactory.getSpace ("jdbm:test:/tmp/test");

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT	Default name used for unnamed spaces.
static final String	JDBM	Scheme constant for JDBM-backed spaces.
static final String	JE	Scheme constant for Berkeley DB (JE) backed spaces.
static final String	LSPACE	Scheme constant for L-space (Loom-optimized) transient spaces.
static final String	PERSISTENT	Scheme constant for persistent (jdbm-backed) spaces.
static final String	SPACELET	Scheme constant used to look up an externally-registered spacelet.
static final String	TRANSIENT	Scheme alias for TSPACE.
static final String	TSPACE	Scheme constant for transient (in-memory) spaces.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static ScheduledThreadPoolExecutor	getGCExecutor()	Returns the shared executor used by spaces to run lease-expiry/GC tasks.
static Space	getSpace()	Returns the default transient space (equivalent to tspace:default).
static Space	getSpace(String spaceUri)	Resolves a space URI of the form scheme:name[:param].
static Space	getSpace(String scheme, String name, String param)	Resolves the space identified by scheme, name, and optional param, registering a newly-created space in NameRegistrar on first use.

Methods inherited from class Object

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

Field Details

TSPACE

public static final String TSPACE

Scheme constant for transient (in-memory) spaces.

See Also:

• Constant Field Values

LSPACE

public static final String LSPACE

Scheme constant for L-space (Loom-optimized) transient spaces.

See Also:

• Constant Field Values

TRANSIENT

public static final String TRANSIENT

Scheme alias for TSPACE.

See Also:

• Constant Field Values

PERSISTENT

public static final String PERSISTENT

Scheme constant for persistent (jdbm-backed) spaces.

See Also:

• Constant Field Values

SPACELET

public static final String SPACELET

Scheme constant used to look up an externally-registered spacelet.

See Also:

• Constant Field Values

JDBM

public static final String JDBM

Scheme constant for JDBM-backed spaces.

See Also:

• Constant Field Values

JE

public static final String JE

Scheme constant for Berkeley DB (JE) backed spaces.

See Also:

• Constant Field Values

DEFAULT

public static final String DEFAULT

Default name used for unnamed spaces.

See Also:

• Constant Field Values

Constructor Details

SpaceFactory

public SpaceFactory()

Default constructor; no instance state to initialise.

Method Details

getSpace

public static Space getSpace()

Returns the default transient space (equivalent to tspace:default).

Returns:

the default TransientSpace

getSpace

public static Space getSpace(String spaceUri)

Resolves a space URI of the form scheme:name[:param].

Parameters:

spaceUri - space URI; null returns the default space

Returns:

Space for given URI or null

getSpace

public static Space getSpace(String scheme,
 String name,
 String param)

Resolves the space identified by scheme, name, and optional param, registering a newly-created space in NameRegistrar on first use.

Parameters:

scheme - space scheme (one of the TSPACE/LSPACE/... constants)

name - space name

param - optional scheme-specific parameter (e.g. file path for jdbm:)

Returns:

the resolved space

Throws:

SpaceError - if the scheme is unknown or registration fails

getGCExecutor

public static ScheduledThreadPoolExecutor getGCExecutor()

Returns the shared executor used by spaces to run lease-expiry/GC tasks.

Returns:

the shared GC executor