|
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Connection
Represents a physical connection between the client and the SOA middleware for an
application. The client can communicate with the services of an application through
this physical connection.
The Connection
object can be created by invoking SoamFactory.connect
.
After a connection has been established, a Session
object can be created to
manage the workload. Create a Session
by invoking Connection.createSession
.
NOTE: If any of the methods of this interface are called after the Main(...) method exits,
the client or service process may behave in an undefined manner (for example,
hang or terminate abnormally).
SoamFactory.connect(String)
,
SoamFactory.connect(String, ConnectionSecurityCallback)
,
SoamFactory.connect(String, String)
,
SoamFactory.connect(String, String, ConnectionSecurityCallback)
,
Session
Method Summary | |
---|---|
void |
close()
Closes this Connection (mandatory). |
Session |
createSession()
Deprecated. As of Symphony 3.1, replaced by createSession(SessionCreationAttributes) |
Session |
createSession(SessionCreationAttributes attributes)
Creates a Session on this Connection with the
provided attributes. |
Session |
createSession(java.lang.String sessionName)
Deprecated. As of Symphony 3.1, replaced by createSession(SessionCreationAttributes) |
Session |
createSession(java.lang.String sessionName,
java.lang.String sessionType)
Deprecated. As of Symphony 3.1, replaced by createSession(SessionCreationAttributes) |
Session |
createSession(java.lang.String sessionName,
java.lang.String sessionType,
long sessionFlags)
Deprecated. As of Symphony 3.1, replaced by createSession(SessionCreationAttributes) |
Session |
createSession(java.lang.String sessionName,
java.lang.String sessionType,
long sessionFlags,
SessionCallback callback)
Deprecated. As of Symphony 3.1, replaced by createSession(SessionCreationAttributes) |
Session |
createSession(java.lang.String sessionName,
java.lang.String sessionType,
long sessionFlags,
SessionCallback callback,
Message commonData)
Deprecated. As of Symphony 3.1, replaced by createSession(SessionCreationAttributes) |
Session |
createSession(java.lang.String sessionName,
java.lang.String sessionType,
long sessionFlags,
SessionCallback callback,
java.io.Serializable commonData)
Deprecated. As of Symphony 3.1, replaced by createSession(SessionCreationAttributes) |
java.lang.String |
getId()
Returns the identifier for this Connection . |
Session |
openSession(SessionOpenAttributes attributes)
Opens an existing session with the provided attributes, and associates it with this connection. |
Session |
openSession(java.lang.String sessionId)
Deprecated. As of Symphony 3.1, replaced by openSession(SessionOpenAttributes) |
Session |
openSession(java.lang.String sessionId,
long sessionFlags)
Deprecated. As of Symphony 3.1, replaced by openSession(SessionOpenAttributes) |
Session |
openSession(java.lang.String sessionId,
long sessionFlags,
SessionCallback callback)
Deprecated. As of Symphony 3.1, replaced by openSession(SessionOpenAttributes) |
Method Detail |
---|
java.lang.String getId() throws SoamException
Connection
.
Connection
SoamException
Session createSession(SessionCreationAttributes attributes) throws SoamException
Session
on this Connection
with the
provided attributes.
recoverable
flag
"true" in the Application Profile.
attributes
- The attributes to apply to the session upon creation.
Session
SoamException
SessionCreationAttributes
Session createSession() throws SoamException
createSession(SessionCreationAttributes)
Session
on this Connection
with the
default attributes.
Session.RECEIVE_SYNC
, which means that you
will send and receive your task results synchronously.
recoverable
flag
"true" in the Application Profile.
Session
SoamException
Session createSession(java.lang.String sessionName) throws SoamException
createSession(SessionCreationAttributes)
Session
on this Connection
with
the provided attributes. In addition, the following default attributes are applied:
Session.RECEIVE_SYNC
, which means that you
will send and receive your task results synchronously.
recoverable
flag
"true" in the Application Profile.
sessionName
- This is just a name for your session, so that the session
can be easily identified. Maximum 1024 characters.
Session
SoamException
Session createSession(java.lang.String sessionName, java.lang.String sessionType) throws SoamException
createSession(SessionCreationAttributes)
Session
on this Connection
with
the provided attributes. In addition, the following default attributes are applied:
Session.RECEIVE_SYNC
, which means that you
will send and receive your task results synchronously.
recoverable
flag
"true" in the Application Profile.
sessionName
- This is just a name for your session, so that the session
can be easily identified. Maximum 1024 characters.sessionType
- This argument tells Symphony which type of session to create.
In the application profile, you can define different types of
sessions with different attributes. Symphony also defines a
system default session type with the name "". For this argument,
specify the name of the session type you would like to use.
An exception will be thrown if a session type is specified
that is not defined.
Session
SoamException
Session createSession(java.lang.String sessionName, java.lang.String sessionType, long sessionFlags) throws SoamException
createSession(SessionCreationAttributes)
Session
on this Connection
with
the provided attributes. In addition, the following default attributes are applied:
recoverable
flag
"true" in the Application Profile.
sessionName
- This is just a name for your session, so that the session
can be easily identified.sessionType
- This argument tells Symphony which type of session to create.
In the application profile, you can define different types of
sessions with different attributes. Symphony also defines a
system default session type with the name "". For this argument,
specify the name of the session type you would like to use.
An exception will be thrown if a session type is specified
that is not defined.sessionFlags
- This argument tells Symphony how you would like to
receive task results for the session.
See the com.platform.symphony.soam.Session
object for explanation of flags and their usage.
Session
SoamException
Session
Session createSession(java.lang.String sessionName, java.lang.String sessionType, long sessionFlags, SessionCallback callback) throws SoamException
createSession(SessionCreationAttributes)
Session
on this Connection
with
the provided attributes. In addition, the following default attributes are applied:
recoverable
flag
"true" in the Application Profile.
sessionName
- This is just a name for your session, so that the session
can be easily identified.sessionType
- This argument tells Symphony which type of session to create.
In the application profile, you can define different types of
sessions with different attributes. Symphony also defines a
system default session type with the name "". For this argument,
specify the name of the session type you would like to use.
An exception will be thrown if a session type is specified
that is not defined.sessionFlags
- This argument tells Symphony how you would like to
receive task results for the session.
See the com.platform.symphony.soam.Session
object for explanation of flags and their usage.callback
- This argument allows you to provide a SessionCallback object,
which is a handler that allows you to process your session's
task results asynchronously. This argument should only be
provided when you have set the appropriate session flag argument
to indicate that you will be receiving task results asynchronously.
Session
SoamException
Session
Session createSession(java.lang.String sessionName, java.lang.String sessionType, long sessionFlags, SessionCallback callback, Message commonData) throws SoamException
createSession(SessionCreationAttributes)
Session
on this Connection
with
the provided attributes.
recoverable
flag
"true" in the Application Profile.
sessionName
- This is just a name for your session, so that your session
can be easily identified.sessionType
- This argument tells Symphony which type of session to create.
In the application profile, you can define different types of
sessions with different attributes. Symphony also defines a
system default session type with the name "". For this argument,
specify the name of the session type you would like to use.
An exception will be thrown if a session type is specified
that is not defined.sessionFlags
- This argument tells Symphony how you would like to
receive task results for the session.
See the com.platform.symphony.soam.Session
object for explanation of flags and their usage.callback
- This argument allows you to provide a SessionCallback object,
which is a handler that allows you to process your session's
task results asynchronously. This argument should only be
provided when you have set the appropriate session flag argument
to indicate that you will be receiving task results asynchronously.commonData
- This argument allows you do provide common data to the session.
Common data is any data that is common to all of the
tasks in your session. You can send common data rather than
sending duplicate data to each task, and thus save on network
overhead.
createSession
overload uses Symphony Serialization.
That is, it sends your common data to the service as a
com.platform.symphony.soam.Message
. If you send your
common data using this overload, you must retrieve your common data
on the service with the
SessionContext.populateCommonData(Message)
method.
Session
SoamException
SessionContext.populateCommonData(com.platform.symphony.soam.Message)
,
Session
Session createSession(java.lang.String sessionName, java.lang.String sessionType, long sessionFlags, SessionCallback callback, java.io.Serializable commonData) throws SoamException
createSession(SessionCreationAttributes)
Session
on this Connection
with
the provided attributes.
recoverable
flag
"true" in the Application Profile.
sessionName
- This is just a name for your session, so that your session
can be easily identified.sessionType
- This argument tells Symphony which type of session to create.
In the application profile, you can define different types of
sessions with different attributes. Symphony also defines a
system default session type with the name "". For this argument,
specify the name of the session type you would like to use.
An exception will be thrown if a session type is specified
that is not defined.sessionFlags
- This argument tells Symphony how you would like to
receive task results for the session.
See the com.platform.symphony.soam.Session
object for explanation of flags and their usage.callback
- This argument allows you to provide a SessionCallback object,
which is a handler that allows you to process your session's
task results asynchronously. This argument should only be
provided when you have set the appropriate session flag argument
to indicate that you will be receiving task results asynchronously.commonData
- This argument allows you do provide common data to the session.
Common data is any data that is common to all of the
tasks in your session. You can send common data rather than
sending duplicate data to each task, and thus save on network
overhead.
createSession
overload uses Native Serialization.
That is, it sends your common data to the service as a
java.io.Serializable
. If you send your common data
using this overload, you must retrieve your common data on the
service with the SessionContext.getCommonData()
method.
createSession
overload to send your common
data as a com.platform.symphony.soam.Message
using
Symphony Serialization.
Session
SoamException
SessionContext.getCommonData()
,
Session
Session openSession(SessionOpenAttributes attributes) throws SoamException
attributes
- The attributes to apply to the session upon opening.
SoamException
SessionOpenAttributes
,
SoamFactory.connect(String)
,
SoamFactory.connect(String, ConnectionSecurityCallback)
,
SoamFactory.connect(String, String)
,
SoamFactory.connect(String, String, ConnectionSecurityCallback)
Session openSession(java.lang.String sessionId) throws SoamException
openSession(SessionOpenAttributes)
Session.RECEIVE_SYNC
, which means that you
will send and receive your task results synchronously.
Connection
sessionId
- The session identifier.
SoamException
SoamFactory.connect(String)
,
SoamFactory.connect(String, ConnectionSecurityCallback)
,
SoamFactory.connect(String, String)
,
SoamFactory.connect(String, String, ConnectionSecurityCallback)
Session openSession(java.lang.String sessionId, long sessionFlags) throws SoamException
openSession(SessionOpenAttributes)
Connection
sessionId
- The session identifier.sessionFlags
- This argument tells Symphony how you would like to
receive task results for the session.
See the com.platform.symphony.soam.Session
object for explanation of flags and their usage.
SoamException
SoamFactory.connect(String)
,
SoamFactory.connect(String, ConnectionSecurityCallback)
,
SoamFactory.connect(String, String)
,
SoamFactory.connect(String, String, ConnectionSecurityCallback)
,
Session
Session openSession(java.lang.String sessionId, long sessionFlags, SessionCallback callback) throws SoamException
openSession(SessionOpenAttributes)
Connection
sessionId
- The session identifier.sessionFlags
- This argument tells Symphony how you would like to
receive task results for the session.
See the com.platform.symphony.soam.Session
object for explanation of flags and their usage.callback
- This argument allows you to provide a SessionCallback object,
which is a handler that allows you to process your session's
task results asynchronously. This argument should only be
provided when you have set the appropriate session flag argument
to indicate that you will be receiving task results asynchronously.
SoamException
SoamFactory.connect(String)
,
SoamFactory.connect(String, ConnectionSecurityCallback)
,
SoamFactory.connect(String, String)
,
SoamFactory.connect(String, String, ConnectionSecurityCallback)
,
SessionCallback
void close() throws SoamException
Connection
(mandatory).
SoamException
|
Version 5.1 Date Modified: -DREL_DATE=Apr 28 2011 Platform Computing. Accelerating Intelligence(TM). Copyright (C) 2001-2009 Platform Computing Corporation. All rights reserved. |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |