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

Platform Symphony 5.0 Java API Reference
A B C D E F G H I M N O P R S T U W

A

addDefinition(ResourceAttributeDefinition) - Method in class com.platform.symphony.soam.ResourcePreference
Allows a definition to be associated with a preference.
addDefinition(ResourceAttributeDefinition) - Method in class com.platform.symphony.soam.SessionCreationAttributes
Add resource attribute definition to resource reference object of the session.
addId(String) - Method in class com.platform.symphony.soam.TaskIdFilter
Adds the specified task ID to the filter.
applyCustomizedDebugAction(boolean) - Method in exception com.platform.symphony.soam.FailureException
Specifies whether to apply the customizedDebugAction when this exception is thrown.
applyCustomizedDebugAction(boolean) - Method in exception com.platform.symphony.soam.FatalException
Specifies whether to apply the customizedDebugAction when this exception is thrown.

B

BEST_SPEED - Static variable in class com.platform.symphony.soam.DataCompressionFlags
This informs the API to use the fastest compression method to compress the data.
BETTER_SIZE - Static variable in class com.platform.symphony.soam.DataCompressionFlags
This informs the API to use the median level compression method to compress the data.

C

close() - Method in interface com.platform.symphony.soam.Connection
Closes this Connection (mandatory).
close() - Method in interface com.platform.symphony.soam.Session
Closes this Session (mandatory).
close(long) - Method in interface com.platform.symphony.soam.Session
Closes this Session (mandatory).
close() - Method in class com.platform.symphony.symexec.ExecutionSession
Closes the ExecutionSession object.
com.platform.symphony.soam - package com.platform.symphony.soam
 
com.platform.symphony.symexec - package com.platform.symphony.symexec
 
COMMON_DATA - Static variable in class com.platform.symphony.soam.SessionUpdateTypes
Type code indicating that common data has been updated.
connect(String) - Static method in class com.platform.symphony.soam.SoamFactory
Creates a connection to the specified Symphony application.
connect(String, ConnectionSecurityCallback) - Static method in class com.platform.symphony.soam.SoamFactory
Creates a connection to the specified Symphony application.
connect(String, String) - Static method in class com.platform.symphony.soam.SoamFactory
Creates a connection to the specified Symphony application.
connect(String, String, ConnectionSecurityCallback) - Static method in class com.platform.symphony.soam.SoamFactory
Creates a connection to the specified Symphony application.
Connection - Interface in com.platform.symphony.soam
Represents a physical connection between the client and the SOA middleware for an application.
ConnectionSecurityCallback - Class in com.platform.symphony.soam
Should be extended by the application developer to allow client verification using custom security framework.
ConnectionSecurityCallback() - Constructor for class com.platform.symphony.soam.ConnectionSecurityCallback
Default Constructor
createSession(SessionCreationAttributes) - Method in interface com.platform.symphony.soam.Connection
Creates a Session on this Connection with the provided attributes.
createSession() - Method in interface com.platform.symphony.soam.Connection
Deprecated. As of Symphony 3.1, replaced by Connection.createSession(SessionCreationAttributes)
createSession(String) - Method in interface com.platform.symphony.soam.Connection
Deprecated. As of Symphony 3.1, replaced by Connection.createSession(SessionCreationAttributes)
createSession(String, String) - Method in interface com.platform.symphony.soam.Connection
Deprecated. As of Symphony 3.1, replaced by Connection.createSession(SessionCreationAttributes)
createSession(String, String, long) - Method in interface com.platform.symphony.soam.Connection
Deprecated. As of Symphony 3.1, replaced by Connection.createSession(SessionCreationAttributes)
createSession(String, String, long, SessionCallback) - Method in interface com.platform.symphony.soam.Connection
Deprecated. As of Symphony 3.1, replaced by Connection.createSession(SessionCreationAttributes)
createSession(String, String, long, SessionCallback, Message) - Method in interface com.platform.symphony.soam.Connection
Deprecated. As of Symphony 3.1, replaced by Connection.createSession(SessionCreationAttributes)
createSession(String, String, long, SessionCallback, Serializable) - Method in interface com.platform.symphony.soam.Connection
Deprecated. As of Symphony 3.1, replaced by Connection.createSession(SessionCreationAttributes)

D

DataCompressionFlags - Class in com.platform.symphony.soam
Data compression flags are used to modify the behavior of the data compression feature.
DataCompressionFlags() - Constructor for class com.platform.symphony.soam.DataCompressionFlags
 
DEFAULT_SYMEXEC_APP - Static variable in class com.platform.symphony.symexec.ExecutionSession
The default application name to be used by clients wishing to connect to the default instance of the Binary Execution Application.
DEFAULT_SYMEXEC_PASSWORD - Static variable in class com.platform.symphony.symexec.ExecutionSession
The default password for clients wishing to connect to the default instance of the Binary Execution Application.
DEFAULT_SYMEXEC_USERNAME - Static variable in class com.platform.symphony.symexec.ExecutionSession
The default username for clients wishing to connect to the default instance of the Binary Execution Application.
DefaultByteArrayMessage - Class in com.platform.symphony.soam
This represents a default implementation for developers requiring a convenient way to pass binary data between a client and a service without creating their own implementation.
DefaultByteArrayMessage() - Constructor for class com.platform.symphony.soam.DefaultByteArrayMessage
Default Constructor
DefaultByteArrayMessage(byte[]) - Constructor for class com.platform.symphony.soam.DefaultByteArrayMessage
Additioanal constructor for the DefaultByteArrayMessage object.
DefaultSecurityCallback - Class in com.platform.symphony.soam
This implementation of ConnectionSecurityCallback uses the middleware's built-in security framework for client verification.
DefaultSecurityCallback(String, String) - Constructor for class com.platform.symphony.soam.DefaultSecurityCallback
Constructor for the callback object.
DefaultTextMessage - Class in com.platform.symphony.soam
This represents a default implementation for developers requiring a convenient way to submit text messages without creating their own implementation.
DefaultTextMessage() - Constructor for class com.platform.symphony.soam.DefaultTextMessage
Default constructor for the default text message.
DefaultTextMessage(String) - Constructor for class com.platform.symphony.soam.DefaultTextMessage
Additional constructor for the default text message.
DESTROY_ON_CLOSE - Static variable in class com.platform.symphony.soam.SessionCloseFlags
Flag to indicate that the Session will be closed.
detach() - Method in class com.platform.symphony.symexec.ExecutionSession
Detaches the ExecutionSession object from the Connection.
DETACH_ON_CLOSE - Static variable in class com.platform.symphony.soam.SessionCloseFlags
Flag to indicate that the Session will be detached from its currently associated Connection.
DETACHABLE_SYMEXEC_SESSION - Static variable in class com.platform.symphony.symexec.ExecutionSession
Executable session of this type will remain in open state and all started task will continue to run when the session's object is destructed or Symphony client process is terminated.
DirectDataTransferFlags - Class in com.platform.symphony.soam
Direct Data Transfer flags are used to modify the behavior of the Direct Data Transfer feature.
DirectDataTransferFlags() - Constructor for class com.platform.symphony.soam.DirectDataTransferFlags
 
discardCommonData() - Method in interface com.platform.symphony.soam.SessionContext
Frees the middleware's local copy of the common data.
discardTaskInput() - Method in interface com.platform.symphony.soam.TaskContext
Frees the middleware's local copy of the Task input.

E

enableDataCompression(boolean) - Method in class com.platform.symphony.soam.SessionCreationAttributes
Enables or disables data compression for a session.
enableDirectDataTransfer(boolean) - Method in class com.platform.symphony.soam.SessionCreationAttributes
Enables or disables Direct Data Transfer for a session.
enableValidation(boolean) - Method in class com.platform.symphony.soam.TaskIdFilter
Enables or disables filter validation.
enableValidation(boolean) - Method in class com.platform.symphony.soam.TaskOutputFilter
Enables or disables filter validation.
EnumItems - Interface in com.platform.symphony.soam
A container that holds completed task results.
EXCLUDE_INPUT_DATA - Static variable in class com.platform.symphony.soam.DirectDataTransferFlags
This informs the API to exclude input data when it is transferring the data directly.
EXCLUDE_OUTPUT_DATA - Static variable in class com.platform.symphony.soam.DirectDataTransferFlags
This informs the API to exclude output data when it is transferring the data directly.
ExecutionCommandContext - Class in com.platform.symphony.symexec
This class is used to give context to the command being executed.
ExecutionCommandContext() - Constructor for class com.platform.symphony.symexec.ExecutionCommandContext
Constructor for the Execution Command Context object.
ExecutionEnumItems - Interface in com.platform.symphony.symexec
An interface to a collection of ExecutionStatus objects.
ExecutionSession - Class in com.platform.symphony.symexec
Acts as a conduit for commands sent to the middleware.
ExecutionSession() - Constructor for class com.platform.symphony.symexec.ExecutionSession
Default constructor for a new ExecutionSession.
ExecutionSession(Connection) - Constructor for class com.platform.symphony.symexec.ExecutionSession
Constructor to create a new ExecutionSession using a connection that already exists.
ExecutionSession(ExecutionSessionContext) - Constructor for class com.platform.symphony.symexec.ExecutionSession
Constructor to create a new ExecutionSession using the default connection and a context.
ExecutionSession(ExecutionSessionContext, Connection) - Constructor for class com.platform.symphony.symexec.ExecutionSession
Constructor to create a new ExecutionSession using a connection that already exists and a context.
ExecutionSession(String) - Constructor for class com.platform.symphony.symexec.ExecutionSession
Constructor to attach to an existing ExecutionSession using the default connection.
ExecutionSession(String, Connection) - Constructor for class com.platform.symphony.symexec.ExecutionSession
Constructor to attach to an existing ExecutionSession using a connection that already exists.
ExecutionSessionContext - Class in com.platform.symphony.symexec
This class is used to give context to all the commands being executed within an ExecutionSession.
ExecutionSessionContext() - Constructor for class com.platform.symphony.symexec.ExecutionSessionContext
Constructor for the Execution Session Context object.
ExecutionStatus - Interface in com.platform.symphony.symexec
Allows access to the status of an executed command.

F

FailureException - Exception in com.platform.symphony.soam
Thrown to indicate a non-fatal error has occurred in the service.
FailureException() - Constructor for exception com.platform.symphony.soam.FailureException
Constructs an exception with a null detail message and no cause.
FailureException(String) - Constructor for exception com.platform.symphony.soam.FailureException
Constructs an exception with the provided detail message and no cause.
FailureException(String, int) - Constructor for exception com.platform.symphony.soam.FailureException
Constructs an exception with the provided detail message and associated error code.
FailureException(String, Throwable) - Constructor for exception com.platform.symphony.soam.FailureException
Constructs an exception with the provided detail message and cause.
FailureException(Throwable) - Constructor for exception com.platform.symphony.soam.FailureException
Constructs an exception with a null detail message and the provided cause.
FatalException - Exception in com.platform.symphony.soam
Thrown to indicate a fatal error has occurred in the service.
FatalException() - Constructor for exception com.platform.symphony.soam.FatalException
Constructs an exception with a null detail message and no cause.
FatalException(String) - Constructor for exception com.platform.symphony.soam.FatalException
Constructs an exception with the provided detail message and no cause.
FatalException(String, int) - Constructor for exception com.platform.symphony.soam.FatalException
Constructs an exception with the provided detail message and associated error code.
FatalException(String, Throwable) - Constructor for exception com.platform.symphony.soam.FatalException
Constructs an exception with the provided detail message and cause.
FatalException(Throwable) - Constructor for exception com.platform.symphony.soam.FatalException
Constructs an exception with a null detail message and the provided cause.
FETCH_RESULTS_DIRECTLY - Static variable in interface com.platform.symphony.soam.Session
This informs the API that the client expects that results will only be returned to the middleware upon the explicit request of the client.
fetchTaskOutput(long) - Method in interface com.platform.symphony.soam.Session
Blocks indefinitely until countMax task responses are ready.
fetchTaskOutput(TaskOutputFilter) - Method in interface com.platform.symphony.soam.Session
Retrieves the task outputs that match the specified filter.
fetchTaskOutput(TaskOutputFilter, int) - Method in interface com.platform.symphony.soam.Session
Retrieves the task outputs that match the specified filter.
fetchTaskOutput(long, int) - Method in interface com.platform.symphony.soam.Session
If countMax task responses are ready before the timeout occurs, this method will return with all countMax responses as soon as they are available; otherwise, this method will block for up to timeoutInSeconds seconds and return with the responses that are available at timeout (will be between 0 and countMax responses, inclusive).
fetchTaskStatus() - Method in class com.platform.symphony.symexec.ExecutionSession
Waits for the completion of the next available result from the session.
fetchTaskStatus(long) - Method in class com.platform.symphony.symexec.ExecutionSession
Waits for the completion of the next countMax results from the session.
fetchTaskStatus(long, int) - Method in class com.platform.symphony.symexec.ExecutionSession
Waits for the completion of the next countMax results from the session for up to timeoutInSeconds seconds.

G

getApplicationName() - Method in interface com.platform.symphony.soam.ServiceContext
Gets the name of the application.
getByteArray() - Method in class com.platform.symphony.soam.DefaultByteArrayMessage
This method allows the developer to retrieve the internal byte array within the message.
getCommonData() - Method in interface com.platform.symphony.soam.SessionContext
Retrieves the Serializable that was passed in when the Session was created.
getConsumerId() - Method in interface com.platform.symphony.soam.ServiceContext
Gets the consumer ID.
getCount() - Method in interface com.platform.symphony.soam.EnumItems
Retrieves the number of items in the enumeration.
getCount() - Method in interface com.platform.symphony.symexec.ExecutionEnumItems
Retrieves the number of items in the collection.
getDeployDirectory() - Method in interface com.platform.symphony.soam.ServiceContext
Gets the deployment directory.
getEmbeddedException() - Method in exception com.platform.symphony.soam.SoamException
Returns the embedded exception object.
getErrorCode() - Method in exception com.platform.symphony.soam.SoamException
Returns the error code associated with the exception.
getErrorType() - Method in exception com.platform.symphony.soam.SoamException
Returns the type of the exception by name for example "FailureException".
getException() - Method in interface com.platform.symphony.soam.TaskInputHandle
Retrieves the attached exception if the message submission was unsuccessful.
getException() - Method in interface com.platform.symphony.soam.TaskOutputHandle
Retrieves the attached exception if the task was unsuccessful.
getException() - Method in interface com.platform.symphony.symexec.ExecutionStatus
Retrieves the attached exception if the Command was unsuccessful.
getExitCode() - Method in interface com.platform.symphony.symexec.ExecutionStatus
The exit code of the Command.
getId() - Method in interface com.platform.symphony.soam.Connection
Returns the identifier for this Connection.
getId() - Method in interface com.platform.symphony.soam.Session
Returns the identier for this Session.
getId() - Method in interface com.platform.symphony.soam.TaskInputHandle
Retrieves the identifier associated with the task, which was created by the middleware when a task input was sent.
getId() - Method in interface com.platform.symphony.soam.TaskOutputHandle
Returns the task identifier for this task.
getId() - Method in class com.platform.symphony.symexec.ExecutionSession
Returns the identifier of the ExecutionSession.
getId() - Method in interface com.platform.symphony.symexec.ExecutionStatus
Returns the identifier for the Command associated with this status.
getInterruptEventCode() - Method in interface com.platform.symphony.soam.InterruptEvent
Returns the interrupt event code.
getInterruptGracePeriod() - Method in interface com.platform.symphony.soam.InterruptEvent
Returns the interrupt grace period.
getLastInterruptEvent() - Method in interface com.platform.symphony.soam.ServiceContext
Gets the current interrupt event.
getLogDirectory() - Method in interface com.platform.symphony.soam.ServiceContext
Gets the log directory.
getNext() - Method in interface com.platform.symphony.soam.EnumItems
Returns the next item in the enumeration, or null if there are no more items.
getNext() - Method in interface com.platform.symphony.symexec.ExecutionEnumItems
Returns the next item in the collection, or null if there are no more items.
getNumberOfServices() - Method in class com.platform.symphony.soam.ServiceToSlotRatio
Gets the number of services portion (the numerator) of the ServiceToSlotRatio.
getNumberOfSlots() - Method in class com.platform.symphony.soam.ServiceToSlotRatio
Gets the number of slots portion (the denominator) of the ServiceToSlotRatio.
getServiceName() - Method in interface com.platform.symphony.soam.ServiceContext
Gets the service name.
getServiceToSlotRatio() - Method in interface com.platform.symphony.soam.ServiceContext
Gets the service to slot ratio for this service instance, which indicates how many slots this service is consuming.
getSessionId() - Method in interface com.platform.symphony.soam.SessionContext
Returns the identifier for the associated Session, as provided by Symphony.
getSessionId() - Method in interface com.platform.symphony.soam.TaskContext
Returns the identifier of the Session that owns this task.
getSubmissionState() - Method in interface com.platform.symphony.soam.TaskInputHandle
Get the current state of submission.
getTaskId() - Method in interface com.platform.symphony.soam.TaskContext
Returns the identifier for this task.
getTaskInput() - Method in interface com.platform.symphony.soam.TaskContext
Retrieves the task input object that was sent from the client to the service.
getTaskOutput() - Method in interface com.platform.symphony.soam.TaskOutputHandle
Retrieves the task output object that was passed back to the client from the service.
getText() - Method in class com.platform.symphony.soam.DefaultTextMessage
This method allows the developer to retrieve the text from the message.

H

HOST - Static variable in class com.platform.symphony.soam.ResourceAttributeScope
Resource attributes published with "Host" scope will be associated with the execution host.

I

INCLUDE_COMMON_DATA_AND_UPDATES - Static variable in class com.platform.symphony.soam.DirectDataTransferFlags
This informs the API to include CDU data when it is transferring the data directly.
initialize() - Static method in class com.platform.symphony.soam.SoamFactory
Initializes the SOAM API.
InputStream - Interface in com.platform.symphony.soam
Used by a Message object for reading, i.e. deserializing.
INSTANCE - Static variable in class com.platform.symphony.soam.ResourceAttributeScope
Resource attributes published with "Instance" scope will be associated with the current service instance from which the resource attribute is being published.
InterruptEvent - Interface in com.platform.symphony.soam
An object that encapsulates the following information: an event code, to determine the type of event that occurred a grace period, which indicates how much time the service will have to react to the event before being forcefully killed Get the last InterruptEvent from the ServiceContext.
isSatisfied() - Method in class com.platform.symphony.soam.TaskIdFilter
Tests whether the filter has been satisfied.
isSatisfied() - Method in class com.platform.symphony.soam.TaskOutputFilter
Tests whether the filter has been satisfied.
isSuccessful() - Method in interface com.platform.symphony.soam.TaskOutputHandle
Indicates whether the corresponding task was successfully processed by the service instance.
isSuccessful() - Method in interface com.platform.symphony.symexec.ExecutionStatus
Indicates whether the corresponding Command was successfully processed by the middleware.
isUpdated(int) - Method in interface com.platform.symphony.soam.SessionContext
Indicates whether the specified attribute was updated.

M

Message - Class in com.platform.symphony.soam
Contains the data that is to be passed by the middleware from the client to the service, or vice versa.
Message() - Constructor for class com.platform.symphony.soam.Message
Default Constructor

N

NONE - Static variable in interface com.platform.symphony.soam.InterruptEvent
Event code indicating that no interrupt event has occurred.

O

onCreateService(ServiceContext) - Method in class com.platform.symphony.soam.ServiceContainer
The middleware triggers the invocation of this handler just after a Service Instance is started.
onDeserialize(InputStream) - Method in class com.platform.symphony.soam.DefaultByteArrayMessage
This method will be called during de-serialization of the message.
onDeserialize(InputStream) - Method in class com.platform.symphony.soam.DefaultTextMessage
\brief This method will be called during de-serialization of the message.
onDeserialize(InputStream) - Method in class com.platform.symphony.soam.Message
Invoked when this Message object needs to be deserialized.
onDestroyService() - Method in class com.platform.symphony.soam.ServiceContainer
The middleware triggers the invocation of this handler just before a Service Instance is destroyed.
onException(SoamException) - Method in class com.platform.symphony.soam.SessionCallback
This method is invoked when an exception occurs within the scope of the given Session.
onGetAuthname() - Method in class com.platform.symphony.soam.ConnectionSecurityCallback
Retrieves and returns the authorization domain that is used to validate the client to the middleware.
onGetAuthname() - Method in class com.platform.symphony.soam.DefaultSecurityCallback
Retrieves and returns the authorization domain that is used to validate the client to the middleware.
onGetPassword() - Method in class com.platform.symphony.soam.ConnectionSecurityCallback
Retrieves and returns the password that is used to validate the client to the middleware.
onGetPassword() - Method in class com.platform.symphony.soam.DefaultSecurityCallback
Retrieves and returns the password that is used to validate the client to the middleware.
onGetTtl() - Method in class com.platform.symphony.soam.ConnectionSecurityCallback
Retrieves and returns the time to live that is used to validate the client to the middleware.
onGetTtl() - Method in class com.platform.symphony.soam.DefaultSecurityCallback
Retrieves and returns the time to live that is used to validate the client to the middleware.
onGetUsername() - Method in class com.platform.symphony.soam.ConnectionSecurityCallback
Retrieves and returns the username that is used to validate the client to the middleware.
onGetUsername() - Method in class com.platform.symphony.soam.DefaultSecurityCallback
Retrieves and returns the username that is used to validate the client to the middleware.
onInvoke(TaskContext) - Method in class com.platform.symphony.soam.ServiceContainer
The middleware triggers the invocation of this handler every time a task input is sent to the service to be processed.
onResponse(TaskOutputHandle) - Method in class com.platform.symphony.soam.SessionCallback
This method is invoked when a task response is available.
onSerialize(OutputStream) - Method in class com.platform.symphony.soam.DefaultByteArrayMessage
This method will be called during serialization of the message.
onSerialize(OutputStream) - Method in class com.platform.symphony.soam.DefaultTextMessage
\brief This method will be called during serialization of the message.
onSerialize(OutputStream) - Method in class com.platform.symphony.soam.Message
Invoked when this Message object needs to be serialized.
onServiceInterrupt(ServiceContext) - Method in class com.platform.symphony.soam.ServiceContainer
The middleware triggers the invocation of this handler every time an interrupt arrives.
onSessionEnter(SessionContext) - Method in class com.platform.symphony.soam.ServiceContainer
The middleware triggers the invocation of this handler to bind the Service Instance to its owning Session when common data is provided by the Client.
onSessionLeave() - Method in class com.platform.symphony.soam.ServiceContainer
The middleware triggers the invocation of this handler to unbind the Service Instance from its owning Session.
onSessionUpdate(SessionContext) - Method in class com.platform.symphony.soam.ServiceContainer
Update this service instance with an update for the binding session.
openSession(SessionOpenAttributes) - Method in interface com.platform.symphony.soam.Connection
Opens an existing session with the provided attributes, and associates it with this connection.
openSession(String) - Method in interface com.platform.symphony.soam.Connection
Deprecated. As of Symphony 3.1, replaced by Connection.openSession(SessionOpenAttributes)
openSession(String, long) - Method in interface com.platform.symphony.soam.Connection
Deprecated. As of Symphony 3.1, replaced by Connection.openSession(SessionOpenAttributes)
openSession(String, long, SessionCallback) - Method in interface com.platform.symphony.soam.Connection
Deprecated. As of Symphony 3.1, replaced by Connection.openSession(SessionOpenAttributes)
OutputStream - Interface in com.platform.symphony.soam
Used by a Message object for writing, i.e. serializing.

P

PARTIAL_ASYNC - Static variable in interface com.platform.symphony.soam.Session
Flag to indicate that the Session will send its input synchronously, but receive its output asynchronously.
populateCommonData(Message) - Method in interface com.platform.symphony.soam.SessionContext
Populates commonData with the data contained in the Message that was passed in when the Session was created.
populateTaskInput(Message) - Method in interface com.platform.symphony.soam.TaskContext
Populates inMsg with the task input that was passed from the client to the service.
populateTaskOutput(Message) - Method in interface com.platform.symphony.soam.TaskOutputHandle
Populates message with the task result that was passed back to the client from the service.
publish(ResourceAttribute) - Method in interface com.platform.symphony.soam.ServiceContext
Publishes the attribute to the system.
publish(ResourceAttribute, boolean) - Method in interface com.platform.symphony.soam.ServiceContext
Publishes the attribute to the system.

R

readBoolean() - Method in interface com.platform.symphony.soam.InputStream
Reads a boolean value from the input stream.
readByteArray() - Method in interface com.platform.symphony.soam.InputStream
Reads a byte array from the input stream.
readChar() - Method in interface com.platform.symphony.soam.InputStream
Reads a char value from the input stream.
readDouble() - Method in interface com.platform.symphony.soam.InputStream
Reads double value from the input stream.
readFloat() - Method in interface com.platform.symphony.soam.InputStream
Reads a float value from the input stream.
readInt() - Method in interface com.platform.symphony.soam.InputStream
Reads an int value from the input stream.
readLong() - Method in interface com.platform.symphony.soam.InputStream
Reads a long value from the input stream.
readShort() - Method in interface com.platform.symphony.soam.InputStream
Reads a short value from the input stream.
readString() - Method in interface com.platform.symphony.soam.InputStream
Reads a java.lang.String from the input stream.
RECEIVE_ASYNC - Static variable in interface com.platform.symphony.soam.Session
Flag to indicate that the client expects the result of its computation to be returned to the client in an asynchronous manner.
RECEIVE_SYNC - Static variable in interface com.platform.symphony.soam.Session
Flag to indicate that the client expects the result of its computation to be returned in a synchronous manner.
removeId(String) - Method in class com.platform.symphony.soam.TaskIdFilter
Removes the specified task ID from the filter.
reset() - Method in interface com.platform.symphony.soam.EnumItems
Resets the enumeration position to the beginning of the series.
reset() - Method in class com.platform.symphony.soam.TaskIdFilter
Resets the filter criteria.
reset() - Method in class com.platform.symphony.soam.TaskOutputFilter
Resets the filter criteria.
reset() - Method in interface com.platform.symphony.symexec.ExecutionEnumItems
Resets the enumeration position to the beginning of the series.
ResourceAttribute - Class in com.platform.symphony.soam
A resource attribute that the application wishes to publish to the system.
ResourceAttribute(String) - Constructor for class com.platform.symphony.soam.ResourceAttribute
Constructs a ResourceAttribute object with the specified name.
ResourceAttributeDefinition - Class in com.platform.symphony.soam
Allows the developer to be able to add more customization for resource attributes used within preference expressions.
ResourceAttributeDefinition(String, String) - Constructor for class com.platform.symphony.soam.ResourceAttributeDefinition
Constructs a ResourceAttributeDefinition object with the specified name and alias.
ResourceAttributeDefinition(String, String, double) - Constructor for class com.platform.symphony.soam.ResourceAttributeDefinition
Constructs a ResourceAttributeDefinition object with the specified name, alias and default value.
ResourceAttributeScope - Class in com.platform.symphony.soam
Values indicating the scope of the ResourceAttribute being published.
ResourceAttributeScope() - Constructor for class com.platform.symphony.soam.ResourceAttributeScope
 
ResourcePreference - Class in com.platform.symphony.soam
This object gives the developer the ability to be able to programmatically describe any preference for resources while their workload executes in the cluster.
ResourcePreference() - Constructor for class com.platform.symphony.soam.ResourcePreference
Constructs an empty resource preference that can be populated by resource attribute definitions.
ResourcePreference(String) - Constructor for class com.platform.symphony.soam.ResourcePreference
Gives a more complex interface for allowing the developer to construct a string representation of the preference.
run() - Method in class com.platform.symphony.soam.ServiceContainer
Runs the service.
run(String[]) - Method in class com.platform.symphony.soam.ServiceContainer
Deprecated. As of Symphony 3.0.1, replaced by ServiceContainer.run()

S

SEND_OVERLAPPED - Static variable in interface com.platform.symphony.soam.Session
Flag to indicate that the client requires the submission of input to be in an overlapped manner.
SEND_SYNC - Static variable in interface com.platform.symphony.soam.Session
Flag to indicate that the client requires the submission of input to be in a synchonous manner.
sendTaskCmd(String) - Method in class com.platform.symphony.symexec.ExecutionSession
Sends a command.
sendTaskCmd(String, ExecutionCommandContext) - Method in class com.platform.symphony.symexec.ExecutionSession
Sends a command.
sendTaskInput(TaskSubmissionAttributes) - Method in interface com.platform.symphony.soam.Session
Delivers the provided task input attributes to the middleware.
sendTaskInput(Serializable) - Method in interface com.platform.symphony.soam.Session
Delivers the provided task input object to the middleware.
sendTaskInput(Message) - Method in interface com.platform.symphony.soam.Session
Delivers the provided task input message to the middleware.
sendTaskInput(Serializable, boolean) - Method in interface com.platform.symphony.soam.Session
Delivers the provided task input object to the middleware.
sendTaskInput(Message, boolean) - Method in interface com.platform.symphony.soam.Session
Delivers the provided task input message to the middleware.
ServiceContainer - Class in com.platform.symphony.soam
The application developer must extend this class to create their own service.
ServiceContainer() - Constructor for class com.platform.symphony.soam.ServiceContainer
Default Constructor
ServiceContext - Interface in com.platform.symphony.soam
Provides functionality that the service will require throughout its lifetime.
ServiceToSlotRatio - Class in com.platform.symphony.soam
A service to slot ratio, which describes how many slots a service instance consumes.
ServiceToSlotRatio(int, int) - Constructor for class com.platform.symphony.soam.ServiceToSlotRatio
Constructs a ServiceToSlotRatio object.
Session - Interface in com.platform.symphony.soam
Acts as a conduit for tasks being submitted to the service instances.
SESSION_KILLED - Static variable in interface com.platform.symphony.soam.InterruptEvent
Deprecated. As of Symphony 4.0, replaced by InterruptEvent.TASK_KILLED
SESSION_SUSPENDED - Static variable in interface com.platform.symphony.soam.InterruptEvent
Deprecated. As of Symphony 4.0, replaced by InterruptEvent.TASK_SUSPENDED
SessionCallback - Class in com.platform.symphony.soam
Should be extended by the application developer to define custom handling for the asynchronous receipt of task responses.
SessionCallback() - Constructor for class com.platform.symphony.soam.SessionCallback
Default Constructor
SessionCloseFlags - Class in com.platform.symphony.soam
Flags to specify what action to take during the closing of the Session.
SessionCloseFlags() - Constructor for class com.platform.symphony.soam.SessionCloseFlags
 
SessionContext - Interface in com.platform.symphony.soam
A container for the information associated with a particular Session.
SessionCreationAttributes - Class in com.platform.symphony.soam
Container for all attributes that may be required upon session creation.
SessionCreationAttributes() - Constructor for class com.platform.symphony.soam.SessionCreationAttributes
Default constructor.
SessionOpenAttributes - Class in com.platform.symphony.soam
Container for all attributes that may be required when opening a session.
SessionOpenAttributes() - Constructor for class com.platform.symphony.soam.SessionOpenAttributes
Default constructor.
SessionUpdateAttributes - Class in com.platform.symphony.soam
Container for all attributes that may be required when updating a session.
SessionUpdateAttributes() - Constructor for class com.platform.symphony.soam.SessionUpdateAttributes
Default constructor.
SessionUpdateTypes - Class in com.platform.symphony.soam
 
SessionUpdateTypes() - Constructor for class com.platform.symphony.soam.SessionUpdateTypes
 
setByteArray(byte[]) - Method in class com.platform.symphony.soam.DefaultByteArrayMessage
This method allows the developer to set the internal byte array within the message.
setCommonData(Message) - Method in class com.platform.symphony.soam.SessionCreationAttributes
Sets the common data.
setCommonData(Serializable) - Method in class com.platform.symphony.soam.SessionCreationAttributes
Sets the common data.
setCommonData(Message) - Method in class com.platform.symphony.soam.SessionUpdateAttributes
Sets the common data.
setCommonData(Serializable) - Method in class com.platform.symphony.soam.SessionUpdateAttributes
Sets the common data.
setControlCode(int) - Method in interface com.platform.symphony.soam.ServiceContext
Sets a service control code for service instance manager.
setDataCompressionFlags(long) - Method in class com.platform.symphony.soam.SessionCreationAttributes
Sets any flag associated with data compression.
setDataCompressionThreshold(int) - Method in class com.platform.symphony.soam.SessionCreationAttributes
Sets the threshold for triggering data compression.
setDefaultResourceAttributeValue(double) - Method in class com.platform.symphony.soam.SessionCreationAttributes
Sets the default value of resource attribute for the session.
setDirectDataTransferFlags(long) - Method in class com.platform.symphony.soam.SessionCreationAttributes
Sets any flag associated with Direct Data Transfer.
setEnvironment(String, String) - Method in class com.platform.symphony.symexec.ExecutionCommandContext
Sets an environment variable (i.e a name/value string pair) within the context of a command.
setEnvironment(String, String) - Method in class com.platform.symphony.symexec.ExecutionSessionContext
Sets an environment variable (i.e a name/value string pair) within the context of a session.
setPostCommand(String) - Method in class com.platform.symphony.symexec.ExecutionCommandContext
Sets the command string to be post-executed.
setPostCommand(String) - Method in class com.platform.symphony.symexec.ExecutionSessionContext
Sets the command string to be post-executed at the session level.
setPreCommand(String) - Method in class com.platform.symphony.symexec.ExecutionCommandContext
Sets the command string to be pre-executed.
setPreCommand(String) - Method in class com.platform.symphony.symexec.ExecutionSessionContext
Sets the command string to be pre-executed at the session level.
setPreemptionRank(int) - Method in class com.platform.symphony.soam.SessionCreationAttributes
Sets the preemption rank of the session.
setPreemptive(boolean) - Method in class com.platform.symphony.soam.SessionCreationAttributes
Specifies whether the session preempts sessions with lower priority when it has workload to run.
setPriorityTask(boolean) - Method in class com.platform.symphony.soam.TaskSubmissionAttributes
Sets the priority flag of the task.
setResourceGroupFilter(String) - Method in class com.platform.symphony.soam.SessionCreationAttributes
Applies a resource group filter to this session.
setResourcePreference(ResourcePreference) - Method in class com.platform.symphony.soam.SessionCreationAttributes
Sets the resource preference object of the session.
setResourcePreference(ResourcePreference) - Method in class com.platform.symphony.soam.TaskSubmissionAttributes
Sets the resource preference object of the task.
setScope(long) - Method in class com.platform.symphony.soam.ResourceAttribute
Sets the scope of the resource attribute.
setServiceName(String) - Method in class com.platform.symphony.soam.SessionCreationAttributes
Sets the service name to be associated with the session.
setServiceToSlotRatio(ServiceToSlotRatio) - Method in class com.platform.symphony.soam.SessionCreationAttributes
Applies a slot usage requirement to this session by specifying a service to slot ratio.
setSessionCallback(SessionCallback) - Method in class com.platform.symphony.soam.SessionCreationAttributes
Sets the session callback.
setSessionCallback(SessionCallback) - Method in class com.platform.symphony.soam.SessionOpenAttributes
Sets the session callback.
setSessionFlags(long) - Method in class com.platform.symphony.soam.SessionCreationAttributes
Sets the session flags.
setSessionFlags(long) - Method in class com.platform.symphony.soam.SessionOpenAttributes
Sets the session flags.
setSessionId(String) - Method in class com.platform.symphony.soam.SessionOpenAttributes
Sets the id of the session to open.
setSessionName(String) - Method in class com.platform.symphony.soam.SessionCreationAttributes
Sets the name of the session.
setSessionPriority(int) - Method in class com.platform.symphony.soam.SessionCreationAttributes
Sets the priority of the session.
setSessionTag(String) - Method in class com.platform.symphony.soam.SessionCreationAttributes
Sets the session tag.
setSessionType(String) - Method in class com.platform.symphony.soam.SessionCreationAttributes
Sets the session type.
setSessionType(String) - Method in class com.platform.symphony.symexec.ExecutionSessionContext
Sets the execution session type The session type argument tells Symphony which type of session to create.
setTaskInput(Message) - Method in class com.platform.symphony.soam.TaskSubmissionAttributes
Sets the input message for the task.
setTaskInput(Serializable) - Method in class com.platform.symphony.soam.TaskSubmissionAttributes
Sets the input object for the task.
setTaskOutput(Message) - Method in interface com.platform.symphony.soam.TaskContext
Sets the task output message that is to be sent back to the client.
setTaskOutput(Serializable) - Method in interface com.platform.symphony.soam.TaskContext
Sets the task output object that is to be sent back to the client.
setTaskTag(String) - Method in class com.platform.symphony.soam.TaskSubmissionAttributes
Sets the task tag.
setText(String) - Method in class com.platform.symphony.soam.DefaultTextMessage
This method allows the developer to set the text within the message.
setValue(double) - Method in class com.platform.symphony.soam.ResourceAttribute
Sets the value associated with the resource attribute.
skip(long) - Method in interface com.platform.symphony.soam.EnumItems
Skips over the next skipCount items in the enumeration.
skip(long) - Method in interface com.platform.symphony.symexec.ExecutionEnumItems
Skips over the next skipCount items in the collection.
SoamException - Exception in com.platform.symphony.soam
 
SoamException() - Constructor for exception com.platform.symphony.soam.SoamException
Constructs an exception with a null detail message and no cause.
SoamException(String) - Constructor for exception com.platform.symphony.soam.SoamException
Constructs an exception with the provided detail message and no cause.
SoamException(String, int) - Constructor for exception com.platform.symphony.soam.SoamException
Constructs an exception with the provided detail message and associated error code.
SoamException(String, Throwable) - Constructor for exception com.platform.symphony.soam.SoamException
Constructs an exception with the provided detail message and cause.
SoamException(Throwable) - Constructor for exception com.platform.symphony.soam.SoamException
Constructs an exception with a null detail message and the provided cause.
SoamFactory - Class in com.platform.symphony.soam
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.
SUBMIT_COMPLETED - Static variable in interface com.platform.symphony.soam.TaskInputHandle
The message has been successfully dispatched to the Middleware.
SUBMIT_FAILED - Static variable in interface com.platform.symphony.soam.TaskInputHandle
The dispatch of the message was un-successful.
SUBMIT_PENDING - Static variable in interface com.platform.symphony.soam.TaskInputHandle
The message has been dispatched and a confirmation of receipt is pending from the Middleware.
SUBMIT_STATE_UNKNOWN - Static variable in interface com.platform.symphony.soam.TaskInputHandle
No information is available about the state at this time.
SYNC - Static variable in interface com.platform.symphony.soam.Session
Flag to indicate that the Session will send its input and receive its output synchronously.

T

TASK_KILLED - Static variable in interface com.platform.symphony.soam.InterruptEvent
Event code indicating that the service will be interrupted because the task is being killed.
TASK_SUSPENDED - Static variable in interface com.platform.symphony.soam.InterruptEvent
Event code indicating that the service will be interrupted because the task is being suspended.
TaskContext - Interface in com.platform.symphony.soam
Provides the context for the task that is bound to the given service invocation.
TaskIdFilter - Class in com.platform.symphony.soam
A task output filter that is defined by a set of task IDs.
TaskIdFilter() - Constructor for class com.platform.symphony.soam.TaskIdFilter
Constructs a TaskIdFilter object.
TaskInputHandle - Interface in com.platform.symphony.soam
Will be returned to the client once a task input has been sent to the middleware, and used by the client to match a task input to the corresponding task response.
TaskOutputFilter - Class in com.platform.symphony.soam
Abstract base class for a task output filter.
TaskOutputFilter() - Constructor for class com.platform.symphony.soam.TaskOutputFilter
 
TaskOutputHandle - Interface in com.platform.symphony.soam
A task response that consists of a task identifier, an output from the service (if any), and an exception (if any).
TaskSubmissionAttributes - Class in com.platform.symphony.soam
Container for all attributes that may be required upon task submission.
TaskSubmissionAttributes() - Constructor for class com.platform.symphony.soam.TaskSubmissionAttributes
Default constructor.
toString() - Method in exception com.platform.symphony.soam.SoamException
Returns a description of this exception.

U

UNDETACHABLE_SYMEXEC_SESSION - Static variable in class com.platform.symphony.symexec.ExecutionSession
Executable session of this type will be aborted when the session's object is destructed or Symphony client process is terminated.
uninitialize() - Static method in class com.platform.symphony.soam.SoamFactory
Uninitializes the SOAM API.
unpublish(ResourceAttribute) - Method in interface com.platform.symphony.soam.ServiceContext
"Un-Publishes" the attribute from the system.
unpublish(ResourceAttribute, boolean) - Method in interface com.platform.symphony.soam.ServiceContext
"Un-Publishes" the attribute from the system.
update(SessionUpdateAttributes) - Method in interface com.platform.symphony.soam.Session
\brief Updates the session with the provided attributes.
updatePriority(int) - Method in interface com.platform.symphony.soam.Session
Updates the session with the provided priority.

W

waitForSubmissionComplete() - Method in interface com.platform.symphony.soam.TaskInputHandle
Waits for message submission to complete.
waitForSubmissionComplete(int) - Method in interface com.platform.symphony.soam.TaskInputHandle
Waits for message submission to complete.
waitForSubmissionComplete(int, boolean) - Method in interface com.platform.symphony.soam.TaskInputHandle
Waits for message submission to complete.
writeBoolean(boolean) - Method in interface com.platform.symphony.soam.OutputStream
Writes a boolean value to the output stream.
writeByteArray(byte[], int, int) - Method in interface com.platform.symphony.soam.OutputStream
Writes length bytes to the output stream from the given byte array, starting from position offset in the array.
writeChar(char) - Method in interface com.platform.symphony.soam.OutputStream
Writes a char value to the output stream.
writeDouble(double) - Method in interface com.platform.symphony.soam.OutputStream
Writes a double value to the output stream.
writeFloat(float) - Method in interface com.platform.symphony.soam.OutputStream
Writes a float value to the output stream.
writeInt(int) - Method in interface com.platform.symphony.soam.OutputStream
Writes an int value to the output stream.
writeLong(long) - Method in interface com.platform.symphony.soam.OutputStream
Writes a long value to the output stream.
writeShort(short) - Method in interface com.platform.symphony.soam.OutputStream
Writes a short value to the output stream.
writeString(String) - Method in interface com.platform.symphony.soam.OutputStream
Writes a java.lang.String to the output stream.

A B C D E F G H I M N O P R S T U W
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.