Package org.bouncycastle.operator

Class OperatorException

  • All Implemented Interfaces:
    java.io.Serializable
    Direct Known Subclasses:
    OperatorCreationException
    public class OperatorException
extends java.lang.Exception
    Base checked exception for failures originating in the org.bouncycastle.operator abstraction layer — the bridge between BC's JCA-free high-level packages (org.bouncycastle.cms, org.bouncycastle.cert, org.bouncycastle.pkcs, etc.) and their underlying JCA / lightweight implementations (org.bouncycastle.operator.jcajce / org.bouncycastle.operator.bc).

    Operators are the small, focused capability interfaces in this package — ContentSigner, ContentVerifier, DigestCalculator, MacCalculator, KeyWrapper, OutputEncryptor, and so on — that callers obtain from concrete builders. OperatorException (and its subclasses) are the way those builders and the operators themselves report failure back to the high-level code, without that high-level code having to declare java.security.* / javax.crypto.* checked exceptions in its API.

    Direct subclasses:

    • OperatorCreationException — thrown by an operator builder (e.g. JcaContentSignerBuilder, BcRSAContentSignerBuilder, JcaDigestCalculatorProviderBuilder) when it cannot produce the requested operator. Typical underlying causes include an unknown algorithm OID, an invalid key type for the requested algorithm, an unsupported parameter combination, or a missing / misconfigured JCA provider.
    • OperatorStreamException — an IOException subclass thrown from inside an operator's OutputStream.write / InputStream.read when the streaming method's signature only permits IOException.
    • RuntimeOperatorException — the unchecked variant used when an operator method has no throws clause to declare a checked exception on (for example methods overriding Closeable.close()).
    The original underlying failure, when there is one, is available via Throwable.getCause().
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      OperatorException​(java.lang.String msg)
      Construct an exception with the supplied diagnostic message and no underlying cause.
      OperatorException​(java.lang.String msg, java.lang.Throwable cause)
      Construct an exception with the supplied diagnostic message and the underlying cause (typically a GeneralSecurityException, IOException, or lightweight org.bouncycastle.crypto.CryptoException) that triggered the failure.

    • Method Summary

      • 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

      • OperatorException

        public OperatorException​(java.lang.String msg,
                         java.lang.Throwable cause)
        Construct an exception with the supplied diagnostic message and the underlying cause (typically a GeneralSecurityException, IOException, or lightweight org.bouncycastle.crypto.CryptoException) that triggered the failure.
        Parameters:
        msg - diagnostic message describing the failure.
        cause - the underlying exception that triggered the failure, or null if this exception originates the failure itself.

      • OperatorException

        public OperatorException​(java.lang.String msg)
        Construct an exception with the supplied diagnostic message and no underlying cause.
        Parameters:
        msg - diagnostic message describing the failure.