Summary of DBMS_MGWADM Object Types and Methods

Table 31-1 DBMS_MGWADM Object Types

Object Type	Description
MGW_PROPERTY Type	Specifies a named property
MGW_PROPERTY.CONSTRUCT Method	Constructs a new MGW_PROPERTY instance
MGW_PROPERTY.CONSTRUCT Method	Constructs a new MGW_PROPERTY instance initialized using parameters
MGW_PROPERTIES Type	Specifies an array of properties
MGW_MQSERIES_PROPERTIES Type	Specifies basic properties for an MQSeries messaging system link
MGW_MQSERIES_PROPERTIES.CONSTRUCT Method	Constructs a new MGW_MQSERIES_PROPERTIES instance
MGW_MQSERIES_PROPERTIES.ALTER_CONSTRUCT Method	Constructs a new MGW_MQSERIES_PROPERTIES instance for altering the properties of an existing messaging link

MGW_PROPERTY Type

This type specifies a named property. MGW_PROPERTY is used to specify optional properties for messaging links and foreign queues.

Syntax

TYPE SYS.MGW_PROPERTY IS OBJECT(
   name VARCHAR2(100),
   value VARCHAR2(1000));

Attributes

Table 31-2 MGW_PROPERTY Attributes

Attribute	Description
name	Property name
value	Property value

MGW_PROPERTY.CONSTRUCT Method

This method constructs a new MGW_PROPERTY instance. All attributes are assigned a value of NULL.

Syntax

STATIC FUNCTION CONSTRUCT
RETURN SYS.MGW_PROPERTY;

MGW_PROPERTY.CONSTRUCT Method

This method constructs a new MGW_PROPERTY instance initialized using the given parameters.

Syntax

STATIC FUNCTION CONSTRUCT(
   p_name   IN VARCHAR2,
   p_value  IN VARCHAR2)
RETURN SYS.MGW_PROPERTY;

Parameters

Table 31-3 MGW_PROPERTY.CONSTRUCT Parameters

Parameter	Description
p_name	Property name
p_value	Property value

MGW_PROPERTIES Type

This type specifies an array of properties.

Syntax

TYPE SYS.MGW_PROPERTIES AS VARRAY (100) OF SYS.MGW_PROPERTY;

Usage Notes

Unless noted otherwise, Messaging Gateway uses named properties as follows:

• Names with the 'MGWPROP$_' prefix are reserved. They are used for special purposes and are invalid when used as a normal property name.
• A property name can exist only once in a property list; that is, a list can contain only one value for a given name. The name is treated in a case-insensitive manner.
• In general, a property list is order-independent and the property names may appear in any order. An alter property list is an exception.
• To alter an existing property list, a new property list may be used where each new property modifies the original list in one of the following ways: adds a new property, modifies a property, removes a property, or removes all properties.

The alter list is processed in order, from the first element to the last element. Thus the order in which the elements appear in the alter list is meaningful, especially when the alter list is used to remove properties from an existing list.

The property name and value are used to determine how that element affects the original list. The following rules apply:

• Add/Modify Property

  MGW_PROPERTY.NAME = <property name>
  MGW_PROPERTY.VALUE = <property value>
  
  

If a property of the given name already exists, the current value is replaced with the new value; otherwise the new property is added to the end of the list.

• Remove Property

  MGW_PROPERTY.NAME = 'MGWPROP$_REMOVE'
  MGW_PROPERTY.VALUE = <name of property to remove>
  
  

No action is taken if the property name does not exist in the original list.

• Remove All Properties

  MGW_PROPERTY.NAME = 'MGWPROP$_REMOVE_ALL'
  MGW_PROPERTY.VALUE = not used
  
  

The DBMS_MGWADM package defines constants to represent the reserved property names. Refer to the MGWPROP_< > constants.

MGW_MQSERIES_PROPERTIES Type

This type specifies basic properties for an MQSeries messaging system link.

Syntax

TYPE SYS.MGW_MQSERIES_PROPERTIES  IS OBJECT (
   queue_manager       VARCHAR2(64),
   hostname            VARCHAR2(64),
   port                INTEGER,
   channel             VARCHAR2(64),
   interface_type      INTEGER,
   max_connections     INTEGER,
   username            VARCHAR2(64),
   password            VARCHAR2(64),
   inbound_log_queue   VARCHAR2(64),
   outbound_log_queue  VARCHAR2(64));

Attributes

Table 31-4 MGW_MQSERIES_PROPERTIES Attributes

Attribute	Description
queue_manager	The name of the MQSeries queue manager
hostname	The host on which the MQSeries messaging system resides. If hostname is NULL, an MQSeries bindings connection is used. If nonnull, a client connection is used and requires that a port and channel be specified.
port	The port number. This is used only for client connections; that is, when hostname is NULL.
channel	The channel used when establishing a connection to the queue manager. This is used only for client connections; that is, when hostname is NULL.
interface_type	The type of messaging interface to use. Values: DBMS_MGWADM.MQSERIES_BASE_JAVA_INTERFACE for the MQSeries Base Java interface.
max_connections	The maximum number of messaging connections to the MQSeries messaging system
username	The user name used for authentication to the MQSeries messaging system
password	The password used for authentication to the MQSeries messaging system
inbound_log_queue	The message provider (native) name of the MQSeries queue used for propagation recovery purposes when the messaging link is used for inbound propagation; that is, when queues associated with this link serve as a propagation source. The queue must be created using MQSeries administration tools.
outbound_log_queue	The message provider (native) name of the MQSeries queue used for propagation recovery purposes when the messaging link is used for outbound propagation; that is, when queues associated with this link serve as a propagation destination. The queue must be created using MQSeries administration tools.

MGW_MQSERIES_PROPERTIES.CONSTRUCT Method

This method constructs a new MGW_MQSERIES_PROPERTIES instance. All attributes are assigned a value of NULL.

Syntax

STATIC FUNCTION CONSTRUCT
RETURN SYS.MGW_MQSERIES_PROPERTIES ;

MGW_MQSERIES_PROPERTIES.ALTER_CONSTRUCT Method

This method constructs a new MGW_MQSERIES_PROPERTIES instance for altering the properties of an existing messaging link. All attributes having a VARCHAR2 data type are assigned a value of DBMS_MGWADM.NO_CHANGE. Attributes of other data types are assigned a value of NULL.

Syntax

STATIC FUNCTION ALTER_CONSTRUCT
RETURN SYS.MGW_MQSERIES_PROPERTIES ;