GigaSpaces XAP 8.0 API

com.gigaspaces.events
Class EventSessionFactory

java.lang.Object
  extended by com.gigaspaces.events.EventSessionFactory

public class EventSessionFactory
extends Object

the EventSessionFactory is a static service class that creates DataEventSession objects which are used to intercept space data events.

the EventSessionFactory is associated with a space and is required in order to create a factory.
once a factory has been created, it can be used to create sessions.
every session is configured according to an EventSessionConfig object.

the following code example shows how to create a session from a factory
and register a listener to it.
EventSessionConfig config = new EventSessionConfig();
config.setFifo(true);
config.setBatch(100, 20000); // size = 100 , time = 20000ms

IJSpace space = ...
EventSessionFactory factory = EventSessionFactory.getFactory(space);
DataEventSession session = factory.newDataEventSession(config);
Object template = ...
RemoteEventListener listener = ...
session.addListener(template, listener);

Since:
6.0
Version:
1.0
Author:
asy ronen
See Also:
DataEventSession, EventSessionConfig

Method Summary
static EventSessionFactory getFactory(IJSpace space)
          Retrieves the EventSessionFactory according to the space.
 DataEventSession newDataEventSession()
          creates a new DataEventSession using the default configuration.
 DataEventSession newDataEventSession(EventSessionConfig config)
          creates a new DataEventSession using the specified configuration.
 DataEventSession newDataEventSession(EventSessionConfig config, Transaction tx)
          Deprecated. Since 8.0.4 - Event sessions with transactions are deprecated - use newDataEventSession(EventSessionConfig) instead.
static DataEventSession newDataSession(IJSpace space)
          creates a new DataEventSession using the specified space and default configuration.
static DataEventSession newDataSession(IJSpace space, EventSessionConfig config)
          creates a new DataEventSession using the specified space and configuration.
static DataEventSession newDataSession(IJSpace space, Transaction tx, String schemaName)
          Deprecated. Since 8.0.4 - Event sessions with transactions are deprecated - use newDataSession(IJSpace, EventSessionConfig) instead.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getFactory

public static EventSessionFactory getFactory(IJSpace space)
Retrieves the EventSessionFactory according to the space.

Parameters:
space - the associated space
Returns:
the related factory.

newDataSession

public static DataEventSession newDataSession(IJSpace space)
                                       throws RemoteException
creates a new DataEventSession using the specified space and default configuration.

Parameters:
space - The space which the session will listen to.
Returns:
the newly created DataEventSession.
Throws:
RemoteException - when connection to the space fails.
Since:
8.0.4

newDataSession

public static DataEventSession newDataSession(IJSpace space,
                                              EventSessionConfig config)
                                       throws RemoteException
creates a new DataEventSession using the specified space and configuration.

Parameters:
space - The space which the session will listen to.
config - A set of configuration settings used to configure the session.
Returns:
the newly created DataEventSession.
Throws:
RemoteException - when connection to the space fails.
Since:
8.0.4

newDataSession

@Deprecated
public static DataEventSession newDataSession(IJSpace space,
                                                         Transaction tx,
                                                         String schemaName)
                                       throws IOException
Deprecated. Since 8.0.4 - Event sessions with transactions are deprecated - use newDataSession(IJSpace, EventSessionConfig) instead.

creates a new DataEventSession bounded to the specified space, specified transaction
and a predefined configuration schema name.

Parameters:
space - the bounded space
tx - the bounded transaction. NULL if no transaction is needed.
schemaName - the name of the predefined configuration schema
Returns:
the DataEventSession
Throws:
IOException - when schema name is invalid or when connection to the space fails.

newDataEventSession

public DataEventSession newDataEventSession()
                                     throws RemoteException
creates a new DataEventSession using the default configuration.

Returns:
the newly created DataEventSession.
Throws:
RemoteException - when connection to the space fails.
Since:
6.5

newDataEventSession

public DataEventSession newDataEventSession(EventSessionConfig config)
                                     throws RemoteException
creates a new DataEventSession using the specified configuration.

Parameters:
config - A set of configuration settings used to configure the session.
Returns:
the newly created DataEventSession.
Throws:
RemoteException - when connection to the space fails.
Since:
8.0.4

newDataEventSession

@Deprecated
public DataEventSession newDataEventSession(EventSessionConfig config,
                                                       Transaction tx)
                                     throws RemoteException
Deprecated. Since 8.0.4 - Event sessions with transactions are deprecated - use newDataEventSession(EventSessionConfig) instead.

creates a new DataEventSession using the specified configuration and transaction.

Parameters:
config - A set of configuration settings used to configure the session.
tx - the bounded transaction. NULL if no transaction is needed.
Returns:
the newly created DataEventSession.
Throws:
RemoteException - when connection to the space fails.

GigaSpaces XAP 8.0 API

Copyright © GigaSpaces.