Package com.peterphi.std.guice.web.rest.jaxrs.exception

Class XMLFailureRenderer

java.lang.Object

com.peterphi.std.guice.web.rest.jaxrs.exception.XMLFailureRenderer

All Implemented Interfaces:

RestFailureRenderer

Direct Known Subclasses:

CustomTemplateFailureRenderer, HTMLFailureRenderer

public class XMLFailureRenderer
extends Object
implements RestFailureRenderer

A simple renderer that renders an XML form of the RestFailure object by letting the JAX-RS implementation serialise it
Sets the X-Rich-Exception flag so that our code can understand and intelligently reconstruct an exception client-side

Field Summary

Fields

Modifier and Type	Field	Description
boolean	includeStackTrace
boolean	stackTraceRequiresLoggedIn
boolean	stackTraceWhenLoggedInRequiresAdminOrService

Constructor Summary

Constructors

Constructor	Description
XMLFailureRenderer()

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	render(RestFailure failure)	Allows user-defined code to present the exception in a more user-friendly manner

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.peterphi.std.guice.web.rest.jaxrs.exception.RestFailureRenderer

shouldSuppressLog

Field Details

includeStackTrace

@Inject(optional=true)
public boolean includeStackTrace

stackTraceRequiresLoggedIn

@Inject(optional=true)
public boolean stackTraceRequiresLoggedIn

stackTraceWhenLoggedInRequiresAdminOrService

@Inject(optional=true)
public boolean stackTraceWhenLoggedInRequiresAdminOrService

Constructor Details

XMLFailureRenderer

public XMLFailureRenderer()

Method Details

render

public javax.ws.rs.core.Response render(RestFailure failure)

Description copied from interface: RestFailureRenderer

Allows user-defined code to present the exception in a more user-friendly manner

Specified by:

render in interface RestFailureRenderer

Returns:

a non-null Response if desired - otherwise (or if this method throws) the default exeption renderer will be used