org.apache.juneau.rest

Class BasicRest

java.lang.Object

org.apache.juneau.rest.BasicRest

All Implemented Interfaces:

BasicRestConfig

Direct Known Subclasses:

BasicRestGroup, RequestEchoResource

@Rest(allowedMethodParams="OPTIONS")
 @HtmlDocConfig(navlinks={"up: request:/..","options: servlet:/?method=OPTIONS"})
public abstract class BasicRest
extends Object
implements BasicRestConfig

Identical to BasicRestServlet but doesn't extend from HttpServlet.

• Overview > juneau-rest-server > Instantiation > BasicRest

Constructor Summary

Constructors

Constructor and Description
BasicRest()

Method Summary

Modifier and Type	Method and Description
protected RestContext	getContext() Returns the read-only context object that contains all the configuration information about this resource.
Swagger	getOptions(RestRequest req) [OPTIONS /*] - Show resource options.
RestRequest	getRequest() Returns the current HTTP request.
RestResponse	getResponse() Returns the current 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.
void	log(String msg) Log a message.
void	log(String msg, Throwable cause) Log a message.
void	logObjects(Level level, String msg, Object... args) Log a message.
void	onPostInit(RestContext context) Post-initialization hook to retrieve the RestContext object for this resource.

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicRest

public BasicRest()

Method Detail

onPostInit

@RestHook(value=POST_INIT)
public void onPostInit(RestContext context)

Post-initialization hook to retrieve the RestContext object for this resource.

Parameters:

context - The context for this resource.

getOptions

public Swagger getOptions(RestRequest req)

[OPTIONS /*] - Show resource options.

Specified by:

getOptions in interface BasicRestConfig

Parameters:

req - The HTTP request.

Returns:

A bean containing the contents for the OPTIONS page.

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(String msg)

Log a message.

Parameters:

msg - The message to log.

log

public void log(String msg,
                Throwable cause)

Log a message.

Parameters:

msg - The message to log.

cause - The cause.

log

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

Log a message.

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)

Log a message.

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.

Parameters:

level - The log level.

cause - The cause.

msg - The message to log.

args - Optional MessageFormat-style arguments.

getRequest

public RestRequest getRequest()

Returns the current HTTP request.

Returns:

The current HTTP request.

getResponse

public RestResponse getResponse()

Returns the current HTTP response.

Returns:

The current HTTP response