Stability of Message Queue Interfaces

B Stability of Message Queue Interfaces

Message Queue uses many interfaces that can help administrators automate tasks. This appendix classifies the interfaces according to their stability. The more stable an interface is, the less likely it is to change in subsequent versions of the product.

Any interface that is not listed in this appendix is private and not for customer use.

Classification Scheme

Table B-1 describes the stability classification scheme.

Table B-1 Interface Stability Classification Scheme

Classification	Description
Private	Not for direct use by customers. May change or be removed in any release.
Evolving	For use by customers. Subject to incompatible change at a major (e.g. 3.0, 4.0) or minor (e.g. 3.1, 3.2) release. The changes will be made carefully and slowly. Reasonable efforts will be made to ensure that all changes are compatible but that is not guaranteed.
Stable	For use by customers. Subject to incompatible change at a major (for example, 3.0 or 4.0) release only.
Standard	For use by customers. These interfaces are defined by a formal standard, and controlled by a standards organization. Incompatible changes to these interfaces are rare.
Unstable	For use by customers. Subject to incompatible change at a major (e.g. 3.0, 4.0) or minor (e.g. 3.1, 3.2) release. Customers are advised that these interfaces may be removed or changed substantially and in an incompatible way in a future release. It is recommended that customers not create explicit dependencies on unstable interfaces.

Classification

Description

Private

Not for direct use by customers. May change or be removed in any release.

Evolving

For use by customers. Subject to incompatible change at a major (e.g. 3.0, 4.0) or minor (e.g. 3.1, 3.2) release. The changes will be made carefully and slowly. Reasonable efforts will be made to ensure that all changes are compatible but that is not guaranteed.

Stable

For use by customers. Subject to incompatible change at a major (for example, 3.0 or 4.0) release only.

Standard

For use by customers. These interfaces are defined by a formal standard, and controlled by a standards organization. Incompatible changes to these interfaces are rare.

Unstable

For use by customers. Subject to incompatible change at a major (e.g. 3.0, 4.0) or minor (e.g. 3.1, 3.2) release. Customers are advised that these interfaces may be removed or changed substantially and in an incompatible way in a future release. It is recommended that customers not create explicit dependencies on unstable interfaces.

Interface Stability

Table B-2 lists the interfaces and their classifications.

Table B-2 Stability of Message Queue Interfaces

Interface Classification

Interface	Classification
Command Line Interfaces	+
`imqbrokerd` command line interface	Evolving
`imqadmin` command line interface	Unstable
`imqcmd` command line interface	Evolving
`imqdbmgr` command line interface	Unstable
`imqkeytool` command line interface	Evolving
`imqobjmgr` command line interface	Evolving
`imqusermgr` command line interface	Unstable
`imqbridgemgr` command line interface	Evolving
Output from `imqbrokerd`, `imqadmin`, `imqcmd`, `imqdbmgr`, `imqkeytool`, `imqobjmgr`, `imqusermgr`	Unstable
Commands	+
`imqobjmgr` command file	Evolving
`imqbrokerd` command	Stable
`imqadmin` command	Unstable
`imqcmd` command	Stable
`imqdbmgr` command	Unstable
`imqkeytool` command	Stable
`imqobjmgr` command	Stable
`imqusermgr` command	Unstable
`imqbridgemgr` command	Evolving
APIs	+
JMS API (`jakarta.jms`)	Standard
JAXM API (`javax.xml`)	Standard
C-API	Evolving
C-API environment variables	Unstable
Message-based monitoring API	Evolving
Administered Object API (`com.sun.messaging`)	Evolving
.jar and .war Files	+
`imq.jar` location and name	Stable
`jms.jar` location and name	Evolving
`imqbroker.jar` location and name	Private
`imqutil.jar` location and name	Private
`imqadmin.jar` location and name	Private
`imqservlet.jar` location and name	Evolving
`imqhttp.war` location and name	Evolving
`imqhttps.war` location and name	Evolving
`imqjmsra.rar` location and name	Evolving
`imqxm.jar` location and name	Evolving
`jaxm-api.jar` location and name	Evolving
`saaj-api.jar` location and name	Evolving
`saaj-impl.jar` location and name	Evolving
`activation.jar` location and name	Evolving
`mail.jar` location and name	Evolving
`dom4j.jar` location and name	Private
`fscontext.jar` location and name	Unstable
Files	+
Broker log file location and content format	Unstable
password file	Unstable
`accesscontrol.properties` file	Unstable
System Destinations	+
`mq.sys.dmq` destination	Stable
`mq.metrics.*` destinations	Evolving
Configuration Properties	+
Message Queue JMS Resource Adapter configuration properties	Evolving
Message Queue JMS Resource Adapter JavaBean and ActivationSpec configuration properties	Evolving
Message Properties and Formats	+
Dead message queue message properties, `JMS_SUN_*`	Evolving
Message Queue client message properties: `JMS_SUN_*`	Evolving
JMS message format for metrics or monitoring messages	Evolving
Miscellaneous	+
Message Queue JMS Resource Adapter package, `com.sun.messaging.jms.ra`	Evolving
JDBC schema for storage of persistent messages	Evolving

Command Line Interfaces

imqbrokerd command line interface

Evolving

imqadmin command line interface

Unstable

imqcmd command line interface

Evolving

imqdbmgr command line interface

Unstable

imqkeytool command line interface

Evolving

imqobjmgr command line interface

Evolving

imqusermgr command line interface

Unstable

imqbridgemgr command line interface

Evolving

Output from imqbrokerd, imqadmin, imqcmd, imqdbmgr, imqkeytool, imqobjmgr, imqusermgr

Unstable

Commands

imqobjmgr command file

Evolving

imqbrokerd command

Stable

imqadmin command

Unstable

imqcmd command

Stable

imqdbmgr command

Unstable

imqkeytool command

Stable

imqobjmgr command

Stable

imqusermgr command

Unstable

imqbridgemgr command

Evolving

APIs

JMS API (jakarta.jms)

Standard

JAXM API (javax.xml)

Standard

C-API

Evolving

C-API environment variables

Unstable

Message-based monitoring API

Evolving

Administered Object API (com.sun.messaging)

Evolving

.jar and .war Files

imq.jar location and name

Stable

jms.jar location and name

Evolving

imqbroker.jar location and name

Private

imqutil.jar location and name

Private

imqadmin.jar location and name

Private

imqservlet.jar location and name

Evolving

imqhttp.war location and name

Evolving

imqhttps.war location and name

Evolving

imqjmsra.rar location and name

Evolving

imqxm.jar location and name

Evolving

jaxm-api.jar location and name

Evolving

saaj-api.jar location and name

Evolving

saaj-impl.jar location and name

Evolving

activation.jar location and name

Evolving

mail.jar location and name

Evolving

dom4j.jar location and name

Private

fscontext.jar location and name

Unstable

Files

Broker log file location and content format

Unstable

password file

Unstable

accesscontrol.properties file

Unstable

System Destinations

mq.sys.dmq destination

Stable

mq.metrics.* destinations

Evolving

Configuration Properties

Message Queue JMS Resource Adapter configuration properties

Evolving

Message Queue JMS Resource Adapter JavaBean and ActivationSpec configuration properties

Evolving

Message Properties and Formats

Dead message queue message properties, JMS_SUN_*

Evolving

Message Queue client message properties: JMS_SUN_*

Evolving

JMS message format for metrics or monitoring messages

Evolving

Miscellaneous

Message Queue JMS Resource Adapter package, com.sun.messaging.jms.ra

Evolving

JDBC schema for storage of persistent messages

Evolving