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

Platform Symphony 5.1 Java API Reference

Uses of Class
com.platform.symphony.soam.SoamException

Packages that use SoamException
com.platform.symphony.soam   
com.platform.symphony.symexec   
 

Uses of SoamException in com.platform.symphony.soam
 

Subclasses of SoamException in com.platform.symphony.soam
 class FailureException
          Thrown to indicate a non-fatal error has occurred in the service.
 class FatalException
          Thrown to indicate a fatal error has occurred in the service.
 

Methods in com.platform.symphony.soam that return SoamException
 SoamException TaskInputHandle.getException()
          Retrieves the attached exception if the message submission was unsuccessful.
 SoamException TaskOutputHandle.getException()
          Retrieves the attached exception if the task was unsuccessful.
 

Methods in com.platform.symphony.soam with parameters of type SoamException
abstract  void SessionCallback.onException(SoamException exception)
          This method is invoked when an exception occurs within the scope of the given Session.
 

Methods in com.platform.symphony.soam that throw SoamException
 void SessionCreationAttributes.addDefinition(ResourceAttributeDefinition attributeDefinition)
          Add resource attribute definition to resource reference object of the session.
 void ResourcePreference.addDefinition(ResourceAttributeDefinition definition)
          Allows a definition to be associated with a preference.
 boolean TaskIdFilter.addId(java.lang.String id)
          Adds the specified task ID to the filter.
 void Session.close()
          Closes this Session (mandatory).
 void Connection.close()
          Closes this Connection (mandatory).
 void Session.close(long closeFlags)
          Closes this Session (mandatory).
static Connection SoamFactory.connect(java.lang.String applicationName)
          Creates a connection to the specified Symphony application.
static Connection SoamFactory.connect(java.lang.String applicationName, ConnectionSecurityCallback securityCallback)
          Creates a connection to the specified Symphony application.
static Connection SoamFactory.connect(java.lang.String clusterURL, java.lang.String applicationName)
          Creates a connection to the specified Symphony application.
static Connection SoamFactory.connect(java.lang.String clusterURL, java.lang.String applicationName, ConnectionSecurityCallback securityCallback)
          Creates a connection to the specified Symphony application.
 Session Connection.createSession()
          Deprecated. As of Symphony 3.1, replaced by Connection.createSession(SessionCreationAttributes)
 Session Connection.createSession(SessionCreationAttributes attributes)
          Creates a Session on this Connection with the provided attributes.
 Session Connection.createSession(java.lang.String sessionName)
          Deprecated. As of Symphony 3.1, replaced by Connection.createSession(SessionCreationAttributes)
 Session Connection.createSession(java.lang.String sessionName, java.lang.String sessionType)
          Deprecated. As of Symphony 3.1, replaced by Connection.createSession(SessionCreationAttributes)
 Session Connection.createSession(java.lang.String sessionName, java.lang.String sessionType, long sessionFlags)
          Deprecated. As of Symphony 3.1, replaced by Connection.createSession(SessionCreationAttributes)
 Session Connection.createSession(java.lang.String sessionName, java.lang.String sessionType, long sessionFlags, SessionCallback callback)
          Deprecated. As of Symphony 3.1, replaced by Connection.createSession(SessionCreationAttributes)
 Session Connection.createSession(java.lang.String sessionName, java.lang.String sessionType, long sessionFlags, SessionCallback callback, Message commonData)
          Deprecated. As of Symphony 3.1, replaced by Connection.createSession(SessionCreationAttributes)
 Session Connection.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 Connection.createSession(SessionCreationAttributes)
 void SessionContext.discardCommonData()
          Frees the middleware's local copy of the common data.
 void TaskContext.discardTaskInput()
          Frees the middleware's local copy of the Task input.
 void SessionCreationAttributes.enableDataCompression(boolean compressionEnable)
          Enables or disables data compression for a session.
 void SessionCreationAttributes.enableDirectDataTransfer(boolean directDataTransferEnable)
          Enables or disables Direct Data Transfer for a session.
abstract  void TaskOutputFilter.enableValidation(boolean shouldEnable)
          Enables or disables filter validation.
 void TaskIdFilter.enableValidation(boolean shouldEnable)
          Enables or disables filter validation.
 EnumItems Session.fetchTaskOutput(long countMax)
          Blocks indefinitely until countMax task responses are ready.
 EnumItems Session.fetchTaskOutput(long countMax, int timeoutInSeconds)
          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).
 EnumItems Session.fetchTaskOutput(TaskOutputFilter filter)
          Retrieves the task outputs that match the specified filter.
 EnumItems Session.fetchTaskOutput(TaskOutputFilter filter, int timeoutInSeconds)
          Retrieves the task outputs that match the specified filter.
 java.lang.String ServiceContext.getApplicationName()
          Gets the name of the application.
 java.lang.Object SessionContext.getCommonData()
          Retrieves the Serializable that was passed in when the Session was created.
 java.lang.String ServiceContext.getConsumerId()
          Gets the consumer ID.
 long EnumItems.getCount()
          Retrieves the number of items in the enumeration.
 java.lang.String ServiceContext.getDeployDirectory()
          Gets the deployment directory.
 java.lang.Exception SoamException.getEmbeddedException()
          Returns the embedded exception object.
 SoamException TaskInputHandle.getException()
          Retrieves the attached exception if the message submission was unsuccessful.
 SoamException TaskOutputHandle.getException()
          Retrieves the attached exception if the task was unsuccessful.
 java.lang.String TaskInputHandle.getId()
          Retrieves the identifier associated with the task, which was created by the middleware when a task input was sent.
 java.lang.String TaskOutputHandle.getId()
          Returns the task identifier for this task.
 java.lang.String Session.getId()
          Returns the identier for this Session.
 java.lang.String Connection.getId()
          Returns the identifier for this Connection.
 InterruptEvent ServiceContext.getLastInterruptEvent()
          Gets the current interrupt event.
 java.lang.String ServiceContext.getLogDirectory()
          Gets the log directory.
 TaskOutputHandle EnumItems.getNext()
          Returns the next item in the enumeration, or null if there are no more items.
 int ServiceToSlotRatio.getNumberOfServices()
          Gets the number of services portion (the numerator) of the ServiceToSlotRatio.
 int ServiceToSlotRatio.getNumberOfSlots()
          Gets the number of slots portion (the denominator) of the ServiceToSlotRatio.
 java.lang.String ServiceContext.getServiceName()
          Gets the service name.
 ServiceToSlotRatio ServiceContext.getServiceToSlotRatio()
          Gets the service to slot ratio for this service instance, which indicates how many slots this service is consuming.
 java.lang.String SessionContext.getSessionId()
          Returns the identifier for the associated Session, as provided by Symphony.
 java.lang.String TaskContext.getSessionId()
          Returns the identifier of the Session that owns this task.
 int TaskInputHandle.getSubmissionState()
          Get the current state of submission.
 java.lang.String TaskContext.getTaskId()
          Returns the identifier for this task.
 java.lang.Object TaskContext.getTaskInput()
          Retrieves the task input object that was sent from the client to the service.
 java.lang.Object TaskOutputHandle.getTaskOutput()
          Retrieves the task output object that was passed back to the client from the service.
static void SoamFactory.initialize()
          Initializes the SOAM API.
abstract  boolean TaskOutputFilter.isSatisfied()
          Tests whether the filter has been satisfied.
 boolean TaskIdFilter.isSatisfied()
          Tests whether the filter has been satisfied.
 boolean TaskOutputHandle.isSuccessful()
          Indicates whether the corresponding task was successfully processed by the service instance.
 boolean SessionContext.isUpdated(int updateType)
          Indicates whether the specified attribute was updated.
 void ServiceContainer.onCreateService(ServiceContext serviceContext)
          The middleware triggers the invocation of this handler just after a Service Instance is started.
abstract  void Message.onDeserialize(InputStream stream)
          Invoked when this Message object needs to be deserialized.
 void DefaultByteArrayMessage.onDeserialize(InputStream stream)
          This method will be called during de-serialization of the message.
 void DefaultTextMessage.onDeserialize(InputStream stream)
          \brief This method will be called during de-serialization of the message.
 void ServiceContainer.onDestroyService()
          The middleware triggers the invocation of this handler just before a Service Instance is destroyed.
abstract  void SessionCallback.onException(SoamException exception)
          This method is invoked when an exception occurs within the scope of the given Session.
abstract  void ServiceContainer.onInvoke(TaskContext taskContext)
          The middleware triggers the invocation of this handler every time a task input is sent to the service to be processed.
abstract  void SessionCallback.onResponse(TaskOutputHandle task)
          This method is invoked when a task response is available.
abstract  void Message.onSerialize(OutputStream stream)
          Invoked when this Message object needs to be serialized.
 void DefaultByteArrayMessage.onSerialize(OutputStream stream)
          This method will be called during serialization of the message.
 void DefaultTextMessage.onSerialize(OutputStream stream)
          \brief This method will be called during serialization of the message.
 void ServiceContainer.onServiceInterrupt(ServiceContext serviceContext)
          The middleware triggers the invocation of this handler every time an interrupt arrives.
 void ServiceContainer.onSessionEnter(SessionContext sessionContext)
          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.
 void ServiceContainer.onSessionLeave()
          The middleware triggers the invocation of this handler to unbind the Service Instance from its owning Session.
 void ServiceContainer.onSessionUpdate(SessionContext sessionContext)
          Update this service instance with an update for the binding session.
 Session Connection.openSession(SessionOpenAttributes attributes)
          Opens an existing session with the provided attributes, and associates it with this connection.
 Session Connection.openSession(java.lang.String sessionId)
          Deprecated. As of Symphony 3.1, replaced by Connection.openSession(SessionOpenAttributes)
 Session Connection.openSession(java.lang.String sessionId, long sessionFlags)
          Deprecated. As of Symphony 3.1, replaced by Connection.openSession(SessionOpenAttributes)
 Session Connection.openSession(java.lang.String sessionId, long sessionFlags, SessionCallback callback)
          Deprecated. As of Symphony 3.1, replaced by Connection.openSession(SessionOpenAttributes)
 void SessionContext.populateCommonData(Message commonData)
          Populates commonData with the data contained in the Message that was passed in when the Session was created.
 void TaskContext.populateTaskInput(Message inMsg)
          Populates inMsg with the task input that was passed from the client to the service.
 void TaskOutputHandle.populateTaskOutput(Message message)
          Populates message with the task result that was passed back to the client from the service.
 void ServiceContext.publish(ResourceAttribute attribute)
          Publishes the attribute to the system.
 void ServiceContext.publish(ResourceAttribute attribute, boolean throwOnFailure)
          Publishes the attribute to the system.
 boolean InputStream.readBoolean()
          Reads a boolean value from the input stream.
 byte[] InputStream.readByteArray()
          Reads a byte array from the input stream.
 char InputStream.readChar()
          Reads a char value from the input stream.
 double InputStream.readDouble()
          Reads double value from the input stream.
 float InputStream.readFloat()
          Reads a float value from the input stream.
 int InputStream.readInt()
          Reads an int value from the input stream.
 long InputStream.readLong()
          Reads a long value from the input stream.
 short InputStream.readShort()
          Reads a short value from the input stream.
 java.lang.String InputStream.readString()
          Reads a java.lang.String from the input stream.
 boolean TaskIdFilter.removeId(java.lang.String id)
          Removes the specified task ID from the filter.
 void EnumItems.reset()
          Resets the enumeration position to the beginning of the series.
abstract  void TaskOutputFilter.reset()
          Resets the filter criteria.
 void TaskIdFilter.reset()
          Resets the filter criteria.
 int ServiceContainer.run()
          Runs the service.
 int ServiceContainer.run(java.lang.String[] args)
          Deprecated. As of Symphony 3.0.1, replaced by ServiceContainer.run()
 TaskInputHandle Session.sendTaskInput(Message taskInput)
          Delivers the provided task input message to the middleware.
 TaskInputHandle Session.sendTaskInput(Message taskInput, boolean hasPriority)
          Delivers the provided task input message to the middleware.
 TaskInputHandle Session.sendTaskInput(java.io.Serializable inputObj)
          Delivers the provided task input object to the middleware.
 TaskInputHandle Session.sendTaskInput(java.io.Serializable inputObj, boolean hasPriority)
          Delivers the provided task input object to the middleware.
 TaskInputHandle Session.sendTaskInput(TaskSubmissionAttributes attributes)
          Delivers the provided task input attributes to the middleware.
 void SessionCreationAttributes.setCommonData(Message commonData)
          Sets the common data.
 void SessionUpdateAttributes.setCommonData(Message commonData)
          Sets the common data.
 void SessionCreationAttributes.setCommonData(java.io.Serializable commonData)
          Sets the common data.
 void SessionUpdateAttributes.setCommonData(java.io.Serializable commonData)
          Sets the common data.
 void ServiceContext.setControlCode(int code)
          Sets a service control code for service instance manager.
 void SessionCreationAttributes.setDataCompressionFlags(long dataCompressionFlag)
          Sets any flag associated with data compression.
 void SessionCreationAttributes.setDataCompressionThreshold(int threshold)
          Sets the threshold for triggering data compression.
 void SessionCreationAttributes.setDefaultResourceAttributeValue(double value)
          Sets the default value of resource attribute for the session.
 void SessionCreationAttributes.setDirectDataTransferFlags(long ddtFlags)
          Sets any flag associated with Direct Data Transfer.
 void SessionCreationAttributes.setPreemptionRank(int sessionPreemptionRank)
          Sets the preemption rank of the session.
 void SessionCreationAttributes.setPreemptive(boolean preemptive)
          Specifies whether the session preempts sessions with lower priority when it has workload to run.
 void TaskSubmissionAttributes.setPriorityTask(boolean isPriorityTask)
          Sets the priority flag of the task.
 void SessionCreationAttributes.setResourceGroupFilter(java.lang.String filter)
          Applies a resource group filter to this session.
 void TaskSubmissionAttributes.setResourcePreference(ResourcePreference resourcePreference)
          Sets the resource preference object of the task.
 void SessionCreationAttributes.setResourcePreference(ResourcePreference resourcePreference)
          Sets the resource preference object of the session.
 void ResourceAttribute.setScope(long scope)
          Sets the scope of the resource attribute.
 void SessionCreationAttributes.setServiceName(java.lang.String serviceName)
          Sets the service name to be associated with the session.
 void SessionCreationAttributes.setServiceToSlotRatio(ServiceToSlotRatio ratio)
          Applies a slot usage requirement to this session by specifying a service to slot ratio.
 void SessionCreationAttributes.setSessionCallback(SessionCallback callback)
          Sets the session callback.
 void SessionOpenAttributes.setSessionCallback(SessionCallback callback)
          Sets the session callback.
 void SessionCreationAttributes.setSessionFlags(long flags)
          Sets the session flags.
 void SessionOpenAttributes.setSessionFlags(long flags)
          Sets the session flags.
 void SessionOpenAttributes.setSessionId(java.lang.String id)
          Sets the id of the session to open.
 void SessionCreationAttributes.setSessionName(java.lang.String name)
          Sets the name of the session.
 void SessionCreationAttributes.setSessionPriority(int priority)
          Sets the priority of the session.
 void SessionCreationAttributes.setSessionTag(java.lang.String tag)
          Sets the session tag.
 void SessionCreationAttributes.setSessionType(java.lang.String type)
          Sets the session type.
 void TaskSubmissionAttributes.setTaskInput(Message taskInput)
          Sets the input message for the task.
 void TaskSubmissionAttributes.setTaskInput(java.io.Serializable taskInput)
          Sets the input object for the task.
 void TaskContext.setTaskOutput(Message outMsg)
          Sets the task output message that is to be sent back to the client.
 void TaskContext.setTaskOutput(java.io.Serializable outputObj)
          Sets the task output object that is to be sent back to the client.
 void TaskSubmissionAttributes.setTaskTag(java.lang.String tag)
          Sets the task tag.
 void ResourceAttribute.setValue(double value)
          Sets the value associated with the resource attribute.
 void EnumItems.skip(long skipCount)
          Skips over the next skipCount items in the enumeration.
 void ServiceContext.unpublish(ResourceAttribute attribute)
          "Un-Publishes" the attribute from the system.
 void ServiceContext.unpublish(ResourceAttribute attribute, boolean throwOnFailure)
          "Un-Publishes" the attribute from the system.
 void Session.update(SessionUpdateAttributes attributes)
          \brief Updates the session with the provided attributes.
 void Session.updatePriority(int priority)
          Updates the session with the provided priority.
 int TaskInputHandle.waitForSubmissionComplete()
          Waits for message submission to complete.
 int TaskInputHandle.waitForSubmissionComplete(int timeoutInSeconds)
          Waits for message submission to complete.
 int TaskInputHandle.waitForSubmissionComplete(int timeoutInSeconds, boolean throwOnSubmissionFailure)
          Waits for message submission to complete.
 void OutputStream.writeBoolean(boolean b)
          Writes a boolean value to the output stream.
 void OutputStream.writeByteArray(byte[] buffer, int offset, int length)
          Writes length bytes to the output stream from the given byte array, starting from position offset in the array.
 void OutputStream.writeChar(char c)
          Writes a char value to the output stream.
 void OutputStream.writeDouble(double d)
          Writes a double value to the output stream.
 void OutputStream.writeFloat(float f)
          Writes a float value to the output stream.
 void OutputStream.writeInt(int i)
          Writes an int value to the output stream.
 void OutputStream.writeLong(long l)
          Writes a long value to the output stream.
 void OutputStream.writeShort(short s)
          Writes a short value to the output stream.
 void OutputStream.writeString(java.lang.String str)
          Writes a java.lang.String to the output stream.
 

Uses of SoamException in com.platform.symphony.symexec
 

Methods in com.platform.symphony.symexec that return SoamException
 SoamException ExecutionStatus.getException()
          Retrieves the attached exception if the Command was unsuccessful.
 

Methods in com.platform.symphony.symexec that throw SoamException
 void ExecutionSession.close()
          Closes the ExecutionSession object.
 void ExecutionSession.detach()
          Detaches the ExecutionSession object from the Connection.
 ExecutionEnumItems ExecutionSession.fetchTaskStatus()
          Waits for the completion of the next available result from the session.
 ExecutionEnumItems ExecutionSession.fetchTaskStatus(long countMax)
          Waits for the completion of the next countMax results from the session.
 ExecutionEnumItems ExecutionSession.fetchTaskStatus(long countMax, int timeoutInSeconds)
          Waits for the completion of the next countMax results from the session for up to timeoutInSeconds seconds.
 long ExecutionEnumItems.getCount()
          Retrieves the number of items in the collection.
 SoamException ExecutionStatus.getException()
          Retrieves the attached exception if the Command was unsuccessful.
 int ExecutionStatus.getExitCode()
          The exit code of the Command.
 java.lang.String ExecutionStatus.getId()
          Returns the identifier for the Command associated with this status.
 java.lang.String ExecutionSession.getId()
          Returns the identifier of the ExecutionSession.
 ExecutionStatus ExecutionEnumItems.getNext()
          Returns the next item in the collection, or null if there are no more items.
 boolean ExecutionStatus.isSuccessful()
          Indicates whether the corresponding Command was successfully processed by the middleware.
 void ExecutionEnumItems.reset()
          Resets the enumeration position to the beginning of the series.
 java.lang.String ExecutionSession.sendTaskCmd(java.lang.String command)
          Sends a command.
 java.lang.String ExecutionSession.sendTaskCmd(java.lang.String command, ExecutionCommandContext context)
          Sends a command.
 void ExecutionSessionContext.setEnvironment(java.lang.String name, java.lang.String value)
          Sets an environment variable (i.e a name/value string pair) within the context of a session.
 void ExecutionCommandContext.setEnvironment(java.lang.String name, java.lang.String value)
          Sets an environment variable (i.e a name/value string pair) within the context of a command.
 void ExecutionEnumItems.skip(long skipCount)
          Skips over the next skipCount items in the collection.
 

Constructors in com.platform.symphony.symexec that throw SoamException
ExecutionSession()
          Default constructor for a new ExecutionSession.
ExecutionSession(Connection connection)
          Constructor to create a new ExecutionSession using a connection that already exists.
ExecutionSession(ExecutionSessionContext context)
          Constructor to create a new ExecutionSession using the default connection and a context.
ExecutionSession(ExecutionSessionContext context, Connection connection)
          Constructor to create a new ExecutionSession using a connection that already exists and a context.
ExecutionSession(java.lang.String sessionId)
          Constructor to attach to an existing ExecutionSession using the default connection.
ExecutionSession(java.lang.String sessionId, Connection connection)
          Constructor to attach to an existing ExecutionSession using a connection that already exists.
 


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.