com.marklogic.client

Class MarkLogicServerException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.marklogic.client.MarkLogicServerException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

FailedRequestException, ForbiddenUserException, ResourceNotFoundException, ResourceNotResendableException

public abstract class MarkLogicServerException
extends java.lang.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:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
com.marklogic.client.impl.FailedRequest	getFailedRequest()
java.lang.String	getMessage()
java.lang.String	getServerMessage() Gets the error message (if any) specific to the error on the server.
java.lang.String	getServerMessageCode() Gets the error code (if any) specific to the error on the server.
java.lang.String	getServerStackTrace() Gets the stack trace (if any) specific to the error on the server.
java.lang.String	getServerStatus() Gets the HTTP status message (if any) associated with the error on the server.
int	getServerStatusCode() Gets the HTTP status code (if any) associated with the error on the server.

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

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

Constructor Detail

MarkLogicServerException

public MarkLogicServerException(java.lang.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(java.lang.String localMessage)

MarkLogicServerException

public MarkLogicServerException(java.lang.String localMessage,
                                java.lang.Throwable cause)

Method Detail

getMessage

public java.lang.String getMessage()

Overrides:

getMessage in class java.lang.Throwable

getServerStatusCode

public int getServerStatusCode()

Gets the HTTP status code (if any) associated with the error on the server.

Returns:

the status code

getServerStatus

public java.lang.String getServerStatus()

Gets the HTTP status message (if any) associated with the error on the server.

Returns:

the status message

getServerMessageCode

public java.lang.String getServerMessageCode()

Gets the error code (if any) specific to the error on the server.

Returns:

the error code

getServerMessage

public java.lang.String getServerMessage()

Gets the error message (if any) specific to the error on the server.

Returns:

the error message

getServerStackTrace

public java.lang.String getServerStackTrace()

Gets the stack trace (if any) specific to the error on the server.

Returns:

the server stack trace

getFailedRequest

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