NamedEntityBean
, SettableBean
public interface TemplateBean extends NamedEntityBean
Modifier and Type | Method | Description |
---|---|---|
void |
addDestinationKey(java.lang.String destinationKey) |
Adds a destination key to the end of the list of keys used for
sorting destinations.
|
GroupParamsBean |
createGroupParams(java.lang.String subDeploymentName) |
Creates a group parameter and adds it to this template.
|
void |
destroyGroupParams(GroupParamsBean quota) |
Removes a group parameter from this template.
|
DestinationBean |
findErrorDestination(java.lang.String subDeploymentName) |
Finds the name of the error destination to use when a destination comes from
a specific group
|
java.lang.String |
getAttachSender() |
Specifies whether messages landing on destinations that use this template should
attach the credential of the sending user.
|
DeliveryFailureParamsBean |
getDeliveryFailureParams() |
The parameters that control what should happen to messages when
failures occur.
|
DeliveryParamsOverridesBean |
getDeliveryParamsOverrides() |
Delivery parameter settings that override delivery parameters
set by the JMS client.
|
java.lang.String[] |
getDestinationKeys() |
The list of potential destination keys for sorting messages that
arrive on destinations that use this JMS template.
|
GroupParamsBean[] |
getGroupParams() |
The group parameters for this template.
|
int |
getIncompleteWorkExpirationTime() |
Specifies the maximum amount of time, in milliseconds, before undelivered messages in an
incomplete UOW are expired.
|
int |
getMaximumMessageSize() |
The maximum size of a message that will be accepted from
producers on this destination.
|
MessageLoggingParamsBean |
getMessageLoggingParams() |
Message logging parameters control message logging actions when
a message life cycle change is detected.
|
int |
getMessagingPerformancePreference() |
Controls how long destinations that use this template are willing to wait to create full batches
of available messages (if at all) for delivery to consumers.
|
MulticastParamsBean |
getMulticast() |
The parameters for receiving messages using multicast rather
than a connection-oriented protocol such as TCP.
|
QuotaBean |
getQuota() |
A Quota controls the allotment of system resources available
to destinations.
|
java.lang.String |
getSafExportPolicy() |
Specifies whether a user can send messages to destinations that use this template
using Store-and-Forward.
|
ThresholdParamsBean |
getThresholds() |
A threshold is a point that must be exceeded in order to
produce a given effect.
|
TopicSubscriptionParamsBean |
getTopicSubscriptionParams() |
Gets the subscription parameters for this topic.
|
java.lang.String |
getUnitOfWorkHandlingPolicy() |
Specifies whether the Unit-of-Work (UOW) feature is enabled for destinations that use this template.
|
boolean |
isConsumptionPausedAtStartup() |
Specifies whether message consumption is paused on destinations that use this template at server
startup.
|
boolean |
isDefaultUnitOfOrder() |
Specifies whether WebLogic Server creates a system-generated unit-of-order name based on the
domain, JMS server, and destination name.
|
boolean |
isInsertionPausedAtStartup() |
Specifies whether new message insertion is paused on destinations that use this template at
server startup.
|
boolean |
isProductionPausedAtStartup() |
Specifies whether new message production on destinations that use this template is paused on
at server startup.
|
GroupParamsBean |
lookupGroupParams(java.lang.String subDeploymentName) |
Finds the group params bean associated with the given sub-deployment-name
|
void |
removeDestinationKey(java.lang.String destinationKey) |
Removes a destination key from the list of keys used for sorting
destinations.
|
void |
setAttachSender(java.lang.String attachSender) |
Sets the value of the AttachSender attribute.
|
void |
setConsumptionPausedAtStartup(boolean consumptionPausedAtStartup) |
Sets the value of the ConsumptionPausedAtStartup attribute.
|
void |
setDefaultUnitOfOrder(boolean defaultUnitOfOrder) |
Sets the value of the DefaultUnitOfOrder attribute.
|
void |
setDestinationKeys(java.lang.String[] destinationKeyArray) |
Sets the value of the DestinationKeys attribute.
|
void |
setIncompleteWorkExpirationTime(int incompleteWorkExpirationTime) |
Sets the value of the IncompleteWorkExpirationTime.
|
void |
setInsertionPausedAtStartup(boolean insertionPausedAtStartup) |
Sets the value of the InsertionPausedAtStartup attribute.
|
void |
setMaximumMessageSize(int maximumMessageSize) |
Sets the value of the MaximumMessageSize attribute.
|
void |
setMessagingPerformancePreference(int throughputEmphasis) |
Sets the value of the MessagingPerformancePreference attribute.
|
void |
setProductionPausedAtStartup(boolean productionPausedAtStartup) |
Sets the value of the ProductionPausedAtStartup attribute.
|
void |
setQuota(QuotaBean quota) |
Sets the value of the Quota attribute.
|
void |
setSafExportPolicy(java.lang.String safExportPolicy) |
Sets the value of the SafExportPolicy attribute.
|
void |
setUnitOfWorkHandlingPolicy(java.lang.String unitOfWorkHandlingPolicy) |
Sets the value of the UnitOfWorkHandlingPolicy attribute.
|
java.lang.String[] getDestinationKeys()
The list of potential destination keys for sorting messages that arrive on destinations that use this JMS template.
The keys are ordered from most significant to least significant. If more than one key is specified, a key based on the JMSMessageID can only be the last key in the list.
Note: If JMSMessageID is not defined in the key, it is implicitly assumed to be the last key and is set as "Ascending" (FIFO) for the sort order.
void addDestinationKey(java.lang.String destinationKey)
Adds a destination key to the end of the list of keys used for sorting destinations.
destinationKey
- The string to be added as a key. Will be added to the end of the list of keysvoid removeDestinationKey(java.lang.String destinationKey)
Removes a destination key from the list of keys used for sorting destinations.
destinationKey
- The string to be removed as a key used for sortingvoid setDestinationKeys(java.lang.String[] destinationKeyArray) throws java.lang.IllegalArgumentException
Sets the value of the DestinationKeys attribute.
destinationKeyArray
- An array of keys to be used with this templatejava.lang.IllegalArgumentException
getDestinationKeys()
,
getDestinationKeys()
ThresholdParamsBean getThresholds()
A threshold is a point that must be exceeded in order to produce a given effect. These action points may cause logging, flow control, or other actions, as defined by the specific points whose values have been exceeded.
DeliveryParamsOverridesBean getDeliveryParamsOverrides()
Delivery parameter settings that override delivery parameters set by the JMS client.
These overrides, if set, will cause those specific parameters set in the JMS client to be ignored and replaced by the value set here.
DeliveryFailureParamsBean getDeliveryFailureParams()
The parameters that control what should happen to messages when failures occur.
These parameters enable the Administrator to control error destinations, logging, and other actions that might be taken when a message cannot be delivered or when other failures are detected.
MessageLoggingParamsBean getMessageLoggingParams()
Message logging parameters control message logging actions when a message life cycle change is detected.
java.lang.String getAttachSender()
Specifies whether messages landing on destinations that use this template should attach the credential of the sending user.
AttachJMSXUserID="true"
.This property is dynamically configurable. A dynamic change will only affect messages received after the update has been made.
void setAttachSender(java.lang.String attachSender) throws java.lang.IllegalArgumentException
Sets the value of the AttachSender attribute.
attachSender
- The attach sender mode the destination should be in (Supports, Always, or Never)java.lang.IllegalArgumentException
getAttachSender()
,
getAttachSender()
boolean isProductionPausedAtStartup()
Specifies whether new message production on destinations that use this template is paused on at server startup.
void setProductionPausedAtStartup(boolean productionPausedAtStartup) throws java.lang.IllegalArgumentException
Sets the value of the ProductionPausedAtStartup attribute.
productionPausedAtStartup
- true if production should be paused when the destination starts upjava.lang.IllegalArgumentException
isProductionPausedAtStartup()
,
isProductionPausedAtStartup()
boolean isInsertionPausedAtStartup()
Specifies whether new message insertion is paused on destinations that use this template at server startup.
void setInsertionPausedAtStartup(boolean insertionPausedAtStartup) throws java.lang.IllegalArgumentException
Sets the value of the InsertionPausedAtStartup attribute.
insertionPausedAtStartup
- true if insertion into the destination should be paused when the destination startsjava.lang.IllegalArgumentException
isInsertionPausedAtStartup()
,
isInsertionPausedAtStartup()
boolean isConsumptionPausedAtStartup()
Specifies whether message consumption is paused on destinations that use this template at server startup.
void setConsumptionPausedAtStartup(boolean consumptionPausedAtStartup) throws java.lang.IllegalArgumentException
Sets the value of the ConsumptionPausedAtStartup attribute.
consumptionPausedAtStartup
- true if consumption from this destination should be paused when the destination startsjava.lang.IllegalArgumentException
isConsumptionPausedAtStartup()
,
isConsumptionPausedAtStartup()
int getMaximumMessageSize()
The maximum size of a message that will be accepted from
producers on this destination. The message size includes the
message body, any user-defined properties, and the user-defined JMS
header fields: JMSCorrelationID
and JMSType
.
Producers sending messages that exceed the configured maximum
message size for the destination receive a
ResourceAllocationException
.
The maximum message size is only enforced for the initial production of a message. Messages that are redirected to an error destination or forwarded to a member of a distributed destination are not checked for size. For instance, if a destination and its corresponding error destination are configured with a maximum message size of 128K bytes and 64K bytes, respectively, a message of 96K bytes could be redirected to the error destination (even though it exceeds the 64K byte maximum), but a producer could not directly send the 96K byte message to the error destination.
Maximum Message Size is dynamically configurable, but only incoming messages are affected; stored messages are not affected.
void setMaximumMessageSize(int maximumMessageSize) throws java.lang.IllegalArgumentException
Sets the value of the MaximumMessageSize attribute.
maximumMessageSize
- The maximum size allowed by this destinationjava.lang.IllegalArgumentException
getMaximumMessageSize()
,
getMaximumMessageSize()
QuotaBean getQuota()
A Quota controls the allotment of system resources available to destinations. For example the number of bytes a destination is allowed to store can be configured with a QuotaBean.
void setQuota(QuotaBean quota) throws java.lang.IllegalArgumentException
Sets the value of the Quota attribute.
quota
- The quota bean to be associated with this destination.java.lang.IllegalArgumentException
getQuota()
boolean isDefaultUnitOfOrder()
Specifies whether WebLogic Server creates a system-generated unit-of-order name based on the domain, JMS server, and destination name. Any message arriving at this destination that does not already belong to a unit-of-order is assigned this default name.
This field is recommended for advanced use. Generally, it is recommended to set a message unit-of-order using application calls or connection factory configuration. When relying on a destination default unit order to enforce ordering with adistributed destination, the application must be aware that unit-of-order routing doesn't apply. Instead the application must specifically ensure that any particular set of messages that must be processed in order are all sent to the same specific member destination even in the event of process failures or service migration.
void setDefaultUnitOfOrder(boolean defaultUnitOfOrder) throws java.lang.IllegalArgumentException
Sets the value of the DefaultUnitOfOrder attribute.
defaultUnitOfOrder
- java.lang.IllegalArgumentException
isDefaultUnitOfOrder()
,
isDefaultUnitOfOrder()
java.lang.String getSafExportPolicy()
Specifies whether a user can send messages to destinations that use this template using Store-and-Forward.
This property is dynamically configurable. A dynamic change will only affect messages sent after the update has been made.
void setSafExportPolicy(java.lang.String safExportPolicy)
Sets the value of the SafExportPolicy attribute.
getSafExportPolicy()
,
getSafExportPolicy()
MulticastParamsBean getMulticast()
The parameters for receiving messages using multicast rather than a connection-oriented protocol such as TCP.
Topics with certain quality of service tolerance can receive a significant performance boost by using multicast to receive messages rather than using a connection oriented protocol like TCP.
TopicSubscriptionParamsBean getTopicSubscriptionParams()
Gets the subscription parameters for this topic.
TopicSubscriptionParamsBean
specifies topic
subscription parameters.
GroupParamsBean[] getGroupParams()
The group parameters for this template. When using templates, group parameters enable you to customize parameters based on the group to which the destination belongs.
Templates are a convenient way to associate common parameters amongst a large number of destinations. However, some attributes of particular destinations may need to be configured based on where the destination is targeted. For example, the error destination of a destination and the destination itself must be targeted to the same JMS server.
Group parameters allow the template user to customize parameters based on the group the destination is a member of. The value that will be used for a destination will come from the group parameter if the subdeployment attribute has the same name as the subdeployment the destination is a member of.
For example, imagine two queues Q1 and Q2 in subdeployments G1 and G2 respectively. Both Q1 and Q2 specify template X1 as their template. X1 has group parameters with sub-deployment attributes G1 and G2, where the error destination value for G1 is E1 and the quota value for G2 is E2. Neither Q1 nor Q2 specify their error-destination variable explicitly, so they will get their error destinations from the template. Since Q1 is a member of G1, and the template value of G1 is E1, Q1 will get the error destination E1. Likewise, Q2's error destination will eventually resolve to error destination E2. If a third destination Q3 is added in with sub-deployment G3 and the template does not have a group parameter for G3 then Q3 will get the default value for its error destination.
GroupParamsBean createGroupParams(java.lang.String subDeploymentName)
Creates a group parameter and adds it to this template.
Templates are a convenient way to associate common parameters amongst a large number of destinations. However, some attributes of particular destinations may need to be configured based on where the destination is targeted. For example, the error destination of a destination and the destination itself must be targeted to the same JMS server.
Group parameters allow the template user to customize parameters based on the group the destination is a member of. The value that will be used for a destination will come from the group parameter if the sub-deployment attribute has the same name as the sub-deployment the destination is a member of.
subDeploymentName
- The name of the sub-deployment for which these parameters applygetGroupParams()
void destroyGroupParams(GroupParamsBean quota)
Removes a group parameter from this template.
Templates are a convenient way to associate common parameters amongst a large number of destinations. However, some attributes of particular destinations may need to be configured based on where the destination is targeted. For example, the quota of a destination and the destination itself must be targeted to the same JMS server.
Group parameters allow the template user to customize parameters based on the group the destination is a member of. The value that will be used for a destination will come from the group parameter if the group parameter has the same name as the name of the group the destination is a member of. If no group parameter matches the group of the destination then that destination will get the default value for the attribute.
quota
- The quota to be removed from this templateGroupParamsBean lookupGroupParams(java.lang.String subDeploymentName)
subDeploymentName
- The name of the sub-deployment key for which to find
the associated GroupParamsBeanDestinationBean findErrorDestination(java.lang.String subDeploymentName)
Finds the name of the error destination to use when a destination comes from a specific group
subDeploymentName
- The subDeployment for which to find the quotaint getMessagingPerformancePreference()
Controls how long destinations that use this template are willing to wait to create full batches of available messages (if at all) for delivery to consumers. At the minimum value, batching is disabled; at the default value, less-than-full batches will not wait and are delivered immediately with currently available messages; tuning higher than the default value controls the maximum wait time for additional messages before less-than-full batches are delivered to consumers.
The maximum message count of a full batch is controlled by the JMS connection factory's MessagesMaximum setting.
void setMessagingPerformancePreference(int throughputEmphasis) throws java.lang.IllegalArgumentException
Sets the value of the MessagingPerformancePreference attribute.
throughputEmphasis
- The level of emphasis on throughput over latencyjava.lang.IllegalArgumentException
getMessagingPerformancePreference()
java.lang.String getUnitOfWorkHandlingPolicy()
Specifies whether the Unit-of-Work (UOW) feature is enabled for destinations that use this template. A UOW is a set of messages that are processed as a single unit.
ObjectMessage
containing the list.void setUnitOfWorkHandlingPolicy(java.lang.String unitOfWorkHandlingPolicy) throws java.lang.IllegalArgumentException
Sets the value of the UnitOfWorkHandlingPolicy attribute.
unitOfWorkHandlingPolicy
- The way unit of work messages are processed for applicable destinationsjava.lang.IllegalArgumentException
getUnitOfWorkHandlingPolicy()
int getIncompleteWorkExpirationTime()
Specifies the maximum amount of time, in milliseconds, before undelivered messages in an incomplete UOW are expired. Such messages will then follow the template's expiration policy defined for undeliverable messages.
Note: A template's error destination for UOW messages cannot be configured to use the Single Message Delivery value.
void setIncompleteWorkExpirationTime(int incompleteWorkExpirationTime) throws java.lang.IllegalArgumentException
Sets the value of the IncompleteWorkExpirationTime.
incompleteWorkExpirationTime
- The number of milliseconds before messages will be expiredjava.lang.IllegalArgumentException
getIncompleteWorkExpirationTime()