|
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.platform.symphony.soam.SessionCreationAttributes
public final class SessionCreationAttributes
Container for all attributes that may be required upon session creation.
NOTE: If any of the methods of this class are called after the main(...) method exits,
the client or service process may behave in an undefined manner (for example,
hang or terminate abnormally).
Connection.createSession(SessionCreationAttributes)
Constructor Summary | |
---|---|
SessionCreationAttributes()
Default constructor. |
Method Summary | |
---|---|
void |
addDefinition(ResourceAttributeDefinition attributeDefinition)
Add resource attribute definition to resource reference object of the session. |
void |
enableDataCompression(boolean compressionEnable)
Enables or disables data compression for a session. |
void |
enableDirectDataTransfer(boolean directDataTransferEnable)
Enables or disables Direct Data Transfer for a session. |
void |
setCommonData(Message commonData)
Sets the common data. |
void |
setCommonData(java.io.Serializable commonData)
Sets the common data. |
void |
setDataCompressionFlags(long dataCompressionFlag)
Sets any flag associated with data compression. |
void |
setDataCompressionThreshold(int threshold)
Sets the threshold for triggering data compression. |
void |
setDefaultResourceAttributeValue(double value)
Sets the default value of resource attribute for the session. |
void |
setDirectDataTransferFlags(long ddtFlags)
Sets any flag associated with Direct Data Transfer. |
void |
setPreemptionRank(int sessionPreemptionRank)
Sets the preemption rank of the session. |
void |
setPreemptive(boolean preemptive)
Specifies whether the session preempts sessions with lower priority when it has workload to run. |
void |
setResourceGroupFilter(java.lang.String filter)
Applies a resource group filter to this session. |
void |
setResourcePreference(ResourcePreference resourcePreference)
Sets the resource preference object of the session. |
void |
setServiceName(java.lang.String serviceName)
Sets the service name to be associated with the session. |
void |
setServiceToSlotRatio(ServiceToSlotRatio ratio)
Applies a slot usage requirement to this session by specifying a service to slot ratio. |
void |
setSessionCallback(SessionCallback callback)
Sets the session callback. |
void |
setSessionFlags(long flags)
Sets the session flags. |
void |
setSessionName(java.lang.String name)
Sets the name of the session. |
void |
setSessionPriority(int priority)
Sets the priority of the session. |
void |
setSessionTag(java.lang.String tag)
Sets the session tag. |
void |
setSessionType(java.lang.String type)
Sets the session type. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public SessionCreationAttributes()
Method Detail |
---|
public void setSessionName(java.lang.String name) throws SoamException
name
- The session name.
SoamException
public void setSessionType(java.lang.String type) throws SoamException
type
- The session type.
SoamException
public void setSessionFlags(long flags) throws SoamException
com.platform.symphony.soam.Session
object for explanation of flags and their usage.
flags
- The session flags.
SoamException
Session
public void setCommonData(Message commonData) throws SoamException
commonData
- The common data for the session.
SoamException
public void setCommonData(java.io.Serializable commonData) throws SoamException
commonData
- The common data for the session.
SoamException
public void setSessionCallback(SessionCallback callback) throws SoamException
callback
- The session callback.
SoamException
public void setSessionTag(java.lang.String tag) throws SoamException
tag
- The session tag.
SoamException
public void setServiceName(java.lang.String serviceName) throws SoamException
serviceName
- The service name.
SoamException
public void setSessionPriority(int priority) throws SoamException
priority
- The priority of the session.
SoamException
public void setPreemptionRank(int sessionPreemptionRank) throws SoamException
sessionPreemptionRank
- The reclaim rank of the session.
SoamException
public void enableDataCompression(boolean compressionEnable) throws SoamException
compressionEnable
- Enable or disable data compression.
SoamException
public void setDataCompressionThreshold(int threshold) throws SoamException
threshold
- The data compression threshold.
SoamException
public void setDataCompressionFlags(long dataCompressionFlag) throws SoamException
dataCompressionFlag
- The Compression flags.
SoamException
DataCompressionFlags
public void enableDirectDataTransfer(boolean directDataTransferEnable) throws SoamException
directDataTransferEnable
- Flag that specifies whether to enable the Direct Data Transfer feature.
SoamException
public void setDirectDataTransferFlags(long ddtFlags) throws SoamException
ddtFlags
- The Direct Data Transfer flags.
SoamException
DirectDataTransferFlags
public void setPreemptive(boolean preemptive) throws SoamException
preemptive
- Specifies whether the session preempts others.
SoamException
public void setServiceToSlotRatio(ServiceToSlotRatio ratio) throws SoamException
ratio
- The number of service to slot ratio to apply to this session.
SoamException
public void setResourceGroupFilter(java.lang.String filter) throws SoamException
filter
- The resource group filter to apply to this session.
SoamException
public void setDefaultResourceAttributeValue(double value) throws SoamException
value
- The default value of the resource attribute for the session.
SoamException
public void addDefinition(ResourceAttributeDefinition attributeDefinition) throws SoamException
attributeDefinition
- The resource attribute definition for resource preference of the session.
SoamException
public void setResourcePreference(ResourcePreference resourcePreference) throws SoamException
resourcePreference
- The resource reference of the session.
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 |