org.apache.juneau.rest

Class RestServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.apache.juneau.rest.RestServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

Direct Known Subclasses:

BasicRestServlet

public abstract class RestServlet
extends javax.servlet.http.HttpServlet

Servlet implementation of a REST resource.

See Also:

• Overview > juneau-rest-server > RestServlet

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RestServlet()

Method Summary

Modifier and Type	Method and Description
void	destroy()
protected RestContext	getContext() Returns the read-only context object that contains all the configuration information about this resource.
RestContextProperties	getProperties() Convenience method for calling getContext().getProperties();
RestContextBuilder	getServletConfig()
void	init(javax.servlet.ServletConfig servletConfig)
void	log(Level level, String msg, Object... args) Convenience method for calling getContext().getLogger().log(level, msg, args);
void	log(Level level, Throwable cause, String msg, Object... args) Convenience method for calling getContext().getLogger().log(level, cause, msg, args);
void	log(String msg)
void	log(String msg, Throwable cause)
void	logObjects(Level level, String msg, Object... args) Convenience method for calling getContext().getLogger().logObjects(level, msg, args);
void	service(javax.servlet.http.HttpServletRequest r1, javax.servlet.http.HttpServletResponse r2) The main service method.

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service

Methods inherited from class javax.servlet.GenericServlet

getInitParameter, getInitParameterNames, getServletContext, getServletInfo, getServletName, init

Methods inherited from class java.lang.Object

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

Constructor Detail

RestServlet

public RestServlet()

Method Detail

init

public final void init(javax.servlet.ServletConfig servletConfig)
                throws javax.servlet.ServletException

Specified by:

init in interface javax.servlet.Servlet

Overrides:

init in class javax.servlet.GenericServlet

Throws:

javax.servlet.ServletException

getServletConfig

public RestContextBuilder getServletConfig()

Specified by:

getServletConfig in interface javax.servlet.Servlet

Overrides:

getServletConfig in class javax.servlet.GenericServlet

getContext

protected RestContext getContext()

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

This object is null during the call to init(ServletConfig) but is populated by the time GenericServlet.init() is called.

Resource classes that don't extend from RestServlet can add the following method to their class to get access to this context object:

public void init(RestServletContext context) throws Exception;

Returns:

The context information on this servlet.

service

public void service(javax.servlet.http.HttpServletRequest r1,
                    javax.servlet.http.HttpServletResponse r2)
             throws javax.servlet.ServletException,
                    IOException

The main service method.

Subclasses can optionally override this method if they want to tailor the behavior of requests.

Overrides:

service in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException

log

public void log(String msg)

Overrides:

log in class javax.servlet.GenericServlet

log

public void log(String msg,
                Throwable cause)

Overrides:

log in class javax.servlet.GenericServlet

log

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

Convenience method for calling getContext().getLogger().log(level, msg, args);

Parameters:

level - The log level.

msg - The message to log.

args - Optional MessageFormat-style arguments.

logObjects

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

Convenience method for calling getContext().getLogger().logObjects(level, msg, args);

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)

Convenience method for calling getContext().getLogger().log(level, cause, msg, args);

Parameters:

level - The log level.

cause - The cause.

msg - The message to log.

args - Optional MessageFormat-style arguments.

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Servlet

Overrides:

destroy in class javax.servlet.GenericServlet

getProperties

public RestContextProperties getProperties()

Convenience method for calling getContext().getProperties();

Returns:

The resource properties as an RestContextProperties.

See Also:

RestContext.getProperties()