Websphere MQ Everyplace

Websphere MQ Everyplace Java programming reference.

See:
          Description

Packages
com.ibm.broker.mqimqe.wrapper Provides support for MQe applications that used to send com.ibm.broker.mqimqe.wrapper.MQeMbMsgObject messages to the IBM broker MQe node.
com.ibm.mqe Provides the core functionality of Websphere MQ Everyplace
com.ibm.mqe.adapters Provides plug-in communications adapters or data storage adapters which under-pin a queue manager.
com.ibm.mqe.administration Provides classes used to administer and monitor a Websphere MQ Everyplace queue manager.
com.ibm.mqe.attributes Security classes, cryptors and compressors.
com.ibm.mqe.communications Provides function relating to communications.
com.ibm.mqe.jms Provides an implementation of the Java Message Service (JMS), version 1.1
com.ibm.mqe.mqbridge Provides bridge functionality to allow connectivity between Websphere MQ Everyplace and Websphere MQ queue managers.
com.ibm.mqe.mqemqmessage Message class to convey data which exists in a Websphere MQ message.
com.ibm.mqe.registry Classes used to store and retrieve certificates and configuration information.
com.ibm.mqe.trace Various trace handlers to capture trace information, and tools to convert binary to readable formats.
com.ibm.mqe.transaction Classes required by JMS for transactional operations against the queue manager.
com.ibm.mqe.validation Validates the contents of a registry, and provides a tool to migrate registry information from previous releases of Websphere MQ Everyplace.
examples.adapters Simple examples to demonstrate the creation and usage of DiskField Adapter, Communications Adapter and the WESAuthentication Adapters with WMQe.
examples.administration.commandline Simple commandline examples demonstrating the general administration of WMQe resources.
examples.administration.console Examples providing a simple window interface for administering the WMQe resources.
examples.administration.simple Simple examples to demonstrate the creation, deletion and inquire operations on a queue.
examples.application Simple applications.
examples.assured Simple example to demonstrate assured message delivery.
examples.attributes Simple examples to demonstrate the Authentication support for Logon / NT / Unix domains.
examples.awt Provides a simple window interface to an MQe server and MQe Trace operations.
examples.certificates Demonstrates how to get WTLS certificate information from the registry and how to renew it.
examples.config Java examples used in the configuration guide manual.
examples.eventlog Defines the basic logging interface.
examples.helloworld Simple example.
examples.install Simple GUI examples demonstrating creation of Queue Manger, deleting Queue Manager and collecting various configuration details.
examples.ivt Contains one or more classes for performing an installation verification test.
examples.jms Example WMQe JMS applications.
examples.midp.exampleapp.messageservice This provides a simple interface to WMQe, wrapping a queuemanager and performing functions such as queue creation and message sending.
examples.midp.exampleapp.msgpump Controller and User interface for a MIDP pump client.
examples.midp.exampleapp.textapp This is the MIDP client controller for the text app.
examples.migration Illustrates the implementation of a simple migration tool.
examples.mqbridge.administration.commandline A command line tool to create an WMQ client connection object on the WebSphere MQ Everyplace bridge on a specified WMQe queue manager and perform various operations on it.
examples.mqbridge.application Simple examples to demonstrate how to put a message to an WMQ queue and how to destructively read a message from an WMQ queue.
examples.mqbridge.awt Provides a bridge-enabled server capability in a graphical user interface.
examples.mqbridge.queuemanager A migration aid for programs which have been coded against previous versions of MQe.
examples.mqbridge.rules Simple examples to demonstratethe rules to handle an undelivered message.
examples.mqbridge.transformers Simple WMQ to WMQe transformer.
examples.nativecode Native java NT and Unix method interfaces.
examples.os4690 Shows how to create a queue manager on an IBM 4690 operating system.
examples.osgi.admin Part of the MQeJMSSender and MQeJMSReceiver example bundles.
examples.osgi.client Part of the MQeClient example bundle.
examples.osgi.server Part of the MQeServer example bundle.
examples.queuemanager Provides a simple example MQe server and a set of helper methods for configuring and starting various WMQe components.
examples.rules Example Queue Manger, Queue, Attribute rules.
examples.trace A dummy Trace Handler example.

 

Websphere MQ Everyplace Java programming reference.

Take Note:

Before using this information and the product it supports, be sure to read the general information under Notices section below.

License warning

WebSphere MQ Everyplace for Multiplatforms is a toolkit that enables users to write WebSphere MQ Everyplace applications and to create an environment in which to run them. Before deploying this product, or applications that use it, in a production environment, please make sure that you have the necessary licenses.

To use WebSphere MQ Everyplace on specified server platforms (other than for purposes of code development and test), capacity-unit Use Authorizations (which are recorded on Proof of Entitlement documents and valid to support use of WebSphere MQ Everyplace according to published capacity unit and pricing group tables) must be obtained in order to be licensed to use the program on each machine and machine upgrade.

Device platform use authorizations (which are recorded on Proof of Entitlement documents and valid to support use of WebSphere MQ Everyplace) are required to use the product (other than for purposes of code development and test) on specified client platforms. These licenses do not entitle the user to use the WebSphere MQ Everyplace Bridge, or to run on the server platforms specified in the WebSphere MQ Everyplace pricing group lists published by IBM and also available on the Web via the URL mentioned below:

Please refer to http://www.ibm.com/software/mqseries/ for details of these restrictions.

The information presented in the linked pages applies to WebSphere MQ Everyplace for Multiplatforms and to all subsequent releases and modifications until otherwise indicated in new editions.

This information is continually being updated and improved. For the latest edition, please download the Websphere MQ Everyplace product from http://www.ibm.com/software/mqseries/

About this information

The information in the following linked pages forms a programming reference for the WebSphere MQ Everyplace for Multiplatforms product (generally referred to in this book as WebSphere MQ Everyplace).

It contains details of the parameters and calling sequences of the various methods within the WebSphere MQ Everyplace class libraries.

This book is intended to be used in conjunction with the WebSphere MQ Everyplace for Multiplatforms Programming Guide and existing books or manuals on the programming languages that are used to write WebSphere MQ Everyplace programs.

This document is continually being updated with new and improved information. For the latest edition, please see the Websphere MQ family library Web page at http://www.ibm.com/software/mqseries/library/

Who should read this information

This book is intended for programmers wanting to write WebSphere MQ Everyplace programs for use in a pervasive computing environment.

Prerequisite knowledge

It is assumed that the reader has a working knowledge of the basic programming techniques for the language in which the WebSphere MQ Everyplace programs are to be written.

An initial understanding of the concepts of secure messaging is an advantage. If you do not have this understanding, you may find it useful to read the following Websphere MQ books:

These books are available in softcopy form from Book section of the online Websphere MQ library. This can be reached from the Websphere MQ Web site, URL address, http://www.ibm.com/software/mqseries/library/

Notices

This information was developed for products and services offered in the U.S.A. IBM(R) may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibility to evaluate and verify the operation of any non-IBM product, program, or service.

IBM may have patents or pending patent applications covering subject matter described in this document.

The furnishing of this document does not give you any license to these patents. You can send license inquiries, in writing, to:
IBM Director of Licensing
IBM Corporation
North Castle Drive
Armonk, NY 10504-1785
U.S.A.

The following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law: INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement may not apply to you.

This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice.

Any references in this information to non-IBM Web sites are provided for convenience only and do not in any manner serve as an endorsement of those Web sites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk.

IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you.

Licensees of this program who wish to have information about it for the purpose of enabling:

Such information may be available, subject to appropriate terms and conditions, including in some cases, payment of a fee.

The licensed program described in this information and all licensed material available for it are provided by IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement, or any equivalent agreement between us.

Copyright License

This information contains sample application programs in source language, which illustrates programming techniques on various operating platforms. You may copy, modify, and distribute these sample programs in any form without payment to IBM, for the purposes of developing, using, marketing or distributing application programs conforming to the application programming interface for the operating platform for which the sample programs are written. These examples have not been thoroughly tested under all conditions. IBM, therefore, cannot guarantee or imply reliability, serviceability, or function of these programs. You may copy, modify, and distribute these sample programs in any form without payment to IBM for the purposes of developing, using, marketing, or distributing application programs conforming to IBM's application programming interfaces.

Trademarks

The following terms are trademarks of International Business machines Corporation in the United States, or other countries, or both. IBM WebSphere MQ.

Java and all Java-based trademarks and logos are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States and/or other countries.

Windows NT is a registered trademark of Microsoft Corporation in the United States and in the United States and/or other countries other countries.

Other company, product, and service names may be trademarks or service marks of others.

Copyright

© Copyright International Business Machines Corporation 2000, 2002. All rights reserved.
Note to U.S. government Users -- Documentation related to restricted rights -- Use, duplication or disclosure is subject to restrictions set forth in GSA ADP Schedule Contract with IBM Corp.


Websphere MQ Everyplace