getLifecycleStatus

Returns the lifecycle status of this security module.

For Java:

Copy

String getLifecycleStatus(SecurityModuleId smId) 
throws NoSuchSecurityModuleException, SessionException, ManagementException, LocalizedRemoteException;

For C++:

Copy

TString getLifecycleStatus(SecurityModuleId *smId);

Parameters:

smId—security module ID.

Returns:

The lifecycle status of this security module. The status is a concatenation of the security modules status and reason codes separated by a “,” (comma).

For example, for a status of ISSUED and a reason of ASSIGNED, the returned status would be:

SECURITY_MODULE_STATUS_ISSUED + "," + SECURITY_MODULE_STATUS_REASON_ASSIGNED.

The status returned can be:

Status	Description
SECURITY_MODULE_STATUS_AVAILABLE + "," + SECURITY_MODULE_STATUS_REASON_NONE	A blank unassigned device.
SECURITY_MODULE_STATUS_AVAILABLE + "," + SECURITY_MODULE_STATUS_REASON_RECYCLE	A blank unassigned device after a recycle.
SECURITY_MODULE_STATUS_REASON_ASSIGNED + "," + SECURITY_MODULE_STATUS_REASON_NONE	A blank assigned device.
SECURITY_MODULE_STATUS_INPRODUCTION + "," + SECURITY_MODULE_STATUS_REASON_NONE	A device in the process of being produced.
SECURITY_MODULE_STATUS_INVALID + "," + SECURITY_MODULE_STATUS_REASON_EXPIRED	A device that has expired and needs to be replaced.
SECURITY_MODULE_STATUS_PRODUCED + "," + SECURITY_MODULE_STATUS_REASON_ASSIGNED	A completed (produced) device that has not been handed to the user yet.
SECURITY_MODULE_STATUS_PRODUCED + "," + SECURITY_MODULE_STATUS_REASON_FAILED	A device after a failure during device production.
SECURITY_MODULE_STATUS_PRODUCED + "," + SECURITY_MODULE_STATUS_REASON_UNASSIGNED	A personalized device after it has been unbound from the user and terminated (regarding the credentials it carries).
SECURITY_MODULE_STATUS_PRODUCED + "," + SECURITY_MODULE_STATUS_REASON_STOLEN	A stolen device after termination (no longer bound to user).
SECURITY_MODULE_STATUS_PRODUCED + "," + SECURITY_MODULE_STATUS_REASON_LOST	Same as described above, but specific for a lost device.
SECURITY_MODULE_STATUS_ISSUED + "," + SECURITY_MODULE_STATUS_REASON_ASSIGNED	A typical healthy state for a bound, personalized, issued device.
SECURITY_MODULE_STATUS_INVALID + "," + SECURITY_MODULE_STATUS_REASON_ONHOLD	A suspended device.
SECURITY_MODULE_STATUS_INVALID + "," + SECURITY_MODULE_STATUS_REASON_FORGOTTEN	A suspended device after a temporary replacement device has been requested.
SECURITY_MODULE_STATUS_INVALID + "," + SECURITY_MODULE_STATUS_REASON_DAMAGED	Same as described above, but specifically for a permanently damaged device (requiring a permanent replacement device).
SECURITY_MODULE_STATUS_INVALID + "," + SECURITY_MODULE_STATUS_REASON_LOST	Same as described above, but for an assumed permanently lost device (requiring a permanent replacement device). The fact that it was lost is retained unless the device is located again and recycled.
SECURITY_MODULE_STATUS_INVALID + "," + SECURITY_MODULE_STATUS_REASON_STOLEN	Same as lost device description, except that the fact that it was stolen is retained unless the device is located again and recycled.
SECURITY_MODULE_STATUS_TERMINATED + "," + SECURITY_MODULE_STATUS_REASON_DAMAGED	A device that has been sighted, confirmed destroyed, and then terminated logistically (through a portal or using APIs).

Exceptions:

NoSuchSecurityModuleException—if the security module ID specified does not identify a valid security module.
SessionException—if there is no valid session (such as session not opened or timed out).
ManagementException—if an internal implementation-level failure occurs.
LocalizedRemoteException— (thrown by the Web service layer) only when the most severe, unexpected, SOAP-level failures occur.

See also: Section Security Module / Device Lifecycle.