Package org.apache.juneau.rest.server

Class RestOperations

java.lang.Object

org.apache.juneau.rest.server.RestOperations

Direct Known Subclasses:

RestOperations.Void

public class RestOperations
extends Object

Encapsulates the set of RestOp-annotated methods within a single Rest-annotated object.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RestOperations.Builder	Builder class.
final class	RestOperations.Void	Represents a null value for the RestOperations class.

Constructor Summary

Constructors

Constructor	Description
RestOperations(RestOperations.Builder builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	allowedMethods(RestSession session)	Returns the value of the Allow header for a 405 Method Not Allowed response to the specified call.
static RestOperations.Builder	create(BeanStore beanStore)	Static creator.
RestOpContext	findOperation(RestSession session)	Finds the method that should handle the specified call.
List<RestOpContext>	getOpContexts()	Returns the list of method contexts in this object.

Methods inherited from class java.lang.Object

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

Constructor Details

RestOperations

public RestOperations(RestOperations.Builder builder)

Constructor.

Parameters:

builder - The builder containing the settings for this object. Must not be null.

Method Details

create

public static RestOperations.Builder create(BeanStore beanStore)

Static creator.

Parameters:

beanStore - The bean store to use for creating beans.

Returns:

A new builder for this object.

findOperation

public RestOpContext findOperation(RestSession session)
                            throws MethodNotAllowed,
PreconditionFailed,
NotFound

Finds the method that should handle the specified call.

Parameters:

session - The HTTP call. Must not be null.

Returns:

The method that should handle the specified call.

Throws:

MethodNotAllowed - If no methods implement the requested HTTP method.

PreconditionFailed - At least one method was found but it didn't match one or more matchers.

NotFound - HTTP method match was found but matching path was not.

allowedMethods

public String allowedMethods(RestSession session)

Returns the value of the Allow header for a 405 Method Not Allowed response to the specified call.

The methods this resource answers on the call's path: every key of the operation table, other than "*", with at least one operation whose path pattern matches, plus the request-line method when a "*" operation's path matches (the un-overridden request is always accepted there). The keys are what dispatch looks up, so a remote-proxy operation contributes GET and POST, never RRPC.

Only path patterns are tested. Matchers are not run and the session's cached path match is not touched, so the call can be made for any request without disturbing the operation that handles it.

Parameters:

session - The HTTP call. Must not be null.

Returns:

The sorted, comma-separated method names. Empty when nothing answers on the path. Never null.

Since:

10.0.0

getOpContexts

public List<RestOpContext> getOpContexts()

Returns the list of method contexts in this object.

Returns:

An unmodifiable list of method contexts in this object.