Websphere MQ Everyplace

com.ibm.mqe.registry
Class MQePublicRegistry

java.lang.Object
  |
  +--com.ibm.mqe.MQe
        |
        +--com.ibm.mqe.registry.MQeRegistry
              |
              +--com.ibm.mqe.registry.MQePublicRegistry
All Implemented Interfaces:
MQeExceptionCodes, MQePropertyProvider

public class MQePublicRegistry
extends MQeRegistry
implements MQePropertyProvider

A public registry.


Field Summary
 
Fields inherited from class com.ibm.mqe.registry.MQeRegistry
Adapter, CAIPAddrPort, CertReqPIN, DirName, FileRegistry, KeyRingPassword, LocalRegType, PIN, PrivateRegistry, Separator
 
Fields inherited from class com.ibm.mqe.MQe
Admin_Queue_Name, Admin_Reply_Queue_Name, copyright, DeadLetter_Queue_Name, Event_Activate, Event_Attribute, Event_Authenticate, Event_Close, Event_Logoff, Event_Logon, Event_MiniCert_Validate, Event_Queue, Event_QueueManager, Event_UserBase, JMS_Version, MQ_Headers, MQe_Log_Audit_Failure, MQe_Log_Audit_Success, MQe_Log_Error, MQe_Log_Information, MQe_Log_Success, MQe_Log_Warning, Msg_BackoutCount, Msg_CorrelID, Msg_ExpireTime, Msg_LockID, Msg_MsgID, Msg_OriginQMgr, Msg_Priority, Msg_ReplyToQ, Msg_ReplyToQMgr, Msg_Resend, Msg_Style, Msg_Style_Datagram, Msg_Style_Reply, Msg_Style_Request, Msg_Time, Msg_WrapMsg, sccsid, System_Default_Queue_Name, version
 
Fields inherited from interface com.ibm.mqe.MQePropertyProvider
version
 
Fields inherited from interface com.ibm.mqe.MQeExceptionCodes
Except_Active, Except_AdapterException, Except_AdapterMissingRemoteAddress, Except_Admin_ActionNotSupported, Except_Admin_InvalidField, Except_Admin_NotAdminMsg, Except_AdminAction, Except_Authenticate, Except_BadRequest, Except_BridgeListener, Except_Chnl_Attributes, Except_Chnl_ID, Except_Chnl_Limit, Except_Chnl_Overrun, Except_Closed, Except_Con_AdapterRequired, Except_Con_AliasAlreadyExists, Except_Con_AlreadyExists, Except_Con_InvalidName, Except_Connect_Failure, Except_ConnectonType, Except_Cryptor, Except_Data, Except_Duplicate, Except_JmxProperties, Except_Listener, Except_MessageStore, Except_MiniCertReg_ActivateFailed, Except_MiniCertReg_BadPIN, Except_MiniCertReg_NotOpen, Except_NotActive, Except_NotAllowed, Except_NotFound, Except_NotSupported, Except_PrivateReg_ActivateFailed, Except_PrivateReg_BadPIN, Except_PrivateReg_NotOpen, Except_PublicReg_ActivateFailed, Except_PublicReg_InvalidAddress, Except_PublicReg_InvalidRequest, Except_Q_Full, Except_Q_InvalidName, Except_Q_InvalidPriority, Except_Q_MsgTooLarge, Except_Q_NoMatchingMsg, Except_Q_TargetRegistryRequired, Except_QMgr_Activated, Except_QMgr_AlreadyExists, Except_QMgr_InvalidQMgrName, Except_QMgr_InvalidQName, Except_QMgr_NotActive, Except_QMgr_NotBridgeEnabled, Except_QMgr_NotConfigured, Except_QMgr_QDoesNotExist, Except_QMgr_QExists, Except_QMgr_QNotEmpty, Except_QMgr_RegistryDataVersion, Except_QMgr_UnknownQMgr, Except_QMgr_WrongQType, Except_Reg_AddFailed, Except_Reg_AlreadyExists, Except_Reg_AlreadyOpen, Except_Reg_CRTKeyDecFailed, Except_Reg_CRTKeySignFailed, Except_Reg_DeleteFailed, Except_Reg_DeleteRegistryFailed, Except_Reg_DoesNotExist, Except_Reg_InvalidSession, Except_Reg_ListFailed, Except_Reg_NotDefined, Except_Reg_NotSecure, Except_Reg_NullName, Except_Reg_OpenFailed, Except_Reg_ReadFailed, Except_Reg_RenameFailed, Except_Reg_ResetPINFailed, Except_Reg_SearchFailed, Except_Reg_UpdateFailed, Except_RemoteException, Except_Rule, Except_S_BadIntegrity, Except_S_BadSubject, Except_S_CertificateExpired, Except_S_Cipher, Except_S_InvalidAttribute, Except_S_InvalidSignature, Except_S_MiniCertNotAvailable, Except_S_MissingSection, Except_S_NoPresetKeyAvailable, Except_S_RegistryNotAvailable, Except_Stopped, Except_Syntax, Except_TimeOut, Except_Transporter, Except_TriggerTransmission, Except_Trnsport_QMgr, Except_Trnsport_Request, Except_Type, Except_UdpipAdapterStateException, Except_UdpipAdapterTimeOut, Except_UdpipAdapterUnableToConfirmSuccess, Except_UnCoded, Except_Uncontactable_DontTransmit
 
Constructor Summary
MQePublicRegistry()
          Constructs an MQePublicRegistry object.
 
Method Summary
 void activate(java.lang.String name, java.lang.String dirName)
          Opens and activates the MQePublicRegistry instance.
 void close()
          Close the registry.
 void deleteCertificate(java.lang.String certificateOwner)
          Deletes the certificate owner's mini-certificate.
 MQeFields getCertificate(java.lang.String certificateOwner)
          Returns the certificate owner's mini-certificate.
 void putCertificate(java.lang.String certificateOwner, MQeFields certificate)
          Adds the certificate owner’s mini-certificate to the public registry.
 MQeFields requestCertificate(java.lang.String entity, java.lang.String mqeNodeAddrPort, java.lang.String adapter)
          Requests a mini-certificate from the public registry of another WebSphere MQ Everyplace node, and, if returned, saves it in this public registry.
 void shareCertificate(java.lang.String entity, MQeFields minicertf, java.lang.String mqeNodeAddrPort, java.lang.String adapter)
          Replicates the certificate owner's mini-certificate to a public registry on another WebSphere MQ Everyplace node.
 
Methods inherited from class com.ibm.mqe.MQe
abbreviate, alias, asciiToByte, byteToAscii, byteToHex, byteToHex, byteToInt, byteToLong, byteToShort, byteToUnicode, fileSeparator, getEventLogHandler, hexToAscii, hexToByte, intToByte, isCLDC, loadClass, loadObject, log, setEventLogHandler, setLoader, sliceByteArray, type, unicodeToByte, uniqueValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.mqe.MQePropertyProvider
getProperty
 

Constructor Detail

MQePublicRegistry

public MQePublicRegistry()

Constructs an MQePublicRegistry object.

See Also:
MQePrivateRegistry
Method Detail

getCertificate

public MQeFields getCertificate(java.lang.String certificateOwner)
                         throws MQeException

Returns the certificate owner's mini-certificate.

Parameters:
certificateOwner - Authenticatable entity's (mini-certificate owner's) name.
Returns:
Mini-certificate
Throws:
MQeException - Except_Reg_ReaddFailed, 'Error reading entry'
See Also:
deleteCertificate(java.lang.String), putCertificate(java.lang.String, com.ibm.mqe.MQeFields)

activate

public void activate(java.lang.String name,
                     java.lang.String dirName)
              throws MQeException

Opens and activates the MQePublicRegistry instance. If a public registry with this entity name exists, activate opens the existing public registry, if not it creates a new public registry with name.

Parameters:
name - Public registry name, normally MQeNode_PublicRegistry
dirName - Path to public registry
Returns:
void
Throws:
MQeException - Except_Public_ActivateFailed, 'exception reason'
Example:
 try {
     // setup Public Registry activate parameters
     String name = "MQeNode_PublicRegistry";
     String dirName = ".//";
 
     // instantiate and activate Public Registry
     MQePublicRegistry pubreg = new MQePublicRegistry();
 
     pubreg.activate(name, dirName);
 } catch (Exception e) {// Handle the exception here
 }
 
 

deleteCertificate

public void deleteCertificate(java.lang.String certificateOwner)
                       throws java.lang.Exception

Deletes the certificate owner's mini-certificate.

Parameters:
certificateOwner - Authenticatable entity's (mini-certificate owner's) name.
Returns:
void
Throws:
java.lang.Exception -
  • Except_Reg_DoesNotExist, 'Entry does not exist'
  • Except_Reg_DeleteFailed, 'Error deleting entry'

putCertificate

public void putCertificate(java.lang.String certificateOwner,
                           MQeFields certificate)
                    throws java.lang.Exception

Adds the certificate owner’s mini-certificate to the public registry.

Parameters:
certificateOwner - Authenticatable entity's (mini-certificate owner's) name
certificate - Owner's mini-certificate
Returns:
void
Throws:
java.lang.Exception - Except_Reg_AddFailed, 'Error adding entry'
See Also:
deleteCertificate(java.lang.String), getCertificate(java.lang.String)

requestCertificate

public MQeFields requestCertificate(java.lang.String entity,
                                    java.lang.String mqeNodeAddrPort,
                                    java.lang.String adapter)
                             throws java.lang.Exception

Requests a mini-certificate from the public registry of another WebSphere MQ Everyplace node, and, if returned, saves it in this public registry.

Parameters:
entity - Authenticatable entity's (mini-certificate owner's) name.
mqeNodeAddrPort - TCP address and port of home-server of alternative WebSphere MQ Everyplace node.
adapter - The adapter class name or alias of the target queue manager.
Returns:
Mini-certificate.
Throws:
java.lang.Exception -
  • Except_Reg_DoesNotExist, 'Entry does not exist'
  • Except_Reg_ReadFailed, 'Error reading entry'
  • Except_Reg_AddFailed, 'Error adding entry'
See Also:
shareCertificate(java.lang.String, com.ibm.mqe.MQeFields, java.lang.String, java.lang.String)
Example:
 try {
     // setup RequestCertificate parameters
     String homeServerAddrPort = "homeServer.hursley.ibm.com:8082";
     String entityName = "Bruce";
 
     // instantiate and activate Public Registry
     MQePublicRegistry pubreg = new MQePublicRegistry();
 
     pubreg.activate("MQeNode_PublicRegistry", ".\\");
 
     // request Bruce's MiniCert from Public Reg on another MQeNode
     MQeFields minicertf = pubreg.getCertificate(entityName);
 
     pubreg.close();
 } catch (Exception e) {// Handle the error here.
 }
 
 

shareCertificate

public void shareCertificate(java.lang.String entity,
                             MQeFields minicertf,
                             java.lang.String mqeNodeAddrPort,
                             java.lang.String adapter)
                      throws java.lang.Exception

Replicates the certificate owner's mini-certificate to a public registry on another WebSphere MQ Everyplace node.

Parameters:
entity - Authenticatable entity's (mini-certificate owner's) name.
minicertf - Mini-certificate
mqeNodeAddrPort - TCP address and port of home-server of alternative WebSphere MQ Everyplace node.
adapter - The adapter class name .
Returns:
void
Throws:
java.lang.Exception -
  • Except_Reg_DoesNotExist, 'Entry does not exist'
  • Except_Reg_ReadFailed, 'Error reading entry'
  • Except_Reg_AddFailed, 'Error adding entry'
See Also:
requestCertificate(java.lang.String, java.lang.String, java.lang.String)
Example:
 try {
     // instantiate &activate a Private Reg for Auth Entity Bruce
     String entityName = "Bruce";
     String caIPAddrPort = "aname.hursley.ibm.com:8082";
     MQePrivateRegistry preg = new MQePrivateRegistry();
 
     preg.activate(entityName,
         ".\\MQeNode_PrivateRegistry",
         "12345678",
         "It_is_a_secret",
         "12345678",
         caIPAddrPort);
 
     // instantiate and activate Public Reg &save Bruce's MiniCert
     MQePublicRegistry pubreg = new MQePublicRegistry();
 
     pubreg.activate("MQeNode_PublicRegistry",
         ".\\MQeNode_PublicRegistry");
     pubreg.putCertificate(entityName,
         preg.getCertificate(entityName));
 
     // share Bruce's MiniCert with Public Reg on another MQeNode
     String homeServerAddrPort = "homeServer.hursley.ibm.com:8082";
 
     pubreg.shareCertificate(entityName,
         preg.getCertificate(entityName),
         homeServerAddrPort,
         "Network");
     preg.close();
     pubreg.close();
 } catch (Exception e) {//Handle the exception here.
 }
 
 

close

public void close()
Close the registry. The registry cannot be used after it has been closed.


Websphere MQ Everyplace