Package org.apache.juneau.rest

Class RestOpSession

java.lang.Object

org.apache.juneau.ContextSession

org.apache.juneau.rest.RestOpSession

Direct Known Subclasses:

RrpcRestOpSession

public class RestOpSession
extends ContextSession

A session for a single HTTP request.

This session object gets created by RestSession once the Java method to be invoked has been determined.

Notes:

• This class is not thread safe.

See Also:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RestOpSession.Builder	Builder class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RestOpSession(RestOpSession.Builder builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
static RestOpSession.Builder	create(RestOpContext ctx, RestSession session)	Static creator.
RestOpSession	finish()	Called at the end of a call to finish any remaining tasks such as flushing buffers and logging the response.
BeanStore	getBeanStore()	Returns the bean store for this session.
RestOpContext	getContext()	Returns the context that created this session.
RestRequest	getRequest()	Returns the REST request object for this session.
RestResponse	getResponse()	Returns the REST response object for this session.
RestContext	getRestContext()	Returns the context of the parent class of this Java method.
RestSession	getRestSession()	Returns the session of the parent class of this Java method.
void	run()	Runs this session.
RestOpSession	status(StatusLine value)	Sets the status of the response.

Methods inherited from class org.apache.juneau.ContextSession

addWarning, checkForWarnings, getSessionProperties, getWarnings, isDebug, properties, toString

Methods inherited from class java.lang.Object

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

Constructor Details

RestOpSession

protected RestOpSession(RestOpSession.Builder builder)

Constructor.

Parameters:

builder - The builder for this object.

Method Details

create

public static RestOpSession.Builder create(RestOpContext ctx,
 RestSession session)

Static creator.

Parameters:

ctx - The context object of the Java method being invoked.

session - The REST session object creating this object.

Returns:

A new builder.

getContext

public RestOpContext getContext()

Description copied from class: ContextSession

Returns the context that created this session.

Overrides:

getContext in class ContextSession

Returns:

The context that created this session.

run

public void run()
         throws Throwable

Runs this session.

Does the following:

1. Runs the guards on the method.
2. Finds the parameter values to pass to the Java method.
3. Invokes the Java method.
4. Sets the output and status on the response.
5. Calls the converters on the Java method.

Throws:

Throwable - Any throwable can be thrown.

getRequest

public RestRequest getRequest()

Returns the REST request object for this session.

Returns:

The REST request object for this session.

getResponse

public RestResponse getResponse()

Returns the REST response object for this session.

Returns:

The REST response object for this session.

getBeanStore

public BeanStore getBeanStore()

Returns the bean store for this session.

Returns:

The bean store for this session.

getRestContext

public RestContext getRestContext()

Returns the context of the parent class of this Java method.

Returns:

The context of the parent class of this Java method.

getRestSession

public RestSession getRestSession()

Returns the session of the parent class of this Java method.

Returns:

The session of the parent class of this Java method.

status

public RestOpSession status(StatusLine value)

Sets the status of the response.

Parameters:

value - The new status.

Returns:

This object.

finish

public RestOpSession finish()

Called at the end of a call to finish any remaining tasks such as flushing buffers and logging the response.

Returns:

This object.