SAFAgent (Oracle® Fusion Middleware Java API Reference for the Lifecycle Management Environment Specification)

java.lang.Object
- oracle.fmwplatform.envspec.model.blueprint.AppSvcResource
- - oracle.fmwplatform.envspec.model.blueprint.jms.SAFAgent

All Implemented Interfaces:

oracle.fmwplatform.envspec.common.EntityWithId
```
public class SAFAgent
extends AppSvcResource
```
An SAFAgent is a WebLogic JMS Store-and-Forward Agent.

Since:

12.2.2.0

Field Summary

Fields
Modifier and Type Field and Description

static String SAF_AGENT_TOKEN

Fields
Modifier and Type	Field and Description
`static String`	`SAF_AGENT_TOKEN`

Constructor Summary

Constructors
Constructor and Description

SAFAgent()

Constructors
Constructor and Description
`SAFAgent()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Long`	`getAcknowledgeInterval()` Get the acknowledgement interval.
`Long`	`getBytesMaximum()` Get the bytes maximum.
`Long`	`getBytesThresholdHigh()` Get the bytes threshold high.
`Long`	`getBytesThresholdLow()` Get the bytes threshold low.
`Long`	`getConversationIdleTimeMaximum()` Get the maximum conversation idle time.
`Long`	`getDefaultRetryDelayBase()` Get the default retry delay base.
`Long`	`getDefaultRetryDelayMaximum()` Get the default retry delay maximum.
`Double`	`getDefaultRetryDelayMultiplier()` Get the default retry delay multiplier.
`Long`	`getDefaultTimeToLive()` Get the default time-to-live.
`Integer`	`getDeploymentOrder()` Get the deployment order.
`Boolean`	`getForwardingPausedAtStartup()` Get whether or not forwarding is paused at server startup.
`Boolean`	`getIncomingPausedAtStartup()` Get whether or not incoming messages are paused at server startup.
`Boolean`	`getLoggingEnabled()` Get whether or not logging is enabled.
`Integer`	`getMaximumMessageSize()` Get the maximum message size.
`Long`	`getMessageBufferSize()` Get the message buffer size.
`MessageCompressionOptions`	`getMessageCompressionOptions()` Get the message compression options.
`String`	`getMessageCompressionOptionsOverride()` Get the message compression options override.
`SAFJMSMessageLogFile`	`getMessageLogFile()` Get the message log file object.
`Long`	`getMessagesMaximum()` Get the messages maximum.
`Long`	`getMessagesThresholdHigh()` Get the upper threshold for messages.
`Long`	`getMessagesThresholdLow()` Get the lower threshold for messages.
`String`	`getName()` Get the name.
`String`	`getNotes()` Get the notes.
`String`	`getPagingDirectory()` Get the paging directory.
`Boolean`	`getPagingMessageCompressionEnabled()` Get whether or not paging message compression is enabled.
`Boolean`	`getReceivingPausedAtStartup()` Get whether or not receiving messages is paused at server startup.
`ServiceType`	`getServiceType()` Get the service type.
`String`	`getStore()` Get the persistent store.
`Boolean`	`getStoreMessageCompressionEnabled()` Get whether or not store message compression is enabled.
`Long`	`getWindowInterval()` Get the window interval.
`Integer`	`getWindowSize()` Get the window size.
`SAFAgent`	`setAcknowledgeInterval(Long acknowledgeInterval)` Set the acknowledgement interval.
`SAFAgent`	`setBytesMaximum(Long bytesMaximum)` Set the bytes maximum.
`SAFAgent`	`setBytesThresholdHigh(Long bytesThresholdHigh)` Set the bytes threshold high.
`SAFAgent`	`setBytesThresholdLow(Long bytesThresholdLow)` Set the bytes threshold low.
`SAFAgent`	`setConversationIdleTimeMaximum(Long conversationIdleTimeMaximum)` Set the maximum conversation idle time.
`SAFAgent`	`setDefaultRetryDelayBase(Long defaultRetryDelayBase)` Set the default retry delay base.
`SAFAgent`	`setDefaultRetryDelayMaximum(Long defaultRetryDelayMaximum)` Set the default retry delay maximum.
`SAFAgent`	`setDefaultRetryDelayMultiplier(Double defaultRetryDelayMultiplier)` Set the default retry delay multiplier.
`SAFAgent`	`setDefaultTimeToLive(Long defaultTimeToLive)` Set the default time-to-live.
`SAFAgent`	`setDeploymentOrder(Integer deploymentOrder)` Set the deployment order.
`SAFAgent`	`setForwardingPausedAtStartup(Boolean forwardingPausedAtStartup)` Set whether or not forwarding is paused at server startup.
`SAFAgent`	`setId(String id)` Sets the id used to reference this model object.
`SAFAgent`	`setIncomingPausedAtStartup(Boolean incomingPausedAtStartup)` Set whether or not incoming messages are paused at server startup.
`SAFAgent`	`setLoggingEnabled(Boolean loggingEnabled)` Set whether or not logging is enabled.
`SAFAgent`	`setMaximumMessageSize(Integer maximumMessageSize)` Set the maximum message size.
`SAFAgent`	`setMessageBufferSize(Long messageBufferSize)` Set the message buffer size.
`SAFAgent`	`setMessageCompressionOptions(MessageCompressionOptions messageCompressionOptions)` Set the message compression options.
`SAFAgent`	`setMessageCompressionOptionsOverride(String messageCompressionOptionsOverride)` Set the message compression options override.
`SAFAgent`	`setMessageLogFile(SAFJMSMessageLogFile messageLogFile)` Set the message log file object.
`SAFAgent`	`setMessagesMaximum(Long messagesMaximum)` Set the messages maximum.
`SAFAgent`	`setMessagesThresholdHigh(Long messagesThresholdHigh)` Set the upper threshold for messages.
`SAFAgent`	`setMessagesThresholdLow(Long messagesThresholdLow)` Set the lower threshold for messages.
`SAFAgent`	`setName(String name)` Set the name.
`SAFAgent`	`setNotes(String notes)` Set the notes.
`SAFAgent`	`setPagingDirectory(String pagingDirectory)` Set the paging directory.
`SAFAgent`	`setPagingMessageCompressionEnabled(Boolean pagingMessageCompressionEnabled)` Set whether or not paging message compression is enabled.
`SAFAgent`	`setReceivingPausedAtStartup(Boolean receivingPausedAtStartup)` Set whether or not receiving messages is paused at server startup.
`SAFAgent`	`setServiceType(ServiceType serviceType)` Set the service type.
`SAFAgent`	`setStore(String store)` Set the persistent store.
`SAFAgent`	`setStoreMessageCompressionEnabled(Boolean storeMessageCompressionEnabled)` Set whether or not store message compression is enabled/
`SAFAgent`	`setWindowInterval(Long windowInterval)` Set the window interval.
`SAFAgent`	`setWindowSize(Integer windowSize)` Set the window size.
`String`	`toCompactString()` Returns a compact string representation of the object in XML format.
`String`	`toJsonCompactString()` Returns a compact string representation of the object in JSON format.
`String`	`toJsonString()` Returns a string representation of the object in JSON format.
`String`	`toString()` Returns a string representation of the object in XML format.
`String`	`toXmlCompactString()` Returns a compact string representation of the object in XML format.
`String`	`toXmlString()` Returns a string representation of the object in XML format.

Methods inherited from class oracle.fmwplatform.envspec.model.blueprint.AppSvcResource
getId, getReservedKeywords, getSourcePath, getTargets, isClusterable

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - SAF_AGENT_TOKEN
```
public static final String SAF_AGENT_TOKEN
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SAFAgent
```
public SAFAgent()
```
- Method Detail
  - setId
```
public SAFAgent setId(String id)
```
    Sets the id used to reference this model object.
    
    Specified by:
    
    setId in interface oracle.fmwplatform.envspec.common.EntityWithId
    
    Overrides:
    
    setId in class AppSvcResource
    
    Parameters:
    
    id - the id to be used when referencing this model object
    
    Returns:
    
    this (for method chaining)
  - getAcknowledgeInterval
```
public Long getAcknowledgeInterval()
```
    Get the acknowledgement interval.
    
    Returns:
    
    the acknowledgement interval
  - setAcknowledgeInterval
```
public SAFAgent setAcknowledgeInterval(Long acknowledgeInterval)
```
    Set the acknowledgement interval.
    
    Parameters:
    
    acknowledgeInterval - the new acknowledgement interval
    
    Returns:
    
    the current SAFAgent object
  - getBytesMaximum
```
public Long getBytesMaximum()
```
    Get the bytes maximum.
    
    Returns:
    
    the bytes maximum
  - setBytesMaximum
```
public SAFAgent setBytesMaximum(Long bytesMaximum)
```
    Set the bytes maximum.
    
    Parameters:
    
    bytesMaximum - the new bytes maximum
    
    Returns:
    
    the current SAFAgent object
  - getBytesThresholdHigh
```
public Long getBytesThresholdHigh()
```
    Get the bytes threshold high.
    
    Returns:
    
    the bytes threshold high
  - setBytesThresholdHigh
```
public SAFAgent setBytesThresholdHigh(Long bytesThresholdHigh)
```
    Set the bytes threshold high.
    
    Parameters:
    
    bytesThresholdHigh - the new bytes threshold high
    
    Returns:
    
    the current SAFAgent object
  - getBytesThresholdLow
```
public Long getBytesThresholdLow()
```
    Get the bytes threshold low.
    
    Returns:
    
    the bytes threshold low
  - setBytesThresholdLow
```
public SAFAgent setBytesThresholdLow(Long bytesThresholdLow)
```
    Set the bytes threshold low.
    
    Parameters:
    
    bytesThresholdLow - the new bytes threshold low
    
    Returns:
    
    the current SAFAgent object
  - getConversationIdleTimeMaximum
```
public Long getConversationIdleTimeMaximum()
```
    Get the maximum conversation idle time.
    
    Returns:
    
    the maximum conversation idle time
  - setConversationIdleTimeMaximum
```
public SAFAgent setConversationIdleTimeMaximum(Long conversationIdleTimeMaximum)
```
    Set the maximum conversation idle time.
    
    Parameters:
    
    conversationIdleTimeMaximum - the maximum conversation idle time
    
    Returns:
    
    the current SAFAgent object
  - getDefaultRetryDelayBase
```
public Long getDefaultRetryDelayBase()
```
    Get the default retry delay base.
    
    Returns:
    
    the default retry delay base
  - setDefaultRetryDelayBase
```
public SAFAgent setDefaultRetryDelayBase(Long defaultRetryDelayBase)
```
    Set the default retry delay base.
    
    Parameters:
    
    defaultRetryDelayBase - the new default retry delay base
    
    Returns:
    
    the current SAFAgent object
  - getDefaultRetryDelayMaximum
```
public Long getDefaultRetryDelayMaximum()
```
    Get the default retry delay maximum.
    
    Returns:
    
    the default retry delay maximum
  - setDefaultRetryDelayMaximum
```
public SAFAgent setDefaultRetryDelayMaximum(Long defaultRetryDelayMaximum)
```
    Set the default retry delay maximum.
    
    Parameters:
    
    defaultRetryDelayMaximum - the new default retry delay maximum
    
    Returns:
    
    the current SAFAgent object
  - getDefaultRetryDelayMultiplier
```
public Double getDefaultRetryDelayMultiplier()
```
    Get the default retry delay multiplier.
    
    Returns:
    
    Get the default retry delay multiplier
  - setDefaultRetryDelayMultiplier
```
public SAFAgent setDefaultRetryDelayMultiplier(Double defaultRetryDelayMultiplier)
```
    Set the default retry delay multiplier.
    
    Parameters:
    
    defaultRetryDelayMultiplier - the new default retry delay multiplier
    
    Returns:
    
    the current SAFAgent object
  - getDefaultTimeToLive
```
public Long getDefaultTimeToLive()
```
    Get the default time-to-live.
    
    Returns:
    
    the default time-to-live
  - setDefaultTimeToLive
```
public SAFAgent setDefaultTimeToLive(Long defaultTimeToLive)
```
    Set the default time-to-live.
    
    Parameters:
    
    defaultTimeToLive - the new default time-to-live
    
    Returns:
    
    the current SAFAgent object
  - getDeploymentOrder
```
public Integer getDeploymentOrder()
```
    Get the deployment order.
    
    Returns:
    
    the deployment order
  - setDeploymentOrder
```
public SAFAgent setDeploymentOrder(Integer deploymentOrder)
```
    Set the deployment order.
    
    Parameters:
    
    deploymentOrder - the new deployment order
    
    Returns:
    
    the current SAFAgent object
  - getForwardingPausedAtStartup
```
public Boolean getForwardingPausedAtStartup()
```
    Get whether or not forwarding is paused at server startup.
    
    Returns:
    
    whether or not forwarding is paused at server startup
  - setForwardingPausedAtStartup
```
public SAFAgent setForwardingPausedAtStartup(Boolean forwardingPausedAtStartup)
```
    Set whether or not forwarding is paused at server startup.
    
    Parameters:
    
    forwardingPausedAtStartup - the new value
    
    Returns:
    
    the current SAFAgent object
  - getIncomingPausedAtStartup
```
public Boolean getIncomingPausedAtStartup()
```
    Get whether or not incoming messages are paused at server startup.
    
    Returns:
    
    whether or not incoming messages are paused at server startup
  - setIncomingPausedAtStartup
```
public SAFAgent setIncomingPausedAtStartup(Boolean incomingPausedAtStartup)
```
    Set whether or not incoming messages are paused at server startup.
    
    Parameters:
    
    incomingPausedAtStartup - the new value
    
    Returns:
    
    the current SAFAgent object
  - getLoggingEnabled
```
public Boolean getLoggingEnabled()
```
    Get whether or not logging is enabled.
    
    Returns:
    
    whether or not logging is enabled
  - setLoggingEnabled
```
public SAFAgent setLoggingEnabled(Boolean loggingEnabled)
```
    Set whether or not logging is enabled.
    
    Parameters:
    
    loggingEnabled - the new value
    
    Returns:
    
    the current SAFAgent object
  - getMaximumMessageSize
```
public Integer getMaximumMessageSize()
```
    Get the maximum message size.
    
    Returns:
    
    the maximum message size
  - setMaximumMessageSize
```
public SAFAgent setMaximumMessageSize(Integer maximumMessageSize)
```
    Set the maximum message size.
    
    Parameters:
    
    maximumMessageSize - the new maximum message size
    
    Returns:
    
    the current SAFAgent object
  - getMessageBufferSize
```
public Long getMessageBufferSize()
```
    Get the message buffer size.
    
    Returns:
    
    the message buffer size
  - setMessageBufferSize
```
public SAFAgent setMessageBufferSize(Long messageBufferSize)
```
    Set the message buffer size.
    
    Parameters:
    
    messageBufferSize - the new message buffer size
    
    Returns:
    
    the current SAFAgent object
  - getMessageCompressionOptions
```
public MessageCompressionOptions getMessageCompressionOptions()
```
    Get the message compression options.
    
    Returns:
    
    the message compression options
  - setMessageCompressionOptions
```
public SAFAgent setMessageCompressionOptions(MessageCompressionOptions messageCompressionOptions)
```
    Set the message compression options.
    
    Parameters:
    
    messageCompressionOptions - the new message compression options
    
    Returns:
    
    the current SAFAgent object
  - getMessageCompressionOptionsOverride
```
public String getMessageCompressionOptionsOverride()
```
    Get the message compression options override.
    
    Returns:
    
    the message compression options override
  - setMessageCompressionOptionsOverride
```
public SAFAgent setMessageCompressionOptionsOverride(String messageCompressionOptionsOverride)
```
    Set the message compression options override.
    
    Parameters:
    
    messageCompressionOptionsOverride - the new message compression options override
    
    Returns:
    
    the current SAFAgent object
  - getMessagesMaximum
```
public Long getMessagesMaximum()
```
    Get the messages maximum.
    
    Returns:
    
    the messages maximum
  - setMessagesMaximum
```
public SAFAgent setMessagesMaximum(Long messagesMaximum)
```
    Set the messages maximum.
    
    Parameters:
    
    messagesMaximum - the new messages maximum
    
    Returns:
    
    the current SAFAgent object
  - getMessagesThresholdHigh
```
public Long getMessagesThresholdHigh()
```
    Get the upper threshold for messages.
    
    Returns:
    
    the upper threshold for messages
  - setMessagesThresholdHigh
```
public SAFAgent setMessagesThresholdHigh(Long messagesThresholdHigh)
```
    Set the upper threshold for messages.
    
    Parameters:
    
    messagesThresholdHigh - the new upper threshold for messages
    
    Returns:
    
    the current SAFAgent object
  - getMessagesThresholdLow
```
public Long getMessagesThresholdLow()
```
    Get the lower threshold for messages.
    
    Returns:
    
    the lower threshold for messages
  - setMessagesThresholdLow
```
public SAFAgent setMessagesThresholdLow(Long messagesThresholdLow)
```
    Set the lower threshold for messages.
    
    Parameters:
    
    messagesThresholdLow - the new lower threshold for messages
    
    Returns:
    
    the current SAFAgent object
  - getName
```
public String getName()
```
    Get the name.
    
    Overrides:
    
    getName in class AppSvcResource
    
    Returns:
    
    the name
  - setName
```
public SAFAgent setName(String name)
```
    Set the name.
    
    Parameters:
    
    name - the new name
    
    Returns:
    
    the current SAFAgent object
  - getNotes
```
public String getNotes()
```
    Get the notes.
    
    Returns:
    
    the notes
  - setNotes
```
public SAFAgent setNotes(String notes)
```
    Set the notes.
    
    Parameters:
    
    notes - the new notes
    
    Returns:
    
    the current SAFAgent object
  - getPagingDirectory
```
public String getPagingDirectory()
```
    Get the paging directory.
    
    Returns:
    
    the paging directory
  - setPagingDirectory
```
public SAFAgent setPagingDirectory(String pagingDirectory)
```
    Set the paging directory.
    
    Parameters:
    
    pagingDirectory - the new paging directory
    
    Returns:
    
    the current SAFAgent object
  - getPagingMessageCompressionEnabled
```
public Boolean getPagingMessageCompressionEnabled()
```
    Get whether or not paging message compression is enabled.
    
    Returns:
    
    whether or not paging message compression is enabled
  - setPagingMessageCompressionEnabled
```
public SAFAgent setPagingMessageCompressionEnabled(Boolean pagingMessageCompressionEnabled)
```
    Set whether or not paging message compression is enabled.
    
    Parameters:
    
    pagingMessageCompressionEnabled - the new value
    
    Returns:
    
    the current SAFAgent object
  - getReceivingPausedAtStartup
```
public Boolean getReceivingPausedAtStartup()
```
    Get whether or not receiving messages is paused at server startup.
    
    Returns:
    
    whether or not receiving messages is paused at server startup
  - setReceivingPausedAtStartup
```
public SAFAgent setReceivingPausedAtStartup(Boolean receivingPausedAtStartup)
```
    Set whether or not receiving messages is paused at server startup.
    
    Parameters:
    
    receivingPausedAtStartup - the new value
    
    Returns:
    
    the current SAFAgent object
  - getServiceType
```
public ServiceType getServiceType()
```
    Get the service type.
    
    Returns:
    
    the service type
  - setServiceType
```
public SAFAgent setServiceType(ServiceType serviceType)
```
    Set the service type.
    
    Parameters:
    
    serviceType - the new service type
    
    Returns:
    
    the current SAFAgent object
  - getStore
```
public String getStore()
```
    Get the persistent store.
    
    Returns:
    
    the persistent store
  - setStore
```
public SAFAgent setStore(String store)
```
    Set the persistent store.
    
    Parameters:
    
    store - the new persistent store
    
    Returns:
    
    the current SAFAgent object
  - getStoreMessageCompressionEnabled
```
public Boolean getStoreMessageCompressionEnabled()
```
    Get whether or not store message compression is enabled.
    
    Returns:
    
    whether or not store message compression is enabled
  - setStoreMessageCompressionEnabled
```
public SAFAgent setStoreMessageCompressionEnabled(Boolean storeMessageCompressionEnabled)
```
    Set whether or not store message compression is enabled/
    
    Parameters:
    
    storeMessageCompressionEnabled - the new value
    
    Returns:
    
    the current SAFAgent object
  - getWindowInterval
```
public Long getWindowInterval()
```
    Get the window interval.
    
    Returns:
    
    the window interval
  - setWindowInterval
```
public SAFAgent setWindowInterval(Long windowInterval)
```
    Set the window interval.
    
    Parameters:
    
    windowInterval - the new window interval
    
    Returns:
    
    the current SAFAgent object
  - getWindowSize
```
public Integer getWindowSize()
```
    Get the window size.
    
    Returns:
    
    the window size
  - setWindowSize
```
public SAFAgent setWindowSize(Integer windowSize)
```
    Set the window size.
    
    Parameters:
    
    windowSize - the new window size
    
    Returns:
    
    the current SAFAgent object
  - getMessageLogFile
```
public SAFJMSMessageLogFile getMessageLogFile()
```
    Get the message log file object.
    
    Returns:
    
    the message log file object
  - setMessageLogFile
```
public SAFAgent setMessageLogFile(SAFJMSMessageLogFile messageLogFile)
```
    Set the message log file object.
    
    Parameters:
    
    messageLogFile - the new message log file object
    
    Returns:
    
    the current SAFAgent object
  - toXmlCompactString
```
public String toXmlCompactString()
```
    Returns a compact string representation of the object in XML format.
    
    Returns:
    
    a compact string representation of the object in XML format
  - toXmlString
```
public String toXmlString()
```
    Returns a string representation of the object in XML format.
    
    Returns:
    
    a string representation of the object in XML format
  - toJsonCompactString
```
public String toJsonCompactString()
```
    Returns a compact string representation of the object in JSON format.
    
    Returns:
    
    a compact string representation of the object in JSON format
  - toJsonString
```
public String toJsonString()
```
    Returns a string representation of the object in JSON format.
    
    Returns:
    
    a string representation of the object in JSON format
  - toCompactString
```
public String toCompactString()
```
    Returns a compact string representation of the object in XML format.
    
    Returns:
    
    a compact string representation of the object in XML format
  - toString
```
public String toString()
```
    Returns a string representation of the object in XML format.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representation of the object in XML format

Class SAFAgent

Field Summary

Constructor Summary

Method Summary

Methods inherited from class oracle.fmwplatform.envspec.model.blueprint.AppSvcResource

Methods inherited from class java.lang.Object

Field Detail

SAF_AGENT_TOKEN

Constructor Detail

SAFAgent

Method Detail

setId

getAcknowledgeInterval

setAcknowledgeInterval

getBytesMaximum

setBytesMaximum

getBytesThresholdHigh

setBytesThresholdHigh

getBytesThresholdLow

setBytesThresholdLow

getConversationIdleTimeMaximum

setConversationIdleTimeMaximum

getDefaultRetryDelayBase

setDefaultRetryDelayBase

getDefaultRetryDelayMaximum

setDefaultRetryDelayMaximum

getDefaultRetryDelayMultiplier

setDefaultRetryDelayMultiplier

getDefaultTimeToLive

setDefaultTimeToLive

getDeploymentOrder

setDeploymentOrder

getForwardingPausedAtStartup

setForwardingPausedAtStartup

getIncomingPausedAtStartup

setIncomingPausedAtStartup

getLoggingEnabled

setLoggingEnabled

getMaximumMessageSize

setMaximumMessageSize

getMessageBufferSize

setMessageBufferSize

getMessageCompressionOptions

setMessageCompressionOptions

getMessageCompressionOptionsOverride

setMessageCompressionOptionsOverride

getMessagesMaximum

setMessagesMaximum

getMessagesThresholdHigh

setMessagesThresholdHigh

getMessagesThresholdLow

setMessagesThresholdLow

getName

setName

getNotes

setNotes

getPagingDirectory

setPagingDirectory

getPagingMessageCompressionEnabled

setPagingMessageCompressionEnabled

getReceivingPausedAtStartup

setReceivingPausedAtStartup

getServiceType

setServiceType

getStore

setStore

getStoreMessageCompressionEnabled

setStoreMessageCompressionEnabled

getWindowInterval

setWindowInterval

getWindowSize

setWindowSize

getMessageLogFile

setMessageLogFile

toXmlCompactString

toXmlString

toJsonCompactString

toJsonString

toCompactString

toString