Module vault.java.driver

Package io.github.jopenlibs.vault

Class VaultException

java.lang.Object

java.lang.Throwable

java.lang.Exception

io.github.jopenlibs.vault.VaultException

All Implemented Interfaces:

Serializable

public class VaultException
extends Exception

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
VaultException(String message)
VaultException(String message, int httpStatusCode)	Use this constructor to generate a VaultException instance that is based on receiving a particular HTTP status code from a Vault server (e.g. 500).
VaultException(Throwable t)
VaultException(Throwable t, int httpStatusCode)	Use this constructor to generate a VaultException instance that is based on receiving a particular HTTP status code from a Vault server (e.g. 500).

Method Summary

Modifier and Type	Method	Description
int	getHttpStatusCode()	An HTTP status code, returned from a Vault server, that is the cause of this VaultException.

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 Details

VaultException

public VaultException(String message)

VaultException

public VaultException(Throwable t)

VaultException

public VaultException(String message,
 int httpStatusCode)

Use this constructor to generate a VaultException instance that is based on receiving a particular HTTP status code from a Vault server (e.g. 500).

Parameters:

message - A string expressing the exception cause

httpStatusCode - An HTTP status code returned by a Vault server (e.g. 500)

VaultException

public VaultException(Throwable t,
 int httpStatusCode)

Use this constructor to generate a VaultException instance that is based on receiving a particular HTTP status code from a Vault server (e.g. 500).

Parameters:

t - Another exception that this VaultException will wrap

httpStatusCode - An HTTP status code returned by a Vault server (e.g. 500)

Method Details

getHttpStatusCode

public int getHttpStatusCode()

An HTTP status code, returned from a Vault server, that is the cause of this VaultException. Some exceptions are not caused on the Vault side. Obviously, if there is no relevant HTTP status code then this method will return 0.

Returns:

An HTTP status code, returned from a Vault server, that is the cause of this VaultException