com.marklogic.client

Class MarkLogicServerException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.marklogic.client.MarkLogicServerException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

FailedRequestException, ForbiddenUserException, ResourceNotFoundException, ResourceNotResendableException

public abstract class MarkLogicServerException
extends RuntimeException

Abstract class that implements functionality for errors returned from a MarkLogic REST API instance. A REST instance wraps error messages into an XML or JSON structure that can be parsed and turned into the FailedRequest Java object. The MarkLogicServerException contains the FailedRequest object which is incorporated into getMessage() or can be examined via getFailedRequest()

See Also:

FailedRequest, Serialized Form

Constructor Summary

Constructors

Constructor and Description
MarkLogicServerException(String localMessage)
MarkLogicServerException(String localMessage, com.marklogic.client.impl.FailedRequest failedRequest)
MarkLogicServerException(String localMessage, Throwable cause)

Method Summary

Modifier and Type	Method and Description
com.marklogic.client.impl.FailedRequest	getFailedRequest()
String	getMessage()

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MarkLogicServerException

public MarkLogicServerException(String localMessage,
                                com.marklogic.client.impl.FailedRequest failedRequest)

Parameters:

localMessage - message describing the exception

failedRequest - details about the failed request behind this exception

MarkLogicServerException

public MarkLogicServerException(String localMessage)

MarkLogicServerException

public MarkLogicServerException(String localMessage,
                                Throwable cause)

Method Detail

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable

getFailedRequest

public com.marklogic.client.impl.FailedRequest getFailedRequest()