com.tibco.as.space

Class Metaspace

java.lang.Object

com.tibco.as.space.Metaspace

public abstract class Metaspace
extends java.lang.Object

Metaspace represents both an administrative collection of Space (system and user spaces) and the collection of Member (ActiveSpaces applications and Agents) working collaboratively to implement those Spaces. A Metaspace instance has a name and a set of transport arguments associated with it. Multiple independent Metaspace instances can be created in the same ActiveSpaces application. A valid Metaspace name must conform to the following rules:

• Cannot start with a '$' or '_'
• Can contain alphanumeric characters and '-' or '_'

See Also:

MemberDef, Space, Member

Constructor Summary

Constructors

Constructor and Description
Metaspace()

Method Summary

Modifier and Type	Method and Description
abstract void	addRemoteSite(RemoteSiteDef siteDef) Adds the remote site for metaspace router in suspended mode
abstract void	addRemoteSite(RemoteSiteDef siteDef, boolean suspended) Adds the remote site for metaspace router in online mode
abstract void	alterSite(LocalSiteDef localSiteDef) Alter the local site def object
abstract void	alterSpace(SpaceDef spaceDef) Alters a user Space definition.
abstract void	authenticateUser(java.lang.String domain, java.lang.String user, java.lang.String password)
abstract void	beginTransaction() beginTransaction starts a transaction.
abstract Browser	browse(java.lang.String spaceName, BrowserDef.BrowserType browserType) Returns a browser to iterate over the entries in the Space.
abstract Browser	browse(java.lang.String spaceName, BrowserDef.BrowserType browserType, BrowserDef browserDef) Returns a browser to iterate over the entries in the Space.
abstract Browser	browse(java.lang.String spaceName, BrowserDef.BrowserType browserType, BrowserDef browserDef, java.lang.String filter) Returns a browser to iterate over the entries in the Space that match the specified filter.
abstract EventBrowser	browseEvents(java.lang.String spaceName, EventBrowserDef eventBrowserDef) Returns a browser to iterate over the events generated by changes in Space.
abstract EventBrowser	browseEvents(java.lang.String spaceName, EventBrowserDef eventBrowserDef, java.lang.String filter) Returns a browser to iterate over the events generated by changes in Space for tuples that match the specified filter.
abstract void	close() Frees resources used by the Metaspace object.
abstract void	closeAll() Frees resources used by the Metaspace object.
abstract void	commitTransaction() Commits all of the Space operations invoked in this thread since beginTransaction was called.
static Metaspace	connect() Establishes a default connection to a Metaspace using "ms" as the metaspace name and default MemberDef attributes.
static Metaspace	connect(java.lang.String name, MemberDef memberDef) Establishes connection to metaspace using the metaspace name and MemberDef specified.
static Metaspace	connect(java.lang.String name, MemberDef memberDef, LocalSiteDef localSiteDef)
abstract void	defineSpace(SpaceDef spaceDef) Defines a user Space.
abstract void	disconnect() Deprecated. This method is deprecated and calls closeAll()
abstract void	dropSpace(java.lang.String spaceName) Deletes the Space Definitions only if no Members are joined to the space.
abstract void	dropSpace(java.lang.String spaceName, boolean doClientCheck) Deletes the Space Definitions only if no Members are joined to the space.
abstract LocalSiteDef	getLocalSiteDef()
abstract Member	getMember(java.lang.String memberId) Get member object through member id or name
abstract MemberDef	getMemberDef() Returns the metaspace connection definition attributes
abstract java.util.Collection<Member>	getMetaspaceMembers() Returns the collection of @Member of the metaspace
abstract java.util.Collection<Member>	getMetaspaceRemoteMembers() Returns the collection of @Member of the metaspace that are connected using remote discovery
abstract java.lang.String	getName() Returns metaspace name
abstract RemoteSiteDef	getRemoteSiteDef(java.lang.String siteName) Get remote site def object
abstract RemoteSiteDef.SiteRemoteState	getRemoteSiteRemoteState(java.lang.String siteName) Get remote state of remote site
abstract RemoteSiteDef.SiteState	getRemoteSiteState(java.lang.String siteName) Get state of remote site
abstract Member	getSelfMember() Returns the Member for this Metaspace connection.
abstract Space	getSpace(java.lang.String spaceName) Returns the space after joining it with role LEECH, if it is not already joined.
abstract Space	getSpace(java.lang.String spaceName, Member.DistributionRole distributionRole) Returns the space after joining it, if it is not already joined.
abstract Space	getSpace(java.lang.String spaceName, SpaceMemberDef spaceMemberDef) Deprecated. Use other methods to retrieve Space reference. DataStore can be provided using MemberDef while connecting to metaspace.
abstract SpaceDef	getSpaceDef(java.lang.String spaceName) Gets space definition for the given Space name.
abstract java.util.Collection<Member>	getSpaceMembers(java.lang.String spacename) Returns the collection of @Member of the space
abstract java.util.Collection<Member>	getSpaceRemoteMembers(java.lang.String spacename) Returns the collection of @Member of the space that are connected using remote discovery
abstract SpaceDef.SpaceState	getSpaceState(java.lang.String spaceName) Returns the space state of the specified space name
abstract java.util.Collection<java.lang.String>	getUserSpaceNames() Returns the user space names
abstract Listener	listen(java.lang.String spaceName, Listener listener) Returns a listener on a space for receiving event notifications.
abstract Listener	listen(java.lang.String spaceName, Listener listener, ListenerDef listenerDef) Returns a listener on a space for receiving event notifications.
abstract Listener	listen(java.lang.String spaceName, Listener listener, ListenerDef listenerDef, java.lang.String filter) Returns a listener on a space for receiving event notifications.
abstract Listener	listen(java.lang.String spaceName, Listener listener, java.lang.String filter) Returns a listener on a space for receiving event notifications.
abstract Listener	listenMetaspaceMembers(MetaspaceMemberListener metaspaceMemberListener) Listen to metaspace membership events
abstract Listener	listenMetaspaceRemoteMembers(MetaspaceRemoteMemberListener remoteMetaspaceMemberListener) Listen to remote metaspace membership events
abstract Listener	listenRemoteSiteState(SiteStateListener siteStateListener) Listen to site state updates for all remote sites.
abstract Listener	listenRemoteSiteState(java.lang.String siteName, SiteStateListener siteStateListener) Listen to site state updates for a remote site.
abstract Listener	listenSiteDefs(SiteDefListener siteDefListener) Listen to site definitions.
abstract Listener	listenSpaceDefs(SpaceDefListener spaceDefListener) Listen to space definitions.
abstract Listener	listenSpaceMembers(SpaceMemberListener spaceMemberListener) Listen to space membership events
abstract Listener	listenSpaceMembers(java.lang.String spaceName, SpaceMemberListener spaceMemberListener) Listen to space membership events
abstract Listener	listenSpaceRemoteMembers(SpaceRemoteMemberListener remoteSpaceMemberListener) Listen to remote space membership events
abstract Listener	listenSpaceRemoteMembers(java.lang.String spaceName, SpaceRemoteMemberListener remoteSpaceMemberListener) Listen to remote space membership events
abstract Listener	listenSpaceState(SpaceStateListener spaceStateListener) Listen to space state updates for all spaces.
abstract Listener	listenSpaceState(java.lang.String spaceName, SpaceStateListener spaceStateListener) Listen to space state updates for specified space name.
abstract void	recover()
abstract void	recover(RecoveryOptions recoveryOptions) If quorum size is specified in RecoveryOptions this method would be blocking until quorum size is met.
abstract void	recoverSpace(java.lang.String spaceName)
abstract void	recoverSpace(java.lang.String spaceName, RecoveryOptions recoveryOptions) If quorum size is specified in RecoveryOptions this method would be blocking until quorum size is met.
abstract Context	releaseContext() releaseContext is used to release the Context object from one thread so that it can be transferred to another thread.
abstract TransactionId	releaseTransaction() Deprecated.
abstract void	removeRemoteSite(java.lang.String siteName) Removes a remote site by name
abstract void	resume()
abstract void	resumeRouting(java.lang.String siteName) Resume routing
abstract void	resumeSpace(java.lang.String spaceName)
abstract void	rollbackTransaction() Reverses all of the Space operations invoked in this thread since beginTransaction was called.
abstract MetaspaceReceiver	setReceiver(MetaspaceReceiver receiver) Registers the metaspace receiver implementation for the remote site
abstract MetaspaceRouter	setRouter(MetaspaceRouter router) Registers the metaspace router implementation for the local site
abstract void	stopListener(Listener listener) Stops a listener and associated thread that was previously created.
abstract void	stopReceiver(MetaspaceReceiver receiver) Stops the metaspace receiver for the remote site
abstract void	stopRouter(MetaspaceRouter router) Stops the metaspace router for the local site
abstract void	suspend()
abstract void	suspendRouting(java.lang.String siteName) Suspend routing for remote site
abstract void	takeContext(Context context) takeContext replaces the current thread's Context object with the one provided.
abstract void	takeTransaction(TransactionId transactionId) Deprecated.
static java.lang.String	version() Retrieves the version of the ActiveSpaces product.

Methods inherited from class java.lang.Object

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

Constructor Detail

Metaspace

public Metaspace()

Method Detail

connect

public static Metaspace connect()
                         throws ASException

Establishes a default connection to a Metaspace using "ms" as the metaspace name and default MemberDef attributes.

Returns:

Metaspace The connected Metaspace

Throws:

ASException - Exception is thrown if

• connect fails
• connect is called on a metaspace name that is already connected. If a handle to an already connected metaspace is needed use the ASCommon.getMetaspace(java.lang.String) function to get it.

connect

public static Metaspace connect(java.lang.String name,
                                MemberDef memberDef)
                         throws ASException

Establishes connection to metaspace using the metaspace name and MemberDef specified. A process can not connect twice to the same metaspace. If ahandle to an already connected metaspace is needed use the ASCommon.getMetaspace(java.lang.String) function to get it.

Parameters:

name - Name of the metaspace to connect

memberDef - Connection definition to use

Returns:

Metaspace object if connection is established

Throws:

ASException - Exception is thrown if connect fails

connect

public static Metaspace connect(java.lang.String name,
                                MemberDef memberDef,
                                LocalSiteDef localSiteDef)
                         throws ASException

Throws:

ASException

getSpace

@Deprecated
public abstract Space getSpace(java.lang.String spaceName,
                                           SpaceMemberDef spaceMemberDef)
                                    throws ASException

Deprecated. Use other methods to retrieve Space reference. DataStore can be provided using MemberDef while connecting to metaspace.

Returns the space after joining it, if it is not already joined. If it is already joined, it will attempt to adjust the role to the specified role in SpaceMemberDef if needed and return a valid referenced counted handle to the space.

Parameters:

spaceName - Name of the space

spaceMemberDef - SpaceMemberDef

Returns:

The Space object

Throws:

ASException - Exception is thrown if space handle cannot be retrieved

getSpace

public abstract Space getSpace(java.lang.String spaceName,
                               Member.DistributionRole distributionRole)
                        throws ASException

Returns the space after joining it, if it is not already joined. If it is already joined, it will attempt to adjust the role to the specified role if needed and return a valid referenced counted handle to the space.

Parameters:

spaceName - Name of the Space

distributionRole - DistributionRole can be either LEECH or SEEDER

Returns:

Space The Space object

Throws:

ASException - Exception is thrown if space handle cannot be retrieved

getSpace

public abstract Space getSpace(java.lang.String spaceName)
                        throws ASException

Returns the space after joining it with role LEECH, if it is not already joined. If it is already joined, the role will not be changed and a valid reference counted handle to the space will be returned.

Parameters:

spaceName - Name of the space

Returns:

Space The Space object

Throws:

ASException - Exception is thrown if space handle cannot be retrieved

browse

public abstract Browser browse(java.lang.String spaceName,
                               BrowserDef.BrowserType browserType)
                        throws ASException

Returns a browser to iterate over the entries in the Space.

Parameters:

spaceName - Name of space to browse entries on

browserType - Can be one of GET, TAKE and LOCK as defined in BrowserDef.BrowserType

Returns:

Browser The created Browser

Throws:

ASException - Exception is thrown if browser object cannot be created

See Also:

Browser, BrowserDef

browse

public abstract Browser browse(java.lang.String spaceName,
                               BrowserDef.BrowserType browserType,
                               BrowserDef browserDef)
                        throws ASException

Returns a browser to iterate over the entries in the Space.

Parameters:

spaceName - Name of space to browse entries on

browserType - Can be one of GET, TAKE and LOCK as defined in BrowserDef.BrowserType

browserDef - Browser definition

Returns:

Browser The created Browser

Throws:

ASException - Exception is thrown if browser object cannot be created

See Also:

Browser, BrowserDef

browse

public abstract Browser browse(java.lang.String spaceName,
                               BrowserDef.BrowserType browserType,
                               BrowserDef browserDef,
                               java.lang.String filter)
                        throws ASException

Returns a browser to iterate over the entries in the Space that match the specified filter.

Parameters:

spaceName - Name of space to browse entries on

browserType - Can be one of GET, TAKE and LOCK as defined in BrowserDef.BrowserType

browserDef - Browser definition

filter - A String that can be used to create a Filter

Returns:

Browser The created Browser

Throws:

ASException - Exception is thrown if browser object cannot be created

See Also:

Browser, BrowserDef

browseEvents

public abstract EventBrowser browseEvents(java.lang.String spaceName,
                                          EventBrowserDef eventBrowserDef)
                                   throws ASException

Returns a browser to iterate over the events generated by changes in Space.

Parameters:

spaceName - Name of space to browse events on

eventBrowserDef - Browser definition

Returns:

EventBrowser the created EventBrowser

Throws:

ASException - Exception is thrown if browser object cannot be created

See Also:

EventBrowser, EventBrowserDef

browseEvents

public abstract EventBrowser browseEvents(java.lang.String spaceName,
                                          EventBrowserDef eventBrowserDef,
                                          java.lang.String filter)
                                   throws ASException

Returns a browser to iterate over the events generated by changes in Space for tuples that match the specified filter.

Parameters:

spaceName - Name of space to browse events on

eventBrowserDef - Browser definition

filter - A String that can be used to create a Filter

Returns:

EventBrowser The created EventBrowser

Throws:

ASException - Exception is thrown if event browser object cannot be created

See Also:

EventBrowser, EventBrowserDef

listen

public abstract Listener listen(java.lang.String spaceName,
                                Listener listener)
                         throws ASException

Returns a listener on a space for receiving event notifications.

Parameters:

spaceName - Name of space to browse entries on

listener - The callback listener class which needs to be registered

Returns:

Listener The created Listener

Throws:

ASException - Exception is thrown if listener object cannot be created

listen

public abstract Listener listen(java.lang.String spaceName,
                                Listener listener,
                                ListenerDef listenerDef)
                         throws ASException

Returns a listener on a space for receiving event notifications. Listener definition can also be supplied to specify the distribution and time scopes.

Parameters:

spaceName - Name of space to listen for events on

listener - The callback listener which needs to be registered

listenerDef - ListenerDef can be supplied to specify the distribution and time scopes

Returns:

Listener The created Listener

Throws:

ASException - Exception is thrown if listener object cannot be created

listen

public abstract Listener listen(java.lang.String spaceName,
                                Listener listener,
                                java.lang.String filter)
                         throws ASException

Returns a listener on a space for receiving event notifications. This listener is invoked only when the Tuple in the Event matches the filter.

Parameters:

spaceName - Name of space to browse entries on

listener - The callback listener which needs to be registered

filter - A String that can be used to create a Filter

Returns:

Listener The created Listener

Throws:

ASException - Exception is thrown if listener object cannot be created

listen

public abstract Listener listen(java.lang.String spaceName,
                                Listener listener,
                                ListenerDef listenerDef,
                                java.lang.String filter)
                         throws ASException

Returns a listener on a space for receiving event notifications. This listener is invoked only when the Tuple in the Event matches the filter. Listener definition can also be supplied to specify the distribution and time scopes.

Parameters:

spaceName - Name of space to browse entries on

listener - The callback listener which needs to be registered

listenerDef - ListenerDef can be setup to declare time and entry scope

filter - A String that can be used to create a Filter

Returns:

Listener The created Listener

Throws:

ASException - Exception is thrown if listener object cannot be created

listenSpaceState

public abstract Listener listenSpaceState(SpaceStateListener spaceStateListener)
                                   throws ASException

Listen to space state updates for all spaces.

Parameters:

spaceStateListener - SpaceStateListener class that implements necessary methods

Returns:

Listener object that is used to stop listening

Throws:

ASException - Exception is thrown if listener object cannot be created

listenSpaceState

public abstract Listener listenSpaceState(java.lang.String spaceName,
                                          SpaceStateListener spaceStateListener)
                                   throws ASException

Listen to space state updates for specified space name.

Parameters:

spaceStateListener - SpaceStateListener class that implements necessary methods

spaceName - Name of the space to listen for state changes

Returns:

Listener object that is used to stop listening

Throws:

ASException - Exception is thrown if listener object cannot be created

listenSpaceDefs

public abstract Listener listenSpaceDefs(SpaceDefListener spaceDefListener)
                                  throws ASException

Listen to space definitions. Get notification about new spaces being defined in the metaspace

Parameters:

spaceDefListener - SpaceDefListener class that implements necessary callback functions

Returns:

Listener object that is used to stop listening

Throws:

ASException - Exception is thrown if listener object cannot be created

listenMetaspaceMembers

public abstract Listener listenMetaspaceMembers(MetaspaceMemberListener metaspaceMemberListener)
                                         throws ASException

Listen to metaspace membership events

Parameters:

metaspaceMemberListener - MetaspaceMemberListneer class that implements necessary callback functions

Returns:

Listener object that is used to stop listening

Throws:

ASException - Exception is thrown if listener object cannot be created

listenMetaspaceRemoteMembers

public abstract Listener listenMetaspaceRemoteMembers(MetaspaceRemoteMemberListener remoteMetaspaceMemberListener)
                                               throws ASException

Listen to remote metaspace membership events

Parameters:

remoteMetaspaceMemberListener - RemoteMetaspaceMemberListneer class that implements necessary callback functions

Returns:

Listener object that is used to stop listening

Throws:

ASException - Exception is thrown if listener object cannot be created

listenSpaceMembers

public abstract Listener listenSpaceMembers(SpaceMemberListener spaceMemberListener)
                                     throws ASException

Listen to space membership events

Parameters:

spaceMemberListener - SpaceMemberListneer class that implements necessary callback functions

Returns:

Listener object that is used to stop listening

Throws:

ASException - Exception is thrown if listener object cannot be created

listenSpaceMembers

public abstract Listener listenSpaceMembers(java.lang.String spaceName,
                                            SpaceMemberListener spaceMemberListener)
                                     throws ASException

Listen to space membership events

Parameters:

spaceName - Space name to listen for membership updates on

spaceMemberListener - SpaceMemberListneer class that implements necessary callback functions

Returns:

Listener object that is used to stop listening

Throws:

ASException - Exception is thrown if listener object cannot be created

listenSpaceRemoteMembers

public abstract Listener listenSpaceRemoteMembers(SpaceRemoteMemberListener remoteSpaceMemberListener)
                                           throws ASException

Listen to remote space membership events

Parameters:

remoteSpaceMemberListener - RemoteSpaceMemberListneer class that implements necessary callback functions

Returns:

Listener object that is used to stop listening

Throws:

ASException - Exception is thrown if listener object cannot be created

listenSpaceRemoteMembers

public abstract Listener listenSpaceRemoteMembers(java.lang.String spaceName,
                                                  SpaceRemoteMemberListener remoteSpaceMemberListener)
                                           throws ASException

Listen to remote space membership events

Parameters:

spaceName - Space name to listen for membership updates on

remoteSpaceMemberListener - RemoteSpaceMemberListener class that implements necessary callback functions

Returns:

Listener object that is used to stop listening

Throws:

ASException - Exception is thrown if listener object cannot be created

stopListener

public abstract void stopListener(Listener listener)
                           throws ASException

Stops a listener and associated thread that was previously created.

Parameters:

listener - The Listener to be stopped

Throws:

ASException

defineSpace

public abstract void defineSpace(SpaceDef spaceDef)
                          throws ASException

Defines a user Space. Does not automatically join the Space. If the Space was already defined but the definition of the existing Space does not match the provided Space Definition, an ASException will be thrown.

Parameters:

spaceDef - The Space Definition containing attributes of Space

Throws:

ASException - Exception is thrown if space cannot be created

alterSpace

public abstract void alterSpace(SpaceDef spaceDef)
                         throws ASException

Alters a user Space definition. If spacedef is not defined, alter space will define it. If new space definition is not compatible with existing one, exception is provided with the cause of offending attribute

Parameters:

spaceDef - The Space Definition containing attributes of Space

Throws:

ASException - Exception is thrown if space cannot be altered

dropSpace

public abstract void dropSpace(java.lang.String spaceName)
                        throws ASException

Deletes the Space Definitions only if no Members are joined to the space.

Parameters:

spaceName - The name of the space

Throws:

ASException - Exception is thrown if drop space fails (if any members are still joined to it)

dropSpace

public abstract void dropSpace(java.lang.String spaceName,
                               boolean doClientCheck)
                        throws ASException

Deletes the Space Definitions only if no Members are joined to the space.

Parameters:

spaceName - The name of the space

doClientCheck - Allow drop to succeed even if there are remote clients connected to the space

Throws:

ASException - Exception is thrown if drop space fails (if any members are still joined to it)

getSpaceDef

public abstract SpaceDef getSpaceDef(java.lang.String spaceName)
                              throws ASException

Gets space definition for the given Space name.

Parameters:

spaceName - The name of the Space

Returns:

Space definition

Throws:

ASException - Exception is thrown if space definition cannot be retrieved

getSpaceState

public abstract SpaceDef.SpaceState getSpaceState(java.lang.String spaceName)
                                           throws ASException

Returns the space state of the specified space name

Parameters:

spaceName - The name of the Space

Returns:

Space state

Throws:

ASException - Exception is thrown if space does not exists

recoverSpace

public abstract void recoverSpace(java.lang.String spaceName)
                           throws ASException

Parameters:

spaceName - Space name to recover

Throws:

ASException

recoverSpace

public abstract void recoverSpace(java.lang.String spaceName,
                                  RecoveryOptions recoveryOptions)
                           throws ASException

If quorum size is specified in RecoveryOptions this method would be blocking until quorum size is met. Once quorum size is reached, recoverSpace method unblocks and recovery is initiated. Refer to space recovery for more details on recovery process.

Parameters:

spaceName - Space name to recover

recoveryOptions - Recovery options

Throws:

ASException

resumeSpace

public abstract void resumeSpace(java.lang.String spaceName)
                          throws ASException

Parameters:

spaceName - Space name to resume

Throws:

ASException

suspend

public abstract void suspend()
                      throws ASException

Throws:

ASException

resume

public abstract void resume()
                     throws ASException

Throws:

ASException

recover

public abstract void recover()
                      throws ASException

Throws:

ASException

recover

public abstract void recover(RecoveryOptions recoveryOptions)
                      throws ASException

If quorum size is specified in RecoveryOptions this method would be blocking until quorum size is met. Once quorum size is reached, recover method unblocks and recovery is initiated. Refer to space recovery for more details on recovery process.

Parameters:

recoveryOptions - Recovery options

Throws:

ASException

disconnect

public abstract void disconnect()
                         throws ASException

Deprecated. This method is deprecated and calls closeAll()

Frees resources used by the Metaspace object. Invalidates this metaspace reference. If there are no more references, this method will disconnect from metaspace.

Throws:

RuntimeASException - Calling this function on a Metaspace that is already disconnected will return INVALID_METASPACE.

ASException

close

public abstract void close()
                    throws ASException

Frees resources used by the Metaspace object. Invalidates this metaspace reference. If there are no more references, this method will disconnect from metaspace.

Throws:

RuntimeASException - Calling this function on a Metaspace that is already disconnected will return INVALID_METASPACE.

ASException

closeAll

public abstract void closeAll()
                       throws ASException

Frees resources used by the Metaspace object. Immediately closes the connection to the Metaspace. Forces all Spaces, Browsers, and Listeners to be freed, and their handles to become invalid.

Throws:

RuntimeASException - Calling this function on a Metaspace that is already disconnected will return INVALID_METASPACE.

ASException

beginTransaction

public abstract void beginTransaction()
                               throws ASException

beginTransaction starts a transaction. Any operations on any Space in this metaspace called from the thread that currently owns the transaction will be in a transactional state, until either commitTransaction or rollbackTransaction is invoked. Transaction is scoped by the current thread context.

Throws:

ASException - Exception is thrown if begin transaction fails

commitTransaction

public abstract void commitTransaction()
                                throws ASException

Commits all of the Space operations invoked in this thread since beginTransaction was called.

Throws:

ASException - Exception is thrown if commit transaction fails

rollbackTransaction

public abstract void rollbackTransaction()
                                  throws ASException

Reverses all of the Space operations invoked in this thread since beginTransaction was called.

Throws:

ASException - Exception is thrown if rollback transaction fails

releaseContext

public abstract Context releaseContext()
                                throws ASException

releaseContext is used to release the Context object from one thread so that it can be transferred to another thread. The thread's information for locks and transactions are stored in an intermediate Context object. The other thread calls (@link Metaspace#takeContext(Context)} to take ownership of the transaction and locks released by the first thread. Replaces the deprecated method releaseTransaction()

Returns:

The intermediate Context object to use to transfer ownership of a transaction and locks to another thread.

Throws:

ASException - if releaseContext fails.

takeContext

public abstract void takeContext(Context context)
                          throws ASException

takeContext replaces the current thread's Context object with the one provided. If the current thread has existing transactions or locks when takeContext is called, that information will be lost. Replaces the deprecated method takeTransaction(TransactionId)

Parameters:

context - A Context object from another thread.

Throws:

ASException - if an error occurs.

releaseTransaction

@Deprecated
public abstract TransactionId releaseTransaction()
                                                      throws ASException

Deprecated.

Returns:

TransationId if the thread is in a transaction. TransactionId can then be given to another thread to continue transaction

Throws:

ASException - Exception is thrown if release transaction fails

takeTransaction

@Deprecated
public abstract void takeTransaction(TransactionId transactionId)
                                          throws ASException

Deprecated.

Parameters:

transactionId - Transaction id to pass to this thread context

Throws:

ASException - Exception is thrown if take transaction fails

getSelfMember

public abstract Member getSelfMember()

Returns the Member for this Metaspace connection.

Returns:

Member This member

getMember

public abstract Member getMember(java.lang.String memberId)
                          throws ASException

Get member object through member id or name

Parameters:

memberId - Member id or name

Returns:

Member

Throws:

ASException

getMetaspaceMembers

public abstract java.util.Collection<Member> getMetaspaceMembers()
                                                          throws ASException

Returns the collection of @Member of the metaspace

Returns:

Collection of Members

Throws:

ASException

getMetaspaceRemoteMembers

public abstract java.util.Collection<Member> getMetaspaceRemoteMembers()
                                                                throws ASException

Returns the collection of @Member of the metaspace that are connected using remote discovery

Returns:

Collection of Members

Throws:

ASException

getSpaceMembers

public abstract java.util.Collection<Member> getSpaceMembers(java.lang.String spacename)
                                                      throws ASException

Returns the collection of @Member of the space

Returns:

Collection of Members

Throws:

ASException

getSpaceRemoteMembers

public abstract java.util.Collection<Member> getSpaceRemoteMembers(java.lang.String spacename)
                                                            throws ASException

Returns the collection of @Member of the space that are connected using remote discovery

Returns:

Collection of Members

Throws:

ASException

getUserSpaceNames

public abstract java.util.Collection<java.lang.String> getUserSpaceNames()
                                                                  throws ASException

Returns the user space names

Returns:

Collection of space names

Throws:

ASException

getName

public abstract java.lang.String getName()

Returns metaspace name

Returns:

String metaspace name

getMemberDef

public abstract MemberDef getMemberDef()

Returns the metaspace connection definition attributes

Returns:

MemberDef The member definition

authenticateUser

public abstract void authenticateUser(java.lang.String domain,
                                      java.lang.String user,
                                      java.lang.String password)
                               throws ASSecurityException

Throws:

ASSecurityException

setRouter

public abstract MetaspaceRouter setRouter(MetaspaceRouter router)
                                   throws ASException

Registers the metaspace router implementation for the local site

Parameters:

router - metaspace router implementation

Returns:

MetaspaceRouter the metaspace router

Throws:

ASException

stopRouter

public abstract void stopRouter(MetaspaceRouter router)
                         throws ASException

Stops the metaspace router for the local site

Parameters:

router - the registered metaspace router

Throws:

ASException

setReceiver

public abstract MetaspaceReceiver setReceiver(MetaspaceReceiver receiver)
                                       throws ASException

Registers the metaspace receiver implementation for the remote site

Parameters:

receiver - metaspace receiver implementation

Returns:

Receiver the metaspace receiver

Throws:

ASException

stopReceiver

public abstract void stopReceiver(MetaspaceReceiver receiver)
                           throws ASException

Stops the metaspace receiver for the remote site

Parameters:

receiver - the registered metaspace receiver

Throws:

ASException

addRemoteSite

public abstract void addRemoteSite(RemoteSiteDef siteDef)
                            throws ASException

Adds the remote site for metaspace router in suspended mode

Parameters:

siteDef - remote site def for metaspace routing

Throws:

ASException

addRemoteSite

public abstract void addRemoteSite(RemoteSiteDef siteDef,
                                   boolean suspended)
                            throws ASException

Adds the remote site for metaspace router in online mode

Parameters:

siteDef - remote site def for metaspace routing

suspended - starts the remote site in suspended mode

Throws:

ASException

removeRemoteSite

public abstract void removeRemoteSite(java.lang.String siteName)
                               throws ASException

Removes a remote site by name

Parameters:

siteName - of the remote site

Throws:

ASException

getLocalSiteDef

public abstract LocalSiteDef getLocalSiteDef()
                                      throws ASException

Returns:

the local Site Def

Throws:

ASException

getRemoteSiteDef

public abstract RemoteSiteDef getRemoteSiteDef(java.lang.String siteName)
                                        throws ASException

Get remote site def object

Parameters:

siteName - remote site name

Returns:

siteDef

Throws:

ASException

getRemoteSiteState

public abstract RemoteSiteDef.SiteState getRemoteSiteState(java.lang.String siteName)
                                                    throws ASException

Get state of remote site

Parameters:

siteName - remote site name

Returns:

siteState of ONLINE | OFFLINE | RESYNCING

Throws:

ASException

getRemoteSiteRemoteState

public abstract RemoteSiteDef.SiteRemoteState getRemoteSiteRemoteState(java.lang.String siteName)
                                                                throws ASException

Get remote state of remote site

Parameters:

siteName - remote site name

Returns:

siteRemoteState of NORMAL | REPLAYING

Throws:

ASException

listenRemoteSiteState

public abstract Listener listenRemoteSiteState(SiteStateListener siteStateListener)
                                        throws ASException

Listen to site state updates for all remote sites.

Parameters:

siteStateListener - SiteStateListener class that implements necessary methods

Returns:

Listener object that is used to stop listening

Throws:

ASException - Exception is thrown if listener object cannot be created

listenRemoteSiteState

public abstract Listener listenRemoteSiteState(java.lang.String siteName,
                                               SiteStateListener siteStateListener)
                                        throws ASException

Listen to site state updates for a remote site.

Parameters:

siteStateListener - SiteStateListener class that implements necessary methods

Returns:

Listener object that is used to stop listening

Throws:

ASException - Exception is thrown if listener object cannot be created

listenSiteDefs

public abstract Listener listenSiteDefs(SiteDefListener siteDefListener)
                                 throws ASException

Listen to site definitions. Get notification on changes on local and remote site definition

Parameters:

siteDefListener - that implements necessary callback functions

Returns:

Listener object that is used to stop listening

Throws:

ASException - Exception is thrown if listener object cannot be created

alterSite

public abstract void alterSite(LocalSiteDef localSiteDef)
                        throws ASException

Alter the local site def object

Parameters:

localSiteDef - local site def

Throws:

ASException

suspendRouting

public abstract void suspendRouting(java.lang.String siteName)
                             throws ASException

Suspend routing for remote site

Parameters:

siteName - remote site name

Throws:

ASException

resumeRouting

public abstract void resumeRouting(java.lang.String siteName)
                            throws ASException

Resume routing

Parameters:

siteName - remote site name

Throws:

ASException

version

public static java.lang.String version()

Retrieves the version of the ActiveSpaces product.

Returns:

String The currently installed version of the ActiveSpaces product.