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

MQe_PrivateRegistryConfigure.h File Reference

C API header file for the MQePrivateRegistryConfigure object. More...


Functions

MQERETURN mqePrivateRegistryConfigure_new (MQeExceptBlock *pErrStruct, MQePrivateRegistryConfigureHndl *phPrivateRegistryConfigure, MQeStringHndl hName, MQeFieldsHndl hParameters, MQeStringHndl hPIN)
 Creates a new PrivateRegistryConfigure object.

MQERETURN mqePrivateRegistryConfigure_free (MQePrivateRegistryConfigureHndl hPrivateRegistryConfigure, MQeExceptBlock *pErrStruct)
 Call to free the handle to the PrivateRegistryConfigure object.

MQERETURN mqePrivateRegistryConfigure_activate (MQePrivateRegistryConfigureHndl hPrivateRegistryConfigure, MQeExceptBlock *pErrStruct, MQeStringHndl hName, MQeFieldsHndl hParameters, MQeStringHndl hRegPIN)
 Saves the registry name and opens the registry.

MQERETURN mqePrivateRegistryConfigure_close (MQePrivateRegistryConfigureHndl hPrivateRegistryConfigure, MQeExceptBlock *pErrStruct)
 Closes the configuration object and the associated registry.

MQERETURN mqePrivateRegistryConfigure_credentialsExist (MQePrivateRegistryConfigureHndl hPrivateRegistryConfigure, MQeExceptBlock *pErrStruct, MQEBOOL *pCredentialsExist)
 Checks whether the registry already contains credentials.

MQERETURN mqePrivateRegistryConfigure_getCredentials (MQePrivateRegistryConfigureHndl hPrivateRegistryConfigure, MQeExceptBlock *pErrStruct, MQeFieldsHndl hParameters, MQeStringHndl hRegPIN, MQeStringHndl hMiniCertServer, MQeStringHndl hMiniCertPIN, MQeStringHndl hRenamePrefix)
 Creates new credentials for the registry.

MQERETURN mqePrivateRegistryConfigure_isPrivateRegistry (MQePrivateRegistryConfigureHndl hPrivateRegistryConfigure, MQeExceptBlock *pErrStruct, MQEBOOL *pIsPrivate)
 Checks whether the Registry that has been opened is a private registry.

MQERETURN mqePrivateRegistryConfigure_renewCertificates (MQePrivateRegistryConfigureHndl hPrivateRegistryConfigure, MQeExceptBlock *pErrStruct, MQeStringHndl hRegPIN, MQeStringHndl hMiniCertServer, MQeStringHndl hMiniCertPIN, MQeStringHndl hRenamePrefix)
 Renew public certificate.


Detailed Description

Used to configure a private registry and get new credentials for the registry.


Function Documentation

MQERETURN mqePrivateRegistryConfigure_new MQeExceptBlock   pErrStruct,
MQePrivateRegistryConfigureHndl *    phPrivateRegistryConfigure,
MQeStringHndl    hName,
MQeFieldsHndl    hParameters,
MQeStringHndl    hPIN
 

You can supply NULL for the parameters name, parameters and pin if required.

Parameters takes fields with the following values. These are constants in the MQe_RegistryConstants.h file and are used as field names.

  • LocalRegType (ascii) The type of the registry being used
  • DirName (ascii) Directory of the registry files
  • PIN (ascii) PIN for the private registry
  • KeyRingPassword (ascii) Password/phrase used to protect the registry's private keys
  • Separator (ascii) Character used as a separator between entry names
  • regPin (ascii) PIN to open the registry
Parameters:
pErrStruct  [in/out] Pointer to error structure
phPrivateRegistryConfigure  Pointer to the handle of the new PrivateRegistryConfigureHandle
hName  [in] String with the name of the new registry
hParameters  [in] Handle to MQeField with the parameters
hPIN  [in] PIN required to open the 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 mqePrivateRegistryConfigure_free MQePrivateRegistryConfigureHndl    hPrivateRegistryConfigure,
MQeExceptBlock   pErrStruct
 

Parameters:
pErrStruct  [in/out] Pointer to error structure
hPrivateRegistryConfigure  [in] Handle of the PrivateRegistryConfigureHandle
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 mqePrivateRegistryConfigure_activate MQePrivateRegistryConfigureHndl    hPrivateRegistryConfigure,
MQeExceptBlock   pErrStruct,
MQeStringHndl    hName,
MQeFieldsHndl    hParameters,
MQeStringHndl    hRegPIN
 

If the regPIN parameters is not NULL it is used to open the Registry, otherwise the registry's PIN is obtained from the regParams parameter

Parameters:
hPrivateRegistryConfigure  [in] Handle of the PrivateRegistryConfigureHandle
pErrStruct  [in/out] Pointer to error structure
hParameters  [in] Handle of MQeFields with the parameters
hRegPIN  [in] PIN required to open the 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 mqePrivateRegistryConfigure_close MQePrivateRegistryConfigureHndl    hPrivateRegistryConfigure,
MQeExceptBlock   pErrStruct
 

An attempt to use this after it has been closed with results in error

Parameters:
pErrStruct  [in/out] Pointer to error structure
hPrivateRegistryConfigure  [in] Handle of the PrivateRegistryConfigureHandle

MQERETURN mqePrivateRegistryConfigure_credentialsExist MQePrivateRegistryConfigureHndl    hPrivateRegistryConfigure,
MQeExceptBlock   pErrStruct,
MQEBOOL *    pCredentialsExist
 

Parameters:
pErrStruct  [in/out] Pointer to error structure
hPrivateRegistryConfigure  [in] Handle of the PrivateRegistryConfigureHandle
pCredentialsExist  [out] Pointer to boolean, true if credentials already exist
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 mqePrivateRegistryConfigure_getCredentials MQePrivateRegistryConfigureHndl    hPrivateRegistryConfigure,
MQeExceptBlock   pErrStruct,
MQeFieldsHndl    hParameters,
MQeStringHndl    hRegPIN,
MQeStringHndl    hMiniCertServer,
MQeStringHndl    hMiniCertPIN,
MQeStringHndl    hRenamePrefix
 

If the Registry already contains credentials they are renamed using the rename prefix. If the rename fails for example because the new name already exists in the registry, and error occurs and no new credentials are created.

If an error occurs after the credentials have been renamed, they are changed back to their original names.

This method calls the mini-certificate server and can take some time to complete

Parameters:
pErrStruct  [in/out] Pointer to error structure
hPrivateRegistryConfigure  [in] Handle of the PrivateRegistryConfigureHandle
hRegPIN  The PIN for the registry,
hMiniCertServer  The address of the Mini-certificate Server.
hMiniCertPIN  The PIN for the Mini-certificate Server.
hRenamePrefix  The prefix used to rename existing credentials.
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 mqePrivateRegistryConfigure_isPrivateRegistry MQePrivateRegistryConfigureHndl    hPrivateRegistryConfigure,
MQeExceptBlock   pErrStruct,
MQEBOOL *    pIsPrivate
 

Parameters:
pErrStruct  [in/out] Pointer to error structure
hPrivateRegistryConfigure  [in] Handle of the PrivateRegistryConfigureHandle
pIsPrivate  [out] boolean, true if it is private
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 mqePrivateRegistryConfigure_renewCertificates MQePrivateRegistryConfigureHndl    hPrivateRegistryConfigure,
MQeExceptBlock   pErrStruct,
MQeStringHndl    hRegPIN,
MQeStringHndl    hMiniCertServer,
MQeStringHndl    hMiniCertPIN,
MQeStringHndl    hRenamePrefix
 

This method renews the public certificate for the registry. This is necessary if for example the existing certificate has expired.

The existing public certificate is renamed using renamePrefix. If the rename fables for example because the new name already exists in the registry, and error occurs and the certificate is not renewed.

If an error occurs after the certificate has been renamed, they are changed back to their original names.

This method calls the mini-certificate server and can take some time to complete

Parameters:
pErrStruct  [in/out] Pointer to error structure
hPrivateRegistryConfigure  [in] Handle of the PrivateRegistryConfigureHandle
hRegPin  [in] PIN required to open the registry
hMiniCertServer  [in] TCP address and port number of a mini-certificate server
hMiniCertPIN  [in] Certificate request number prealloacted by the min-certificate administrator to allow the registry to renew its certificate
hRenamePrefix  [in] Prefix used to rename the existing 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


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