Overview Package Class Deprecated Help

hsm
HSMConfig

Instance containing configuration information for HSM

public class HSMConfig

Properties
configPath Specifies the name of the HSM configuration file.

type=string
access=read-create
default=
minimum=1
Mandatory on create
Displayed(tab/group)=HSM Configuration Filename
description Description.

type=string
default=
minimum=0
maximum=64
Displayed(tab/group)=Description
id

type=long
access=read-create
default=0
minimum=1
maximum=65535
Displayed(tab/group)=ID
pin Specifies the user password (or PKCS #11 pin) associated with the HSM.

type=string
default=
minimum=1
maximum=64
Displayed(tab/group)=User Password (PKCS #11 PIN)
  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

forceDelete

Force deletes this HSMConfig, regardless whether stale entries exist on the HSM or not.

Please note, if stale entries exist on the HSM, after this force deletion, NFM-P will not be able to delete these stale entries from the HSM in the future.

Input Parameters:
deployer : Deployer - the deployment state
synchronousDeploy : boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure : boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries : int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval : long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription : string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
instanceFullName : string - the full name of the object.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
hsm.HSMConfig.forceDeleteException

purgeStaleEntriesOnHsm

Purge stale (non-referenced) entries, that were created through this HSMConfig, on the HSM.

Please note, HSM entries are identified by their labels. Normally NFM-P deletes an entry from the HSM if it is no longer needed. However if the deletion fails the entry may become stale on the HSM. Stale entries in this HSMConfig need to be purged on the HSM explicitly through this method call.

Input Parameters:
deployer : Deployer - the deployment state
synchronousDeploy : boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure : boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries : int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval : long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription : string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
instanceFullName : string - the full name of the object.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
result : hsm.ExecutionResult - Returns notExecuted(0) if no stale entries (identified by their labels) are associated with this HSMConfig, succeeded(1) if operation succeeds, failed(2) otherwise.
Exceptions:
hsm.HSMConfig.purgeStaleEntriesOnHsmException

testConnectionToHsm

Test the connection to the HSM. This method sends a test request to the HSM.
Input Parameters:
deployer : Deployer - the deployment state
synchronousDeploy : boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure : boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries : int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval : long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription : string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
instanceFullName : string - the full name of the object.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
result : boolean - True if the test request was successfully executed; false otherwise.
Exceptions:
hsm.HSMConfig.testConnectionToHsmException