com.hcl.domino.keep.exceptions

Class KeepException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.hcl.domino.keep.exceptions.KeepException

All Implemented Interfaces:

KeepExceptionType, java.io.Serializable

Direct Known Subclasses:

KeepExceptionBadUsernamePassword, KeepExceptionDqlDisallowed, KeepExceptionInsufficientAccess, KeepExceptionInsufficientAccessForDocument, KeepExceptionInvalidSAMLRequest, KeepExceptionInvalidSAMLResponse, KeepExceptionMissingParameters, KeepExceptionNotFound, KeepExceptionNotImplemented, KeepExceptionOpenAccessBlocked, KeepExceptionServer, KeepExceptionWrongDataRequest, KeepExceptionWrongServer

public class KeepException
extends java.lang.Exception
implements KeepExceptionType

Exception that gets thrown when logic requirements of the keep server aren’t met. Mainly used to distinguish from code things breaking Should not be called / instantiated directly Base class for the Rest of KeepException*

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	KeepException(java.lang.String message, java.lang.Object... args)

Method Summary

Modifier and Type	Method and Description
static KeepException	fromJson(io.vertx.core.json.JsonObject source)
static KeepException	fromThrowable(java.lang.Throwable source)
static KeepException	get(java.lang.String msg, java.lang.Object... params)
ErrorClassification	getKeepErrorType() The type of error the Exception represents
org.apache.logging.log4j.Level	getLevel()
java.lang.String	getLocation()
static KeepException	status(java.lang.String msg, ErrorClassification classification)
io.vertx.core.json.JsonObject	toJson()

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

KeepException

protected KeepException(java.lang.String message,
                        java.lang.Object... args)

Parameters:

message -

• why things go wrong, with formatting

args - Arguments that are passed into the format function

Method Detail

fromJson

public static KeepException fromJson(io.vertx.core.json.JsonObject source)

Parameters:

source -

Returns:

a KeepException

fromThrowable

public static KeepException fromThrowable(java.lang.Throwable source)

Parameters:

source -

Returns:

Keep exception

get

public static KeepException get(java.lang.String msg,
                                java.lang.Object... params)

Parameters:

msg -

params -

Returns:

a new generic KeepException

status

public static KeepException status(java.lang.String msg,
                                   ErrorClassification classification)

Parameters:

msg -

classification -

Returns:

KeepException

getKeepErrorType

public ErrorClassification getKeepErrorType()

Description copied from interface: KeepExceptionType

The type of error the Exception represents

Specified by:

getKeepErrorType in interface KeepExceptionType

Returns:

a BadRequest Error as default

getLevel

public org.apache.logging.log4j.Level getLevel()

Specified by:

getLevel in interface KeepExceptionType

Returns:

Error level as http

getLocation

public java.lang.String getLocation()

Returns:

Server location for 301/302 type of errors

toJson

public io.vertx.core.json.JsonObject toJson()

Returns:

Error as Json