com.entrust.toolkit.exceptions

Class EntrustPKIXCMPException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.entrust.toolkit.exceptions.ExceptionWithInnerException

com.entrust.toolkit.exceptions.PKIXException

com.entrust.toolkit.exceptions.EntrustPKIXCMPException

All Implemented Interfaces:

java.io.Serializable

public class EntrustPKIXCMPException
extends PKIXException

This exception is thrown when an error occurs during a PKIX-CMP transaction with an Entrust Security Manager.

This exception provides access to the lower-level exception that is the root-cause of the problem.

Since:

7.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
EntrustPKIXCMPException(java.lang.String message) Creates an EntrustPKIXCMPException with the indicated exception message.
EntrustPKIXCMPException(java.lang.String message, ErrorMsgContent errorMsgContent) Creates an EntrustPKIXCMPException that was caused by a PKIX-CMP error.
EntrustPKIXCMPException(java.lang.String message, java.lang.Exception innerException) Creates an EntrustPKIXCMPException with the indicated inner exception, and exception message.

Method Summary

Modifier and Type	Method and Description
boolean	causedByDisabledUser() Indicates whether the exception was caused by a PKIX-CMP error message that was returned by the Security Manager because the user has been disabled.
boolean	causedBySecurityManagerError() Indicates whether the exception was caused by a PKIX-CMP error message that was returned by the Security Manager.
ErrorMsgContent	getErrorMessage() Returns details about the PKIX-CMP error that caused this exception.

Methods inherited from class com.entrust.toolkit.exceptions.ExceptionWithInnerException

getMessageChain, getMessageChain

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

EntrustPKIXCMPException

public EntrustPKIXCMPException(java.lang.String message)

Creates an EntrustPKIXCMPException with the indicated exception message.

Parameters:

message - a message explaining why the exception occurred

EntrustPKIXCMPException

public EntrustPKIXCMPException(java.lang.String message,
                               java.lang.Exception innerException)

Creates an EntrustPKIXCMPException with the indicated inner exception, and exception message. The inner exception provides a lower level of detail as to why this exception has occurred.

Parameters:

message - a message explaining why the exception occurred

innerException - the inner exception

EntrustPKIXCMPException

public EntrustPKIXCMPException(java.lang.String message,
                               ErrorMsgContent errorMsgContent)

Creates an EntrustPKIXCMPException that was caused by a PKIX-CMP error.

The exception is created with the indicated exception message and details about the PKIX-CMP error that caused this exception.

Parameters:

message - a message explaining why the exception occurred

errorMsgContent - details about the PKIX-CMP error that caused this exception

Method Detail

getErrorMessage

public ErrorMsgContent getErrorMessage()

Returns details about the PKIX-CMP error that caused this exception.

This exception, and every exception in the inner exception chain, are checked to see if they contain details about a PKIX-CMP error. If so, this information is returned; if not, null is returned.

Returns:

details about the PKIX-CMP error that caused this exception; null if this exception was not caused by a PKIX-CMP error

causedBySecurityManagerError

public boolean causedBySecurityManagerError()

Indicates whether the exception was caused by a PKIX-CMP error message that was returned by the Security Manager.

Returns:

true if the exception occurred because a PKIX-CMP error message was received; false otherwise

causedByDisabledUser

public boolean causedByDisabledUser()

Indicates whether the exception was caused by a PKIX-CMP error message that was returned by the Security Manager because the user has been disabled.

Returns:

true if the exception occurred because the user has been disabled; false otherwise