DigitalCertStore Class Methods
The methods in this section are described in alphabetical order.
Syntax
DigitalCertStore()
Description
Use the DigitalCertStore constructor method to instantiate a DigitalCertStore object.
Parameters
None.
Returns
A DigitalCertStore object.
Example
Use the create built-in function to instantiate a DigitalCertStore object:
import PT_SECURITY_DIGITALCERTSTORE:DigitalCertStore;
&oStore = create PT_SECURITY_DIGITALCERTSTORE:DigitalCertStore();
Syntax
ExtractCertificateByAuthorizedRole(digital_ID, auth_role, dest_location, &keystore_pwd)
Description
Use the ExtractCertificateByAuthorizedRole method to retrieve a digital certificate file to the specified location on the application server based on the specified digital ID and whether the current user has the specified role. This method also returns the encrypted password for the certificate file.
Important! Do not use this method in an implementation of the IPT_PDFSIGNATURE_INT:IPDFSignature interface class. Oracle reserves the right to modify this method in the future.
Parameters
|
Field or Control |
Definition |
|---|---|
| digital_ID |
Specifies the digital ID for the certificate as a string value. |
| auth_role |
Specifies a role name as a string value. |
| dest_location |
Specifies the absolute URL to store the certificate file on the application server as a string value. |
| &keystore_pwd |
Specifies an already instantiated string variable to store the returned encrypted password. |
Returns
A return code as a numeric value:
|
Numeric Value |
Description |
|---|---|
|
0 |
The method executed successfully. |
|
58 |
The digital ID, role name, or the destination location is invalid due to being specified as an empty string. |
|
59 |
There is no certificate file or password available to the specified role name. |
|
60 |
The role name is not authorized or cannot be found. |
|
61 |
There was an error downloading the certificate file from the database. |
|
79 |
The current user does not have the specified role. |
Syntax
ExtractCertificateByAuthorizedUser(digital_ID, auth_user, dest_location, &keystore_pwd)
Description
Use the ExtractCertificateByAuthorizedUser method to retrieve a digital certificate file to the specified location on the application server based on the specified digital ID and whether the current user is the specified user. This method also returns the encrypted password for the certificate file.
Important! Do not use this method in an implementation of the IPT_PDFSIGNATURE_INT:IPDFSignature interface class. Oracle reserves the right to modify this method in the future.
Parameters
|
Field or Control |
Definition |
|---|---|
| digital_ID |
Specifies the digital ID for the certificate as a string value. |
| auth_user |
Specifies a user ID as a string value. |
| dest_location |
Specifies the absolute URL to store the certificate file on the application server as a string value. |
| &keystore_pwd |
Specifies an already instantiated string variable to store the returned encrypted password. |
Returns
A return code as a numeric value:
|
Numeric Value |
Description |
|---|---|
|
0 |
The method executed successfully. |
|
54 |
The digital ID, user ID, or the destination location is invalid due to being specified as an empty string. |
|
55 |
There is no certificate file or password available to the specified user ID. |
|
56 |
The specified user ID is not authorized or cannot be found. |
|
57 |
There was an error downloading the certificate file from the database. |
|
78 |
The specified user ID is not the current user. |
Syntax
ExtractCertificateByDigitalID(digital_ID, dest_location, &keystore_pwd)
Description
Use the ExtractCertificateByDigitalID method to retrieve a digital certificate file to the specified location on the application server based on the specified digital ID. This method also returns the encrypted password for the certificate file.
Important! Do not use this method in an implementation of the IPT_PDFSIGNATURE_INT:IPDFSignature interface class. Oracle reserves the right to modify this method in the future.
Parameters
|
Field or Control |
Definition |
|---|---|
| digital_ID |
Specifies the digital ID for the certificate as a string value. |
| dest_location |
Specifies the absolute URL to store the certificate file on the application server as a string value. |
| &keystore_pwd |
Specifies an already instantiated string variable to store the returned encrypted password. |
Returns
A return code as a numeric value:
|
Numeric Value |
Description |
|---|---|
|
0 |
The method executed successfully. |
|
50 |
The digital ID or the destination location is invalid due to being specified as an empty string. |
|
51 |
There is no certificate file or password for the specified digital ID |
|
52 |
The digital ID is inactive or cannot be found. |
|
53 |
There was an error downloading the certificate file from the database. |
|
56 |
The specified user ID is not authorized or cannot be found. |
|
79 |
The current user does not have the specified role. |
Example
&errCode = &oStore.ExtractCertificateByDigitalID(&digitalID, &sOutDestination, &psw);
&keystorePswd = &psw;
If &errCode > 0 Then
&m_sError = &oStore.ErrorMessageDetail;
End-If;Syntax
getDigitalCertFileNameByDigitalID(digital_ID, &file_name)
Description
Use the getDigitalCertFileNameByDigitalID method to return the name of the digital certificate file based on the specified digital ID.
Important! Do not use this method in an implementation of the IPT_PDFSIGNATURE_INT:IPDFSignature interface class. Oracle reserves the right to modify this method in the future.
Parameters
|
Field or Control |
Definition |
|---|---|
| digital_ID |
Specifies the digital ID for the certificate as a string value. |
| &file_name |
Specifies an already instantiated string variable to store the returned certificate file name. |
Returns
A return code as a numeric value:
|
Numeric Value |
Description |
|---|---|
|
0 |
The method executed successfully. |
|
65 |
The digital ID was specified as the empty string. |
|
70 |
No file name is defined for this digital ID. |
Example
&errCode = &oStore.getDigitalCertFileNameByDigitalID(&digitalID, &tmpStr);
If &errCode > 0 Then /* failure */
&m_sError = &oStore.ErrorMessageDetail;
Else /* success */
...
End-If;
Syntax
getDigitalIdBySigner(signer, &array_digitalIDs)
Description
Use the getDigitalIdBySigner method to return a list of digital IDs that are available to the specified signer.
Parameters
|
Field or Control |
Definition |
|---|---|
| signer |
Specifies the ID of the signer as a string value. |
| &array_digitalIDs |
Specifies an already instantiated array of string to store the returned list of digital IDs. |
Returns
A return code as a numeric value:
|
Numeric Value |
Description |
|---|---|
|
0 |
The method executed successfully. |
|
62 |
The signer was specified as the empty string. |
|
63 |
No digital IDs are defined for this signer. |
Syntax
getEncPassword(digital_ID, &keystore_pwd )
Description
Use the getEncPassword method to return the encrypted password for the specified digital ID.
Important! Do not use this method in an implementation of the IPT_PDFSIGNATURE_INT:IPDFSignature interface class. Oracle reserves the right to modify this method in the future.
Parameters
|
Field or Control |
Definition |
|---|---|
| digital_ID |
Specifies the digital ID of the certificate as a string value. |
| &keystore_pwd |
Specifies an already instantiated string variable to store the returned encrypted password. |
Returns
A return code as a numeric value:
|
Numeric Value |
Description |
|---|---|
|
0 |
The method executed successfully. |
|
65 |
The digital ID was specified as the empty string. |
|
73 |
No password is defined for this digital ID. |
Syntax
getListOfAuthorizedRoleNames(digital_ID, &array_auth_roles)
Description
Use the getListOfAuthorizedRoleNames method to return the list of authorized roles for the specified digital ID.
Parameters
|
Field or Control |
Definition |
|---|---|
| digital_ID |
Specifies the digital ID for the certificate as a string value. |
| &array_auth_roles |
Specifies an already instantiated array of string to store the returned list of authorized roles names. |
Returns
A return code as a numeric value:
|
Numeric Value |
Description |
|---|---|
|
0 |
The method executed successfully. |
|
65 |
The digital ID was specified as the empty string. |
|
68 |
No authorized roles are defined for this digital ID. |
|
69 |
The method executed successfully. There are n authorized roles for the specified digital ID. |
Syntax
getListOfAuthorizedUsers(digital_ID, &array_auth_users)
Description
Use the getListOfAuthorizedUsers method to return the list of authorized users for the specified digital ID.
Parameters
|
Field or Control |
Definition |
|---|---|
| digital_ID |
Specifies the digital ID for the certificate as a string value. |
| &array_auth_users |
Specifies an already instantiated array of string to store the returned list of authorized user IDs. |
Returns
A return code as a numeric value:
|
Numeric Value |
Description |
|---|---|
|
0 |
The method executed successfully. |
|
65 |
The digital ID was specified as the empty string. |
|
66 |
No authorized users are defined for this digital ID. |
|
67 |
The method executed successfully. There are n authorized users for the specified digital ID. |
Syntax
getListOfDigitalId(&array_digitalIDs)
Description
Use the getListOfDigitalId method to return the list of all digital IDs defined in the certification store.
Parameters
|
Field or Control |
Definition |
|---|---|
| &array_digitalIDs |
Specifies an already instantiated array of string to store the returned list of digital IDs. |
Returns
A return code as a numeric value:
|
Numeric Value |
Description |
|---|---|
|
0 |
The method executed successfully. |
|
64 |
No digital IDs are defined in the certification store. |
Example
&arrIds = CreateArrayRept("", 0);
&errCode = &secStore.getListOfDigitalId(&arrIds);
Syntax
getListOfSigner(&array_signers)
Description
Use the getListOfSigner method to return the list of all signers defined in the certification store.
Parameters
|
Field or Control |
Definition |
|---|---|
| &array_signers |
Specifies an already instantiated array of string to store the returned list of signers. |
Returns
A return code as a numeric value:
|
Numeric Value |
Description |
|---|---|
|
0 |
The method executed successfully. |
|
72 |
No signers are defined in the certification store. |
Syntax
getSignerByDigitalId(digital_ID, &signer)
Description
Use the getSignerByDigitalId method to return the ID of the signer for the specified digital ID.
Parameters
|
Field or Control |
Definition |
|---|---|
| digital_ID |
Specifies the digital ID for the certificate as a string value. |
| &signer |
Specifies an already instantiated string variable to store the returned signer’s ID. |
Returns
A return code as a numeric value:
|
Numeric Value |
Description |
|---|---|
|
0 |
The method executed successfully. |
|
65 |
The digital ID was specified as the empty string. |
|
71 |
No signer is defined for this digital ID. |
Syntax
isDigitalCertValid(digital_ID)
Description
Use the isDigitalCertValid to determine whether the digital ID is valid.
Parameters
|
Field or Control |
Definition |
|---|---|
| digital_ID |
Specifies the digital ID as a string value. |
Returns
A Boolean value.