Package org.apache.juneau.rest.servlet

Class RestObject

java.lang.Object

org.apache.juneau.rest.servlet.RestObject

Direct Known Subclasses:

BasicRestObject

public abstract class RestObject
extends Object

Identical to RestServlet but doesn't extend from HttpServlet.

This is particularly useful in Spring Boot environments that auto-detect servlets to deploy in servlet containers, but you want this resource to be deployed as a child instead.

See Also:

• @Rest-Annotated Class Basics

Constructor Summary

Constructors

Constructor	Description
RestObject()

Method Summary

Modifier and Type	Method	Description
protected void	doLog(Level level, Throwable cause, Supplier<String> msg)	Main logger method.
protected RestContext	getContext()	Returns the read-only context object that contains all the configuration information about this resource.
RestRequest	getRequest()	Returns the current thread-local HTTP request.
RestResponse	getResponse()	Returns the current thread-local HTTP response.
void	log(Level level, String msg, Object... args)	Log a message.
void	log(Level level, Throwable cause, String msg, Object... args)	Log a message.
protected void	setContext(RestContext context)	Sets the context object for this servlet.

Methods inherited from class java.lang.Object

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

Constructor Details

RestObject

public RestObject()

Method Details

setContext

protected void setContext(RestContext context)
                   throws jakarta.servlet.ServletException

Sets the context object for this servlet.

Parameters:

context - Sets the context object on this servlet.

Throws:

jakarta.servlet.ServletException - If error occurred during post-initialiation.

getContext

protected RestContext getContext()

Returns the read-only context object that contains all the configuration information about this resource.

Returns:

The context information on this servlet.

log

public void log(Level level,
 String msg,
 Object... args)

Log a message.

Subclasses can intercept the handling of these messages by overriding doLog(Level, Throwable, Supplier).

Parameters:

level - The log level.

msg - The message to log.

args - Optional MessageFormat-style arguments.

log

public void log(Level level,
 Throwable cause,
 String msg,
 Object... args)

Log a message.

Subclasses can intercept the handling of these messages by overriding doLog(Level, Throwable, Supplier).

Parameters:

level - The log level.

cause - The cause.

msg - The message to log.

args - Optional MessageFormat-style arguments.

doLog

protected void doLog(Level level,
 Throwable cause,
 Supplier<String> msg)

Main logger method.

The default behavior logs a message to the Java logger of the class name.

Subclasses can override this method to implement their own logger handling.

Parameters:

level - The log level.

cause - Optional throwable.

msg - The message to log.

getRequest

public RestRequest getRequest()

Returns the current thread-local HTTP request.

Returns:

The current thread-local HTTP request, or null if it wasn't created.

getResponse

public RestResponse getResponse()

Returns the current thread-local HTTP response.

Returns:

The current thread-local HTTP response, or null if it wasn't created.