Package com.attivio.sdk.server.global

Interface GlobalDataStructureFactory

@Deprecated
public interface GlobalDataStructureFactory

Deprecated.

This API should no longer be used and is scheduled for removal in a future release

Factory for creating new or attaching to existing global data structures that are accessible from all AIE Nodes. An instance of this factory will be provided by an AIE Node during initialization to components that implement GlobalDataStructureFactoryAware.

Method Summary

Modifier and Type	Method	Description
java.io.Closeable	addGlobalMapListener(java.lang.String name, GlobalMapListener listener)	Deprecated. Registers a GlobalMapListener to listen for changes to a persistent global map with name
GlobalLock	createGlobalLock(java.lang.String name, BreakableLockListener lockListener)	Deprecated. Creates a global Lock with the given name if it does not yet exist.
GlobalMap	createGlobalMap(java.lang.String name)	Deprecated. Creates a persistent global map with the given name if it does not yet exist.
GlobalMembership	createGlobalMembership(java.lang.String name)	Deprecated. Creates a global membership with the given name if it does not yet exist.
GlobalSet	createGlobalSet(java.lang.String name, MembershipListener listener)	Deprecated. Creates a global set with the given name if it does not yet exist.
GlobalVariable	createGlobalVariable(java.lang.String name)	Deprecated. Creates a global variable with the given name if it does not yet exist.

Method Detail

createGlobalSet

GlobalSet createGlobalSet(java.lang.String name,
                          MembershipListener listener)
                   throws AttivioException

Deprecated.

Creates a global set with the given name if it does not yet exist. If it already exists, this method returns an instance of GlobalSet that attaches to that existing global set. Callers must supply a MembershipListener which can receive and process callbacks when elements are added or removed from the global set

Parameters:

name - the name of the global set to create or attach to

listener - a MembershipListener which can receive and process callbacks when elements are added to or removed from the global set

Returns:

an instance of GlobalSet representing either the newly created or pre-existing global set with name

Throws:

AttivioException - if for some reason a global set with name cannot be created or attached to

createGlobalVariable

GlobalVariable createGlobalVariable(java.lang.String name)
                             throws AttivioException

Deprecated.

Creates a global variable with the given name if it does not yet exist. If it already exists, this method returns an instance of GlobalVariable that attaches to that existing global variable.

Parameters:

name - the name of the global variable to create or attach to

Returns:

an instance of GlobalVariable representing either the newly created or pre-existing global variable with name

Throws:

AttivioException - if for some reason a global variable with name cannot be created or attached to

createGlobalMembership

GlobalMembership createGlobalMembership(java.lang.String name)
                                 throws AttivioException

Deprecated.

Creates a global membership with the given name if it does not yet exist. If it already exists, this method returns an instance of GlobalMembership that attaches to that existing global membership.

Parameters:

name - The name of the global membership to create or attach to

Returns:

an instance of GlobalMembership representing either the newly created or pre-existing global membership with name

Throws:

AttivioException - if for some reason a global membership with name cannot be created or attached to

createGlobalLock

GlobalLock createGlobalLock(java.lang.String name,
                            BreakableLockListener lockListener)
                     throws AttivioException

Deprecated.

Creates a global Lock with the given name if it does not yet exist. If it already exists, this method returns an instance of Lock that attaches to that existing global Lock.

Parameters:

name - the name of the global Lock to create or attach to

lockListener - a BreakableLockListener which can receive and process callbacks when the global Lock is broken due to network or communication issues

Returns:

an instance of java.util.concurrent.locks.Lock.GlobalLock representing either the newly created or pre-existing global Lock with name

Throws:

AttivioException - if for some reason a global Lock with name cannot be created or attached to

createGlobalMap

GlobalMap createGlobalMap(java.lang.String name)
                   throws AttivioException

Deprecated.

Creates a persistent global map with the given name if it does not yet exist. If it already exists, this method returns an instance of GlobalMap that attaches to that existing persistent global map.

Parameters:

name - the name of the persistent global map to create or attach to

Returns:

an instance of GlobalMap representing either the newly created or pre-existing persistent global map with name

Throws:

AttivioException - if for some reason a persistent global map with name cannot be created or attached to

See Also:

addGlobalMapListener(String, GlobalMapListener)

addGlobalMapListener

java.io.Closeable addGlobalMapListener(java.lang.String name,
                                       GlobalMapListener listener)
                                throws AttivioException

Deprecated.

Registers a GlobalMapListener to listen for changes to a persistent global map with name

The returned Closeable should be closed when updates are no longer needed.

Parameters:

name - the name of the persistent global map to register a listener for

listener - the GlobalMapListener to register to listen for changes on the persistent global map with name

Returns:

an instance of Closeable that the caller should call close() on when updates are no longer needed

Throws:

AttivioException - if for some reason listener cannot be successfully registered to listen for changes on the persistent global map with name

See Also:

createGlobalMap(String)