Visit Platform at http://www.platform.com

Platform Symphony 5.0 Java API Reference

com.platform.symphony.soam
Class SoamFactory

java.lang.Object
  extended by com.platform.symphony.soam.SoamFactory

public class SoamFactory
extends java.lang.Object

This factory class is used to allocate the SOAM API objects for the client to provide proper lifetime management for all concrete objects in the SOAM API.

See Also:
Connection

Method Summary
static Connection connect(java.lang.String applicationName)
          Creates a connection to the specified Symphony application.
static Connection connect(java.lang.String applicationName, ConnectionSecurityCallback securityCallback)
          Creates a connection to the specified Symphony application.
static Connection connect(java.lang.String clusterURL, java.lang.String applicationName)
          Creates a connection to the specified Symphony application.
static Connection connect(java.lang.String clusterURL, java.lang.String applicationName, ConnectionSecurityCallback securityCallback)
          Creates a connection to the specified Symphony application.
static void initialize()
          Initializes the SOAM API.
static void uninitialize()
          Uninitializes the SOAM API.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

initialize

public static void initialize()
                       throws SoamException
Initializes the SOAM API. The initialize method should be called by the client before any other SOAM API is called.

Throws:
SoamException - if the initialize operation failed

uninitialize

public static void uninitialize()
Uninitializes the SOAM API. The uninitialize() method should be called at the end of all API calls. It should be called only once. This means that once uninitialize(...) is called no other API calls are possible for the life of the process. ** NOTE : Never call uninitialize(...) during the execution of a callback method. This will result in a deadlock.


connect

public static Connection connect(java.lang.String applicationName)
                          throws SoamException
Creates a connection to the specified Symphony application. Once this connection is acquired you may proceed to interact with the application.

Parameters:
applicationName - The name of the application.
Returns:
The created Connection
Throws:
SoamException - if the connection failed
See Also:
Connection

connect

public static Connection connect(java.lang.String applicationName,
                                 ConnectionSecurityCallback securityCallback)
                          throws SoamException
Creates a connection to the specified Symphony application. Once this connection is acquired you may proceed to interact with the application.

Parameters:
applicationName - The name of the application.
securityCallback - The security callback to be used for authentication.
Returns:
The created Connection
Throws:
SoamException - if the connection failed
See Also:
Connection, ConnectionSecurityCallback

connect

public static Connection connect(java.lang.String clusterURL,
                                 java.lang.String applicationName)
                          throws SoamException
Creates a connection to the specified Symphony application. Once this connection is acquired you may proceed to interact with the application.

This overload of the connect call accepts a Cluster Specific URL which will allow the client to connect to different clusters. Cluster Specific URLs must take the following form:

Parameters:
clusterURL - A Cluster Specific URL specifying how to connect to the cluster.
applicationName - The name of the application.
Returns:
The created Connection
Throws:
SoamException - if the connection failed
See Also:
Connection

connect

public static Connection connect(java.lang.String clusterURL,
                                 java.lang.String applicationName,
                                 ConnectionSecurityCallback securityCallback)
                          throws SoamException
Creates a connection to the specified Symphony application. Once this connection is acquired you may proceed to interact with the application.

This overload of the connect call accepts a Cluster Specific URL which will allow the client to connect to different clusters. Cluster Specific URLs must take the following form:

Parameters:
clusterURL - A Cluster Specific URL specifying how to connect to the cluster.
applicationName - The name of the application.
securityCallback - The security callback to be used for authentication.
Returns:
The created Connection
Throws:
SoamException - if the connection failed
See Also:
Connection, ConnectionSecurityCallback

Version 5.0
Date Modified: -DREL_DATE=Nov 11 2009
Platform Computing. Accelerating Intelligence(TM).
Copyright (C) 2001-2009 Platform Computing Corporation. All rights reserved.