com.genesyslab.omsdk.mil
Class MILFactory

java.lang.Object
  extended bycom.genesyslab.omsdk.mil.MILFactory
All Implemented Interfaces:
com.genesyslab.omsdk.commons.core.OMSDKLibraryInterface

public abstract class MILFactory
extends java.lang.Object
implements com.genesyslab.omsdk.commons.core.OMSDKLibraryInterface

Entry point to Media Interaction Layer.

The MILFactory instantiates internal classes and makes them available through interfaces. You do not instantiate objects directly in your code.

The MILFactory object is a singleton. This means that only one instance of the MILFactory object exists at runtime.

The MILFactory manages the library initialization and release, as well as connections to the Interaction Server, the Configuration Layer, the LCE server, and UCS, depending on options set in the Configuration Layer.

Before you get a MILFactory instance, first initialize the Open Media common library by creating an OMSDKConnector object. This object manages the connections to servers that are required in order to use the MIL library.

To initialize the OMSDKConnector class:

The following code snippet shows how to initialize the OMSDKConnector class:
InitializationServices milInitServices = MILFactory.getInitializationServices();

InitializationParameters ip = new InitializationParameters(
    "ConfigServerPrimaryHost",
    "ConfigServerPrimaryPort",
    "back up port",
    "back up host",
    "ApplicationName",
    3000, //Reconnection Period in ms
    1 ); //Number of reconnection attempts
ip.addInitializationServices(milInitServices);

OMSDKConnector.initialize(ip);
OMSDKConnector connector = OMSDKConnector.getInstance();

You can now initialize the MIL library.

Create a MILInitializationParameters object, then call the MILFactory.initialize(MILInitializationParameters) static method, as shown in the following code snippet:

// Get initialization parameters
MILInitializationParameters initParameters = new MILInitializationParameters(null);
// Initialize
MILFactory.initialize(initParameters);

Then, to get a MILFactory instance, call the MILFactory.getMILFactory() static method, as shown here:

MILFactory milFactory = MILFactory.getMILFactory();

Note: When terminating your application, release your MILFactory instance by calling the releaseFactory() method to properly release objects made available through this interface. Use the MILFactory class to access the following interfaces:

Since:
7.1.000.00

Method Summary
static InitializationServices getInitializationServices()
          Returns a com.genesyslab.omsdk.commons.InitializationServices object containing service information for initializing MIL.
abstract  MILInteractionManager getInteractionManager()
          Returns the interaction manager.
abstract  MILLCAManager getLCAManager()
          Returns the manager for the Local Control Agent feature.
static MILFactory getMILFactory()
          Returns the MILFactory instance.
abstract  MILUCSManager getUCSManager()
          Returns the manager for the Universal Contact Server.
static void initialize(MILInitializationParameters config)
          Initializes the MILFactory instance.
static void releaseFactory()
          Releases this instance and all the objects made available through this interface.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getMILFactory

public static MILFactory getMILFactory()
Returns the MILFactory instance.

If the instance is not initialized, returns null.

Returns:
MILFactory instance.
See Also:
initialize(MILInitializationParameters)

initialize

public static void initialize(MILInitializationParameters config)
                       throws MILInitializationException
Initializes the MILFactory instance.

If the MILFactory instance is already initialized, no reinitialization occurs.

Parameters:
config - specified initialization parameters.
Throws:
MILInitializationException - Exception thrown if some internal service failed to initialize.

releaseFactory

public static void releaseFactory()
Releases this instance and all the objects made available through this interface.


getInteractionManager

public abstract MILInteractionManager getInteractionManager()
Returns the interaction manager.

Returns:
the interaction manager.

getLCAManager

public abstract MILLCAManager getLCAManager()
Returns the manager for the Local Control Agent feature.

Returns:
the LCA manager.

getUCSManager

public abstract MILUCSManager getUCSManager()
Returns the manager for the Universal Contact Server.

Returns:
the UCS manager.

getInitializationServices

public static InitializationServices getInitializationServices()
Returns a com.genesyslab.omsdk.commons.InitializationServices object containing service information for initializing MIL.

Returns:
com.genesyslab.omsdk.commons.InitializationServices object containing service information for initializing MIL.