Summary of JMS Type Member and Static Subprograms

Table 107-1  JMS Types--Member and Static Subprograms

Subprogram	Description
LOOKUP_PROPERTY_NAME Member Procedure	Checks whether new_property_name exists in the properties
SET_REPLYTO Member Procedure	Sets the replyto parameter, which corresponds to JMSReplyTo
SET_TYPE Member Procedure	Sets the JMS type, which can be any text, and which corresponds to JMSType
SET_USERID Member Procedure	Sets userid, which corresponds to JMSXUserID
SET_APPID Member Procedure	Sets appid, which corresponds to JMSXAppID
SET_GROUPID Member Procedure	Sets groupid, which corresponds to JMSXGroupID
SET_GROUPSEQ Member Procedure	Sets groupseq, which corresponds to JMSXGroupSeq
CLEAR_PROPERTIES Member Procedure	Clears all properties
SET_BOOLEAN_PROPERTY Member Procedure	Checks whether property_name is null or exists
SET_BYTE_PROPERTY Member Procedure	Checks whether property_name is null or exists
SET_SHORT_PROPERTY Member Procedure	Checks whether property_name is null or exists
SET_INT_PROPERTY Member Procedure	Checks whether property_name is null or exists
SET_LONG_PROPERTY Member Procedure	Checks whether property_name is null or exists
SET_FLOAT_PROPERTY Member Procedure	Checks whether property_name is null or exists
SET_DOUBLE_PROPERTY Member Procedure	Checks whether property_name is null or exists
SET_STRING_PROPERTY Member Procedure	Checks whether property_name is null or exists
GET_REPLYTO Member Function	Returns replyto, which corresponds to JMSReplyTo
GET_TYPE Member Function	Returns type, which corresponds to JMSType
GET_USERID Member Function	Returns userid, which corresponds to JMSXUserID
GET_APPID Member Function	Returns appid, which corresponds to JMSXAppID
GET_GROUPID Member Function	Returns groupid, which corresponds to JMSXGroupID
GET_GROUPSEQ Member Function	Returns groupseq, which corresponds to JMSXGroupSeq
GET_BOOLEAN_PROPERTY Member Function	Returns a BOOLEAN value if it can find property_name and if java_type is BOOLEAN
GET_BYTE_PROPERTY Member Function	Returns a byte value if it can find property_name and if java_type is byte
GET_SHORT_PROPERTY Member Function	Returns a short value if it can find property_name and if java_type is short
GET_INT_PROPERTY Member Function	Returns an integer value if it can find property_name and if java_type is INT
GET_LONG_PROPERTY Member Function	Returns a number value if it can find property_name and if java_type is long
GET_FLOAT_PROPERTY Member Function	Returns a FLOAT value if it can find property_name and if java_type is FLOAT
GET_DOUBLE_PROPERTY Member Function	Returns a DOUBLE PRECISION value if it can find property_name and if java_type is DOUBLE
GET_STRING_PROPERTY Member Function	Returns a VARCHAR value if it can find property_name and if java_type is STRING
CONSTRUCT Static Function	Obtains instances of aq$_jms_message,which can hold a specific type of JMS message (JMSText, JMSBytes, JMSMap, JMSStream).
SET_TEXT Member Procedure	Sets the payload to an internal representation. See "Usage Notes".
GET_TEXT Member Procedure	Puts the internal representation of the payload into a VARCHAR2 or CLOB variable payload. See "Usage Notes".
SET_BYTES Member Procedure	Sets the payload to an internal representation. See "Usage Notes".
GET_BYTES Member Procedure	Puts the internal representation of the payload into a RAW or BLOB variable payload. See "Usage Notes".

LOOKUP_PROPERTY_NAME Member Procedure

This procedure checks whether new_property_name exists in the properties.

Syntax

DBMS_AQJMS.LOOKUP_PROPERTY_NAME(
   new_property_name  IN  VARCHAR);

Parameters

Table 107-2 LOOKUP_PROPERTY_NAME Procedure Parameters

Parameter	Description
new_property_name	The property name to look up in the JMS property list

Exceptions

ORA-24191 if the property name exists

ORA-24192 if the property name is null

SET_REPLYTO Member Procedure

This procedure sets the replyto parameter, which corresponds to JMSReplyTo.

Syntax

DBMS_AQJMS.SET_REPLYTO(
   replyto IN SYS.AQ$_AGENT);

Parameters

Table 107-3 SET_REPLYTO Procedure Parameters

Parameter	Description
replyto	The client-supplied JMSReplyTo header field of the JMS message, which provides the destination for the reply to the message.

SET_TYPE Member Procedure

This procedure sets the JMS type, which can be any text, and which corresponds to JMSType.

Syntax

DBMS_AQJMS.SET_TYPE(
   type IN VARCHAR);

Parameters

Table 107-4 SET_TYPE Procedure Parameters

Parameter	Description
type	The JMSType header field of the JMS message, which is a client-supplied message type identifier

SET_USERID Member Procedure

This procedure sets userid, which corresponds to JMSXUserID.

Syntax

DBMS_AQJMS.SET_USERID(
   userid IN VARCHAR);

Parameters

Table 107-5 SET_USERID Procedure Parameters

Parameter	Description
userid	The JMS-defined JMSXUserID message property that is set by OJMS on send and contains the identity of the user sending the message

SET_APPID Member Procedure

This procedure sets appid, which corresponds to JMSXAppID.

Syntax

DBMS_AQJMS.SET_APPID(
   appid IN VARCHAR);

Parameters

Table 107-6 SET_APPID Procedure Parameters

Parameter	Description
appid	The JMS-defined JMSXAppID message property that is set by OJMS on send and contains the identity of the application sending the message

SET_GROUPID Member Procedure

This procedure sets groupid, which corresponds to JMSXGroupID.

Syntax

DBMS_AQJMS.SET_GROUPID(
   groupid IN VARCHAR);

Parameters

Table 107-7 SET_GROUPID Procedure Parameters

Parameter	Description
groupid	The JMS-defined JMSXGroupID message property that is set by the client and contains the identity of the message group of which the current message is a part

SET_GROUPSEQ Member Procedure

This procedure sets groupseq, which corresponds to JMSXGroupSeq.

Syntax

DBMS_AQJMS.SET_GROUPSEQ(
   groupseq IN INT);

Parameters

Table 107-8 SET_GROUPSEQ Procedure Parameters

Parameter	Description
groupseq	The JMS-defined JMSXGroupSeq message property that is set by the client and contains the sequence of the message within the group starting with 1.

CLEAR_PROPERTIES Member Procedure

This procedure clears all properties.

Syntax

DBMS_AQJMS.CLEAR_PROPERTIES;

SET_BOOLEAN_PROPERTY Member Procedure

This procedure checks whether property_name is null or exists. If not, the procedure stores property_value in an internal representation (a NUMBER type).

Syntax

DBMS_AQJMS.SET_BOOLEAN_PROPERTY(
   property_name  IN VARCHAR,
   property_value IN BOOLEAN);

Parameters

Table 107-9 SET_BOOLEAN_PROPERTY Procedure Parameters

Parameter	Description
property_name	The name of the user-specified JMS user property or the JMS-specified JMS system property
property_value	The value of the JMS message user property or system property

Exceptions

ORA-24191 if the property name exists

ORA-24192 if the property name is null

SET_BYTE_PROPERTY Member Procedure

This procedure checks whether property_name is null or exists. If not, the procedure checks whether property_value is within -127 to 127 (8-bits). This check is necessary because neither PL/SQL nor RDBMS defines the byte datatype.

Syntax

DBMS_AQJMS.SET_BYTE_PROPERTY(
   property_name  IN VARCHAR,
   property_value IN INT);

Parameters

Table 107-10 SET_BYTE_PROPERTY Procedure Parameters

Parameter	Description
property_name	The name of the user-specified JMS user property or the JMS-specified JMS system property
property_value	The value of the JMS message user property or system property

Exceptions

ORA-24191 if the property name exists

ORA-24192 if the property name is null

ORA-24193 if the property value exceeds the valid range

SET_SHORT_PROPERTY Member Procedure

This procedure checks whether property_name is null or exists. If not, the procedure checks whether property_value is within -32767 to 32767 (16-bits). This check is necessary because neither PL/SQL nor RDBMS defines the short datatype.

Syntax

DBMS_AQJMS.SET_SHORT_PROPERTY(
   property_name  IN VARCHAR,
   property_value IN INT);

Parameters

Table 107-11 SET_SHORT_PROPERTY Procedure Parameters

Parameter	Description
property_name	The name of the user-specified JMS user property or the JMS-specified JMS system property
property_value	The value of the JMS message user property or system property

Exceptions

ORA-24191 if the property name exists

ORA-24192 if the property name is null

ORA-24193 if the property value exceeds the valid range

SET_INT_PROPERTY Member Procedure

This procedure checks whether property_name is null or exists. If not, the procedure checks whether property_value is within -2147483647 to 2147483647 (32-bits). This check is necessary because in PL/SQL and the Oracle database, the INT datatype is 38 bits.

Syntax

DBMS_AQJMS.SET_INT_PROPERTY(
   property_name  IN VARCHAR,
   property_value IN INT);

Parameters

Table 107-12 SET_INT_PROPERTY Procedure Parameters

Parameter	Description
property_name	The name of the user-specified JMS user property or the JMS-specified JMS system property
property_value	The value of the JMS message user property or system property

Exceptions

ORA-24191 if the property name exists

ORA-24192 if the property name is null

ORA-24193 if the property value exceeds the valid range

SET_LONG_PROPERTY Member Procedure

This procedure checks whether property_name is null or exists. If not, the procedure stores property_value. In PL/SQL and Oracle database, the NUMBER datatype is 38 bits. In Java, the long datatype is 64 bits. Therefore, no range check is needed.

Syntax

DBMS_AQJMS.SET_LONG_PROPERTY(
   property_name  IN VARCHAR,
   property_value IN NUMBER);

Parameters

Table 107-13 SET_LONG_PROPERTY Procedure Parameters

Parameter	Description
property_name	The name of the user-specified JMS user property or the JMS-specified JMS system property
property_value	The value of the JMS message user property or system property

Exceptions

ORA-24191 if the property name exists

ORA-24192 if the property name is null

SET_FLOAT_PROPERTY Member Procedure

This procedure checks whether property_name is null or exists. If not, the procedure stores property_value.

Syntax

DBMS_AQJMS.SET_FLOAT_PROPERTY(
   property_name  IN VARCHAR,
   property_value IN FLOAT);

Parameters

Table 107-14 SET_FLOAT_PROPERTY Procedure Parameters

Parameter	Description
property_name	The name of the user-specified JMS user property or the JMS-specified JMS system property
property_value	The value of the JMS message user property or system property

Exceptions

ORA-24191 if the property name exists

ORA-24192 if the property name is null

SET_DOUBLE_PROPERTY Member Procedure

This procedure checks whether property_name is null or exists. If not, the procedure stores property_value.

Syntax

DBMS_AQJMS.SET_DOUBLE_PROPERTY(
   property_name  IN VARCHAR,
   property_value IN DOUBLE PRECISION);

Parameters

Table 107-15 SET_DOUBLE_PROPERTY Procedure Parameters

Parameter	Description
property_name	The name of the user-specified JMS user property or the JMS-specified JMS system property
property_value	The value of the JMS message user property or system property

Exceptions

ORA-24191 if the property name exists

ORA-24192 if the property name is null

SET_STRING_PROPERTY Member Procedure

This procedure checks whether property_name is null or exists. If not, the procedure stores property_value.

Syntax

DBMS_AQJMS.SET_STRING_PROPERTY(
   property_name  IN VARCHAR,
   property_value IN VARDHAR);

Parameters

Table 107-16 SET_STRING_PROPERTY Procedure Parameters

Parameter	Description
property_name	The name of the user-specified JMS user property or the JMS-specified JMS system property
property_value	The value of the JMS message user property or system property

Exceptions

ORA-24191 if the property name exists

ORA-24192 if the property name is null

GET_REPLYTO Member Function

This function returns replyto, which corresponds to JMSReplyTo.

Syntax

DBMS_AQJMS.GET_REPLYTO(
   replyto OUT SYS.AQ$_AGENT);

Returns

Table 107-17 GET_REPLYTO Function Returns

Return	Description
replyto	The client-supplied JMSReplyTo header field of the JMS message, which provides the destination for the reply to the message.

GET_TYPE Member Function

This function returns type, which corresponds to JMSType.

Syntax

DBMS_AQJMS.GET_TYPE(
   type OUT VARCHAR);

Returns

Table 107-18 GET_TYPE Function Returns

Return	Description
type	The JMSType header field of the JMS message, which is a client-supplied message type identifier

GET_USERID Member Function

This function returns userid, which corresponds to JMSXUserID.

Syntax

DBMS_AQJMS.GET_USERID(
   userid OUT VARCHAR);

Returns

Table 107-19 GET_USERID Function Returns

Return	Description
userid	The JMS-defined JMSXUserID message property that is set by OJMS on send and contains the identity of the user sending the message

GET_APPID Member Function

This function returns appid, which corresponds to JMSXAppID.

Syntax

DBMS_AQJMS.GET_APPID(
   appid OUT VARCHAR);

Returns

Table 107-20 GET_APPID Function Returns

Return	Description
appid	The JMS-defined JMSXAppID message property that is set by OJMS on send and contains the identity of the application sending the message

GET_GROUPID Member Function

This function returns groupid, which corresponds to JMSXGroupID.

Syntax

DBMS_AQJMS.GET_GROUPID(
   groupid OUT VARCHAR);

Returns

Table 107-21 GET_GROUPID Function Returns

Return	Description
groupid	The JMS-defined JMSXGroupID message property that is set by the client and contains the identity of the message group of which the current message is a part

GET_GROUPSEQ Member Function

This function returns groupseq, which corresponds to JMSXGroupSeq.

Syntax

DBMS_AQJMS.GET_GROUPSEQ(
   groupseq OUT INT);

Returns

Table 107-22 GET_GROUPSEQ Function Returns

Return	Description
groupseq	The JMS-defined JMSXGroupSeq message property that is set by the client and contains the sequence of the message within the group starting with 1.

GET_BOOLEAN_PROPERTY Member Function

This function returns a BOOLEAN value if it can find property_name and if java_type is BOOLEAN. Otherwise it returns a NULL.

Syntax

DBMS_AQJMS.GET_BOOLEAN_PROPERTY(
   property_name IN  VARCHAR,
  RETURN BOOLEAN);

Parameters

Table 107-23 GET_BOOLEAN_PROPERTY Parameters

Parameter	Description
property_name	The name of the user-specified JMS user property or the JMS-specified JMS system property

GET_BYTE_PROPERTY Member Function

This function returns a byte value if it can find property_name and if java_type is byte. Otherwise it returns a NULL.

Syntax

DBMS_AQJMS.GET_BYTE_PROPERTY(
   property_name IN  VARCHAR,
  RETURN  INT);

Parameters

Table 107-24 GET_BYTE_PROPERTY Parameters

Parameter	Description
property_name	The name of the user-specified JMS user property or the JMS-specified JMS system property

GET_SHORT_PROPERTY Member Function

This function returns a short value if it can find property_name and if java_type is short. Otherwise it returns a NULL.

Syntax

DBMS_AQJMS.GET_SHORT_PROPERTY(
   property_name IN  VARCHAR,
  RETURN INT);

Parameters

Table 107-25 GET_SHORT_PROPERTY Parameters

Parameter	Description
property_name	The name of the user-specified JMS user property or the JMS-specified JMS system property

GET_INT_PROPERTY Member Function

This function returns an integer value if it can find property_name and if java_type is INT. Otherwise it returns a NULL.

Syntax

DBMS_AQJMS.GET_INT_PROPERTY(
   property_name IN  VARCHAR,
  RETURN INT);

Parameters

Table 107-26 GET_INT_PROPERTY Parameters

Parameter	Description
property_name	The name of the user-specified JMS user property or the JMS-specified JMS system property

GET_LONG_PROPERTY Member Function

This function returns a number value if it can find property_name and if java_type is long. Otherwise it returns a NULL.

Syntax

DBMS_AQJMS.GET_LONG_PROPERTY(
   property_name IN  VARCHAR,
  RETURN NUMBER);

Parameters

Table 107-27 GET_LONG_PROPERTY Parameters

Parameter	Description
property_name	The name of the user-specified JMS user property or the JMS-specified JMS system property

GET_FLOAT_PROPERTY Member Function

This function returns a FLOAT value if it can find property_name and if java_type is FLOAT. Otherwise it returns a NULL.

Syntax

DBMS_AQJMS.GET_FLOAT_PROPERTY(
   property_name IN  VARCHAR,
  RETURN FLOAT);

Parameters

Table 107-28 GET_FLOAT_PROPERTY Parameters

Parameter	Description
property_name	The name of the user-specified JMS user property or the JMS-specified JMS system property

GET_DOUBLE_PROPERTY Member Function

This function returns a DOUBLE PRECISION value if it can find property_name and if java_type is DOUBLE. Otherwise it returns a NULL.

Syntax

DBMS_AQJMS.GET_DOUBLE_PROPERTY(
   property_name IN  VARCHAR,
  RETURN DOUBLE PRECISION);

Parameters

Table 107-29 GET_DOUBLE_PROPERTY Parameters

Parameter	Description
property_name	The name of the user-specified JMS user property or the JMS-specified JMS system property

GET_STRING_PROPERTY Member Function

This function returns a VARCHAR value if it can find property_name and if java_type is STRING. Otherwise it returns a NULL.

Syntax

DBMS_AQJMS.GET_STRING_PROPERTY(
   property_name IN  VARCHAR,
  RETURN VARCHAR);

Parameters

Table 107-30 GET_STRING_PROPERTY Parameters

Parameter	Description
property_name	The name of the user-specified JMS user property or the JMS-specified JMS system property

CONSTRUCT Static Function

This function is used to obtain instances of aq$_jms_message,which can hold a specific type of JMS message (JMSText, JMSBytes, JMSMap, JMSStream). The type of message each of these instances can hold depends on the mtype parameter passed to the contruct method. Once a message has been constructed, it can be used only to store JMS messages of the type it has been constructed to hold. The legal values of the mtype parameter are defined in the "Constants to Support the aq$_jms_message Type". See "aq$_jms_message Type" for more information.

Syntax

DBMS_AQJMS.CONSTRUCT(
   mtype  IN INT)
  RETURN aq$_jms_message;

Syntax

DBMS_AQJMS.CONSTRUCT RETURN aq$_jms_text_message;

SET_TEXT Member Procedure

This procedure sets the payload, a VARCHAR2, to an internal representation. If the payload length is <= 4000, it is set into text_vc. Otherwise, it is set into text_lob.

Syntax

DBMS_AQJMS.SET_TEXT(
   payload IN VARCHAR2;

Syntax

This procedure sets the payload, a CLOB, to an internal representation (sets payload into text_lob).

DBMS_AQJMS.SET_TEXT(
   payload IN CLOB;

Parameters

Table 107-31 SET_TEXT Procedure Parameters

Parameter	Description
payload	The payload of a JMS message

Usage Notes

This procedure is available with aq$_jms_text_message (and aq$_jms_message), but not aq$_jms_bytes_message.

GET_TEXT Member Procedure

This procedure puts the internal representation of the payload into a VARCHAR2 variable payload. It puts text_vc into payload if text_vc is not null, or transfers text_lob into payload if the length of text_lob is =< 32767 (2**16 -1).

Syntax

DBMS_AQJMS.GET_TEXT(
   payload OUT VARCHAR2);

Syntax

This procedure puts the internal payload into a CLOB variable payload. It puts text_lob into payload if text_lob is not null, or transfers text_vc into payload.

DBMS_AQJMS.GET_TEXT(
   payload OUT CLOB;

Parameters

Table 107-32 GET_TEXT Procedure Parameters

Parameter	Description
payload	The payload of a JMS message

Exceptions

ORA-24190 if the length of the internal payload is more than 32767 (the maximum length of VARCHAR2 in PL/SQL).

Usage Notes

This procedure is available with aq$_jms_text_message (and aq$_jms_message), but not aq$_jms_bytes_message.

SET_BYTES Member Procedure

This procedure sets the payload, a RAW value, to an internal representation (into bytes_raw if the length of payload is <= 2000; otherwise into bytes_lob).

Syntax

DBMS_AQJMS.SET_BYTES(
   payload IN RAW);

Syntax

This procedure sets the payload, a BLOB value, to an internal representation (into bytes_lob).

DBMS_AQJMS.SET_BYTES(
   payload IN BLOB);

Parameters

Table 107-33 SET_BYTES Procedure Parameters

Parameter	Description
payload	The payload of a JMS message

Usage Notes

This procedure is available with aq$_jms_bytes_message (and aq$_jms_message), but not aq$_jms_text_message.

GET_BYTES Member Procedure

This procedure puts the internal representation of the payload into a RAW variable payload. It puts bytes_raw into payload if it is not null, or transfers bytes_lob into payload if the length of bytes_lob is =< 32767 (2**16 -1).

Syntax

DBMS_AQJMS.GET_BYTES(
   payload OUT RAW);

Syntax

This procedure puts the internal representation of the payload into a BLOB variable payload.

DBMS_AQJMS.GET_BYTES(
   payload OUT BLOB);

Exceptions

ORA-24190 if the length of the internal payload is more than 32767 (the maximum length of VARCHAR2 in PL/SQL).

Returns

Table 107-34 GET_BYTES Function Returns

Return	Description
payload	The payload of a JMS message

Usage Notes

This procedure is available with aq$_jms_bytes_message (and aq$_jms_message), but not aq$_jms_text_message.