Main Page   Modules   Data Structures   File List   Data Fields   Globals   Related Pages  

MQe_PublicRegistry.h File Reference

C API header file for the MQePublicRegistry. More...


Functions

MQERETURN mqePublicRegistry_new (MQeExceptBlock *pErrStruct, MQePublicRegistryHndl *phPublicRegistry)
MQERETURN mqePublicRegistry_free (MQePublicRegistryHndl hPublicRegistry, MQeExceptBlock *pErrStruct)
MQERETURN mqePublicRegistry_close (MQePublicRegistryHndl hPublicRegistry, MQeExceptBlock *pErrStruct)
MQERETURN mqePublicRegistry_activate (MQePublicRegistryHndl hPublicRegistry, MQeExceptBlock *pErrStruct, MQeStringHndl hEntityName, MQeStringHndl hDirName)
MQERETURN mqePublicRegistry_deleteCertificate (MQePublicRegistryHndl hPublicRegistry, MQeExceptBlock *pErrStruct, MQeStringHndl hCertificateOwner)
MQERETURN mqePublicRegistry_getCertificate (MQePublicRegistryHndl hPublicRegistry, MQeExceptBlock *pErrStruct, MQeFieldsHndl *phMiniCertificate, MQeStringHndl hCertificateOwner)
MQERETURN mqePublicRegistry_putCertificate (MQePublicRegistryHndl hPublicRegistry, MQeExceptBlock *pErrStruct, MQeStringHndl hCertificateOwner, MQeFieldsHndl hCertificate)
MQERETURN mqePublicRegistry_requestCertificate (MQePublicRegistryHndl hPublicRegistry, MQeExceptBlock *pErrStruct, MQeFieldsHndl *phMiniCertificate, MQeStringHndl hCertificateOwner, MQeStringHndl hMQeNodeAddrPort, MQeStringHndl hAdapter)
MQERETURN mqePublicRegistry_shareCertificate (MQePublicRegistryHndl hPublicRegistry, MQeExceptBlock *pErrStruct, MQeStringHndl hCertificateOwner, MQeFieldsHndl hCertificate, MQeStringHndl hMQeNodeAddrPort, MQeStringHndl hAdapter)


Detailed Description


Function Documentation

MQERETURN mqePublicRegistry_new MQeExceptBlock   pErrStruct,
MQePublicRegistryHndl *    phPublicRegistry
 

Creates a new Public Registry

Parameters:
pErrStruct  [in/out] Pointer to Error Structure
phPublicRegistry  [out] Pointer to handle of new Public Registry
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Return values:
MQERETURN_OK  Completed Successfully

MQERETURN mqePublicRegistry_free MQePublicRegistryHndl    hPublicRegistry,
MQeExceptBlock   pErrStruct
 

Frees the Public Registry handle

Parameters:
hPublicRegistry  [in] Handle to the public Registry
pErrStruct  [in/out] Pointer to error structure
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Return values:
MQERETURN_OK  Completed Successfully

MQERETURN mqePublicRegistry_close MQePublicRegistryHndl    hPublicRegistry,
MQeExceptBlock   pErrStruct
 

Closes the Public Registry handle

Parameters:
hPublicRegistry  [in] Handle to the public Registry
pErrStruct  [in/out] Pointer to error structure
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Return values:
MQERETURN_OK  Completed Successfully

MQERETURN mqePublicRegistry_activate MQePublicRegistryHndl    hPublicRegistry,
MQeExceptBlock   pErrStruct,
MQeStringHndl    hEntityName,
MQeStringHndl    hDirName
 

If a public registry of this name already exists activate opens the existing registry ifnot is creates a new public registry with the name pName

Parameters:
hPublicRegistry  [in] Handle to the public Registry
pErrStruct  [in/out] Pointer to error structure
pName  [in] Pointer to \0 terminated name, normally MQENode_PublicRegistry
hDirName  [in] Path to public registry
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Return values:
MQERETURN_OK  Completed Successfully
MQERETURN_J_PUBLIC_REG_ACTIVATE_FAILED  Could not activate public registry

MQERETURN mqePublicRegistry_deleteCertificate MQePublicRegistryHndl    hPublicRegistry,
MQeExceptBlock   pErrStruct,
MQeStringHndl    hCertificateOwner
 

Deletes the certificate owner's mini-certificate

Parameters:
hPublicRegistry  [in] Handle to the public Registry
pErrStruct  [in/out] Pointer to error structure
pCertificateOwner  [in] Mini-certificate owner's name
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Return values:
MQERETURN_OK  Completed Successfully
MQERETURN_J_REG_DOES_NOT_EXIST  Registry does not exist
MQERETURN_J_REG_DELETE_FAILED  Could not delete an entry to registry

MQERETURN mqePublicRegistry_getCertificate MQePublicRegistryHndl    hPublicRegistry,
MQeExceptBlock   pErrStruct,
MQeFieldsHndl *    phMiniCertificate,
MQeStringHndl    hCertificateOwner
 

Returns the certificate owner's mini-certificate

Parameters:
hPublicRegistry  [in] Handle to the public Registry
pErrStruct  [in/out] Pointer to error structure
phMiniCertificate  [out] Pointer to handle of mini-certificate
hCertificateOwner  [in] Mini-certificate owner's name
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Return values:
MQERETURN_OK  Completed Successfully
MQERETURN_J_REG_READ_FAILED  Could not read an registry entry

MQERETURN mqePublicRegistry_putCertificate MQePublicRegistryHndl    hPublicRegistry,
MQeExceptBlock   pErrStruct,
MQeStringHndl    hCertificateOwner,
MQeFieldsHndl    hCertificate
 

Adds the certificate owner's mini-certificate to the public registry

Parameters:
hPublicRegistry  [in] Handle to the public Registry
pErrStruct  [in/out] Pointer to error structure
hCertificateOwner  [in] Mini-certificate owner's name
hCertificate  [out] Handle of the mini-certificate
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Return values:
MQERETURN_OK  Completed Successfully
MQERETURN_J_REG_ALREADY_EXISTS  Registry already exists
MQERETURN_J_REG_ADD_FAILED  Could not add an entry to registry

MQERETURN mqePublicRegistry_requestCertificate MQePublicRegistryHndl    hPublicRegistry,
MQeExceptBlock   pErrStruct,
MQeFieldsHndl *    phMiniCertificate,
MQeStringHndl    hCertificateOwner,
MQeStringHndl    hMQeNodeAddrPort,
MQeStringHndl    hAdapter
 

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

Parameters:
hPublicRegistry  [in] Handle to the public Registry
pErrStruct  [in/out] Pointer to error structure
phMiniCertificate  [out] Pointer to handle of mini-certificate
hCertificateOwner  [in] Pointer to certificate owner
hMQeNodeAddrPort  [in] TCP Address and port of the home-server or alternative MQSeries Everyplace Node
hAdapter  [in] Name of the Adapter
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Return values:
MQERETURN_OK  Completed Successfully
MQERETURN_J_REG_ADD_FAILED  Could not add an entry to registry
MQERETURN_J_REG_DOES_NOT_EXIST  Registry does not exist
MQERETURN_J_REG_READ_FAILED  Could not read an registry entry

MQERETURN mqePublicRegistry_shareCertificate MQePublicRegistryHndl    hPublicRegistry,
MQeExceptBlock   pErrStruct,
MQeStringHndl    hCertificateOwner,
MQeFieldsHndl    hCertificate,
MQeStringHndl    hMQeNodeAddrPort,
MQeStringHndl    hAdapter
 

Replicates the certificates owner's mini-certificate to a public registry on another MQSeries Everyplace node

Parameters:
hPublicRegistry  [in] Handle to the public Registry
pErrStruct  [in/out] Pointer to error structure
hCertificateOwner  [in] Pointer to certificate owner
hCertificate  [in] Handle of the mini-certificate
hMQeNodeAddrPort  [in] TCP Address and port of the home-server or alternative MQSeries Everyplace Node
hAdapter  [in] Name of the Adapter
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Return values:
MQERETURN_OK  Completed Successfully
MQERETURN_J_REG_ADD_FAILED  Could not add an entry to registry
MQERETURN_J_REG_DOES_NOT_EXIST  Registry does not exist
MQERETURN_J_REG_READ_FAILED  Could not read an registry entry


Generated Thu Aug 11 23:41:21 2005 for Websphere MQ Everyplace for Multiplatforms C Bindings Reference