WTCtBridgeGlobalMBean (Java API Reference for Oracle WebLogic Server)

Class

Use

Tree

Help

Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.2.1)

Part Number E55141-01
P4 Change 1723563 on 2015/10/09

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

weblogic.management.configuration
Interface WTCtBridgeGlobalMBean

All Superinterfaces:: ConfigurationMBean, DescriptorBean, DynamicMBean, MBeanRegistration, NotificationBroadcaster, SettableBean, WebLogicMBean

public interface WTCtBridgeGlobalMBean

extends ConfigurationMBean

This interface provides access to the WTC tBridge Global configuration attributes. The methods defined herein are applicable for tBridge configuration at the WLS domain level.

Since:: 7.0.0.0

Field Summary

Fields inherited from interface weblogic.management.configuration.ConfigurationMBean
`DEFAULT_EMPTY_BYTE_ARRAY`

Method Summary
`abstract String`	`getAllowNonStandardTypes()` Specifies whether non-standard data types are allowed to pass through this Tuxedo queuing bridge.
`abstract String`	`getDefaultReplyDeliveryMode()` The reply delivery mode to associate with a message when placing messages onto the target location.
`abstract String`	`getDeliveryModeOverride()` The delivery mode to use when placing messages onto the target location.
`abstract String`	`getJmsFactory()` The name of the JMS connection factory.
`abstract String`	`getJmsToTuxPriorityMap()` The mapping of priorities from JMS to Tuxedo.
`abstract String`	`getJndiFactory()` The name of the JNDI lookup factory.
`abstract int`	`getRetries()` The number of attempts to redirect a message before this Tuxedo queuing bridge places the message in the specified error location and logs an error.
`abstract int`	`getRetryDelay()` The minimum number of milliseconds this Tuxedo queuing bridge waits before redirecting a message after a failure.
`abstract int`	`getTimeout()` The number of timeout seconds for an entire redirection when this Tuxedo queuing bridge places a message on the target location.
`abstract String`	`getTransactional()` Specifies whether this Tuxedo queuing bridge should use transactions when retrieving messages from a source location and when placing messages on a target location.
`abstract String`	`getTuxErrorQueue()` The name of the Tuxedo queue used to store a message that cannot be redirected to a Tuxedo/Q source queue.
`abstract String`	`getTuxFactory()` The name of the Tuxedo connection factory.
`abstract String`	`getTuxToJmsPriorityMap()` The mapping of priorities to map from Tuxedo to JMS.
`abstract String`	`getUserId()` The user identity for all messages handled by this Tuxedo queuing bridge for ACL checks when security is configured.
`abstract String`	`getWlsErrorDestination()` The name of the location used to store WebLogic Server JMS messages when a message cannot be redirected.
`abstract void`	`setAllowNonStandardTypes(String AllowNonStandardType)` Sets the value of the AllowNonStandardTypes attribute.
`abstract void`	`setDefaultReplyDeliveryMode(String DefaultReplyDeliveryMode)` Sets the value of the DefaultReplyDeliveryMode attribute.
`abstract void`	`setDeliveryModeOverride(String DeliveryModeOverride)` Sets the value of the DeliveryModeOverride attribute.
`abstract void`	`setJmsFactory(String JmsFactory)` Sets the value of the JmsFactory attribute.
`abstract void`	`setJmsToTuxPriorityMap(String jms2tuxpmap)` Sets the value of the JmsToTuxPriorityMap attribute.
`abstract void`	`setJndiFactory(String JndiFactory)` Sets the value of the JndiFactory attribute.
`abstract void`	`setRetries(int Retries)` Sets the value of the Retries attribute.
`abstract void`	`setRetryDelay(int RetryDelay)` Sets the value of the RetryDelay attribute.
`abstract void`	`setTimeout(int Timeout)` Sets the value of the Timeout attribute.
`abstract void`	`setTransactional(String isTransactional)` Sets the value of the Transactional attribute.
`abstract void`	`setTuxErrorQueue(String TuxErrorQueue)` Sets the value of the TuxErrorQueue attribute.
`abstract void`	`setTuxFactory(String TuxFactory)` Sets the value of the TuxFactory attribute.
`abstract void`	`setTuxToJmsPriorityMap(String tux2jmspmap)` Sets the value of the TuxToJmsPriorotyMap attribute.
`abstract void`	`setUserId(String UserId)` Sets the value of the UserId attribute.
`abstract void`	`setWlsErrorDestination(String WlsErrorDestination)` Sets the value of the WlsErrorDestination attribute.

Methods inherited from interface weblogic.management.configuration.ConfigurationMBean
`freezeCurrentValue, getId, getInheritedProperties, getName, getNotes, isDynamicallyCreated, isInherited, isSet, restoreDefaultValue, setComments, setDefaultedMBean, setName, setNotes, setPersistenceEnabled, unSet`

Methods inherited from interface weblogic.management.WebLogicMBean
`getMBeanInfo, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setParent`

Methods inherited from interface javax.management.DynamicMBean
`getAttribute, getAttributes, invoke, setAttribute, setAttributes`

Methods inherited from interface javax.management.MBeanRegistration
`postDeregister, postRegister, preDeregister, preRegister`

Methods inherited from interface javax.management.NotificationBroadcaster
`addNotificationListener, getNotificationInfo, removeNotificationListener`

Methods inherited from interface weblogic.descriptor.DescriptorBean
`addPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListener`

Method Detail

setTransactional

void setTransactional(String isTransactional)
                      throws InvalidAttributeValueException

Sets the value of the Transactional attribute.

Parameters:: isTransactional - whether or not transactions should be used
Throws:: InvalidAttributeValueException
See Also:: WTCtBridgeGlobalMBean.getTransactional()

getTransactional

String getTransactional()

Specifies whether this Tuxedo queuing bridge should use transactions when retrieving messages from a source location and when placing messages on a target location.

A value of YES means that transactions are used for both operations; a value of NO means that transactions are not used for either operation.

Note: Transactional is not supported in this release.

Returns:: The transactional value

setTimeout

void setTimeout(int Timeout)
                throws InvalidAttributeValueException

Sets the value of the Timeout attribute.

Parameters:: Timeout - timeout in seconds if transactions are used
Throws:: InvalidAttributeValueException
See Also:: WTCtBridgeGlobalMBean.getTimeout()

getTimeout

int getTimeout()

The number of timeout seconds for an entire redirection when this Tuxedo queuing bridge places a message on the target location. A value of 0 specifies an infinite wait.

Range of Values: Between 0 and a positive 32-bit integer.

Returns:: The timeout value

setRetries

void setRetries(int Retries)
                throws InvalidAttributeValueException

Sets the value of the Retries attribute.

Parameters:: Retries - number of times to try redirecting a message
Throws:: InvalidAttributeValueException
See Also:: WTCtBridgeGlobalMBean.getRetries()

getRetries

int getRetries()

The number of attempts to redirect a message before this Tuxedo queuing bridge places the message in the specified error location and logs an error.

Range of Values: Between 0 and a positive 32-bit integer.

Returns:: The retries value

setRetryDelay

void setRetryDelay(int RetryDelay)
                   throws InvalidAttributeValueException

Sets the value of the RetryDelay attribute.

Parameters:: RetryDelay - time in milliseconds to wait before retrying to redirect a msg
Throws:: InvalidAttributeValueException
See Also:: WTCtBridgeGlobalMBean.getRetryDelay()

getRetryDelay

int getRetryDelay()

The minimum number of milliseconds this Tuxedo queuing bridge waits before redirecting a message after a failure.

Note: During this waiting period, no other messages are redirected from the thread. Other threads may continue to redirect messages.

Range of Values: Between 0 and a positive 32-bit integer.

Returns:: The retryDelay value

setWlsErrorDestination

void setWlsErrorDestination(String WlsErrorDestination)
                            throws InvalidAttributeValueException

Sets the value of the WlsErrorDestination attribute.

Parameters:: WlsErrorDestination - error destination for JMS msg if redirects fail
Throws:: InvalidAttributeValueException
See Also:: WTCtBridgeGlobalMBean.getWlsErrorDestination()

getWlsErrorDestination

String getWlsErrorDestination()

The name of the location used to store WebLogic Server JMS messages when a message cannot be redirected.

If not specified, all messages not redirected are lost. If the message cannot be placed into WlsErrorDestination for any reason, an error is logged and the message is lost.

Returns:: The wlsErrorDestination value

setTuxErrorQueue

void setTuxErrorQueue(String TuxErrorQueue)
                      throws InvalidAttributeValueException

Sets the value of the TuxErrorQueue attribute.

Parameters:: TuxErrorQueue - error destination for Tux msg if redirects fail
Throws:: InvalidAttributeValueException
See Also:: WTCtBridgeGlobalMBean.getTuxErrorQueue()

getTuxErrorQueue

String getTuxErrorQueue()

The name of the Tuxedo queue used to store a message that cannot be redirected to a Tuxedo/Q source queue.

If not specified, all messages not redirected are lost. If the message cannot be placed into the TuxErrorQueue, an error is logged and the message is lost.

Note: This queue is in the same queue space as the source queue.

Returns:: The tuxErrorQueue value

setDeliveryModeOverride

void setDeliveryModeOverride(String DeliveryModeOverride)
                             throws InvalidAttributeValueException

Sets the value of the DeliveryModeOverride attribute.

Parameters:: DeliveryModeOverride - mode for placing messages onto target
Throws:: InvalidAttributeValueException
See Also:: WTCtBridgeGlobalMBean.getDeliveryModeOverride()

getDeliveryModeOverride

String getDeliveryModeOverride()

The delivery mode to use when placing messages onto the target location.

If this value is not specified, the message is placed on the target location with the same delivery mode specified from the source location.

Note: This value overrides any delivery mode associated with a message.

Returns:: The deliveryModeOverride value

setDefaultReplyDeliveryMode

void setDefaultReplyDeliveryMode(String DefaultReplyDeliveryMode)
                                 throws InvalidAttributeValueException

Sets the value of the DefaultReplyDeliveryMode attribute.

Parameters:: DefaultReplyDeliveryMode - reply mode for placing messages onto target
Throws:: InvalidAttributeValueException
See Also:: WTCtBridgeGlobalMBean.getDefaultReplyDeliveryMode()

getDefaultReplyDeliveryMode

String getDefaultReplyDeliveryMode()

The reply delivery mode to associate with a message when placing messages onto the target location.

Usage Notes:

Use when messages are being redirected to Tuxedo/Q from JMS and the JMS_BEA_TuxGtway_Tuxedo_ReplyDeliveryMode property is not set for a message.
If the defaultReplyDeliveryMode and JMS_BEA_TuxGtway_Tuxedo_ReplyDeliveryMode are not set, the default semantics defined for Tuxedo are enforced by the Tuxedo/Q subsystem.

Returns:: The defaultReplyDeliveryMode value

setUserId

void setUserId(String UserId)
               throws InvalidAttributeValueException

Sets the value of the UserId attribute.

Parameters:: UserId - user identification for all messages
Throws:: InvalidAttributeValueException
See Also:: WTCtBridgeGlobalMBean.getUserId()

getUserId

String getUserId()

The user identity for all messages handled by this Tuxedo queuing bridge for ACL checks when security is configured.

All messages assume this identity until the security/authentication contexts are passed between the subsystems. Until the security contexts are passed, there is no secure method to identify who generated a message received from the source location.

Note: The user argument may be specified as either a user name or a user identification number (uid).

Returns:: The userId value

setAllowNonStandardTypes

void setAllowNonStandardTypes(String AllowNonStandardType)
                              throws InvalidAttributeValueException

Sets the value of the AllowNonStandardTypes attribute.

Parameters:: AllowNonStandardType - reply mode for placing messages onto target
Throws:: InvalidAttributeValueException
See Also:: WTCtBridgeGlobalMBean.getAllowNonStandardTypes()

getAllowNonStandardTypes

String getAllowNonStandardTypes()

Specifies whether non-standard data types are allowed to pass through this Tuxedo queuing bridge.

A value of NO means that non standard types are rejected and placed onto a specified error location; a value of YES means that non-standard types are placed on the target location as BLOBs with a tag indicating the original type.

Note: Standard types are: ASCII text (TextMessage, STRING), or BLOB (BytesMessage, CARRAY).

Returns:: The allowNonStandardTypes value

setJndiFactory

void setJndiFactory(String JndiFactory)
                    throws InvalidAttributeValueException

Sets the value of the JndiFactory attribute.

Parameters:: JndiFactory - the Name lookup factory
Throws:: InvalidAttributeValueException
See Also:: WTCtBridgeGlobalMBean.getJndiFactory()

getJndiFactory

String getJndiFactory()

The name of the JNDI lookup factory.

Example: weblogic.jndi.WLInitialContextFactory

Returns:: The jndiFactory value

setJmsFactory

void setJmsFactory(String JmsFactory)
                   throws InvalidAttributeValueException

Sets the value of the JmsFactory attribute.

Parameters:: JmsFactory - the JMS connection factory
Throws:: InvalidAttributeValueException
See Also:: WTCtBridgeGlobalMBean.getJmsFactory()

getJmsFactory

String getJmsFactory()

The name of the JMS connection factory.

Example: weblogic.jms.ConnectionFactory

Returns:: The jmsFactory value

setTuxFactory

void setTuxFactory(String TuxFactory)
                   throws InvalidAttributeValueException

Sets the value of the TuxFactory attribute.

Parameters:: TuxFactory - the Tuxedo connection factory
Throws:: InvalidAttributeValueException
See Also:: WTCtBridgeGlobalMBean.getTuxFactory()

getTuxFactory

String getTuxFactory()

The name of the Tuxedo connection factory.

Example: tuxedo.services.TuxedoConnection

Returns:: The tuxFactory value

setJmsToTuxPriorityMap

void setJmsToTuxPriorityMap(String jms2tuxpmap)
                            throws InvalidAttributeValueException

Sets the value of the JmsToTuxPriorityMap attribute.

Parameters:: jms2tuxpmap - list of value-to-range pairs
Throws:: InvalidAttributeValueException
See Also:: WTCtBridgeGlobalMBean.getJmsToTuxPriorityMap()

getJmsToTuxPriorityMap

String getJmsToTuxPriorityMap()

The mapping of priorities from JMS to Tuxedo. The default JMS To Tux Priority Map is: 0:1 | 1:12 | 2:23 | 3:34 | 4:45 |5:56 | 6:67 | 7:78 | 8:89 | 9:100

Examples: 0:1 | 1:12 | 2:23 | 3:34 | 4:45 | 5:56 | 6:67 | 7:78 | 8:89 | 9:100 or 0:1-10|1:11-20|2:21-30|3:31-40|4:41-50|5:51-60|6:61-70|7:71-80|8:81-90|9:91-100

Note: The are 10 possible JMS priorities(0=>9) which can be paired to 100 possible Tuxedo priorities(1=>100). A mapping consists of a "|" separated list of value-to-range pairs (jmsvalue:tuxrange) where pairs are separated by ":" and ranges are separated by "-".

Returns:: The jmsToTuxPriorityMap value

setTuxToJmsPriorityMap

void setTuxToJmsPriorityMap(String tux2jmspmap)
                            throws InvalidAttributeValueException

Sets the value of the TuxToJmsPriorotyMap attribute.

Parameters:: tux2jmspmap - list of range-to-value pairs
Throws:: InvalidAttributeValueException
See Also:: WTCtBridgeGlobalMBean.getTuxToJmsPriorityMap()

getTuxToJmsPriorityMap

String getTuxToJmsPriorityMap()

The mapping of priorities to map from Tuxedo to JMS. The default JMS To Tux Priority Map is: 1-10:0 | 11-20:1 | 21-30:2 | 31-40:3| 41-50:4| 51-60:5 | 61-70:6 | 71-80:7 | 81-90:8 | 91-100:9

Examples: 1:0 | 12:1 | 23:2 | 34:3 | 45:4 | 56:5 | 67:6 | 78:7 | 89:8 | 100:9 or 20:0-1 | 40:2-3 | 60:4-5 | 80:6-7 | 100:8-9

Note: The are 100 possible Tuxedo priorities(1=>100) which can be paired to 10 possible JMS priorities(0=>9). A mapping consists of a "|" separated list of value-to-range pairs (tuxvalue:jmsrange) where pairs are separated by ":" and ranges are separated by "-".

Returns:: The tuxToJmsPriorityMap value

Overview

Package