com.rexsl.page

Class BaseResource

java.lang.Object

com.rexsl.page.BaseResource

All Implemented Interfaces:

Resource

@Loggable(value=1)
public class BaseResource
extends Object
implements Resource

Base implementation of Resource.

It is recommended to use this class as a base of all your JAX-RS resource classes and construct pages with PageBuilder, on top of BasePage, for example:

 @Path("/")
 public class MainRs extends BaseResource {
   @GET
   @Produces(MediaTypes.APPLICATION_XML)
   public BasePage front() {
     return new PageBuilder()
       .stylesheet("/xsl/front.xsl")
       .build(BasePage.class)
       .init(this)
       .append(new JaxbBundle("text", "Hello!"));
   }
 }

The class is mutable and NOT thread-safe.

Since:

0.3.7

Version:

$Id$

Author:

Yegor Bugayenko (yegor@tpc2.com)

See Also:

BasePage, PageBuilder

Nested Class Summary

Nested classes/interfaces inherited from interface com.rexsl.page.Resource

Resource.Forwarded

Constructor Summary

Constructors

Constructor and Description
BaseResource()

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.HttpHeaders	httpHeaders() All Http Headers.
javax.servlet.http.HttpServletRequest	httpServletRequest() Request just received.
javax.ws.rs.ext.Providers	providers() All registered JAX-RS providers.
javax.ws.rs.core.SecurityContext	securityContext() Security context.
javax.servlet.ServletContext	servletContext() Servlet context.
void	setHttpHeaders(javax.ws.rs.core.HttpHeaders headers) Set HttpHeaders.
void	setHttpServletRequest(javax.servlet.http.HttpServletRequest request) Set HttpServletRequest.
void	setProviders(javax.ws.rs.ext.Providers prov) Set Providers.
void	setSecurityContext(javax.ws.rs.core.SecurityContext context) Set Security Context.
void	setServletContext(javax.servlet.ServletContext context) Set Servlet Context.
void	setUriInfo(javax.ws.rs.core.UriInfo info) Set URI Info.
long	started() When this resource creation was started by JAX-RS implementation.
javax.ws.rs.core.UriInfo	uriInfo() Get URI Info.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseResource

public BaseResource()

Method Detail

started

public final long started()

Description copied from interface: Resource

When this resource creation was started by JAX-RS implementation.

Specified by:

started in interface Resource

Returns:

Time in milliseconds

providers

@NotNull
public final javax.ws.rs.ext.Providers providers()

Description copied from interface: Resource

All registered JAX-RS providers.

Specified by:

providers in interface Resource

Returns:

Providers

httpHeaders

@NotNull
public final javax.ws.rs.core.HttpHeaders httpHeaders()

Description copied from interface: Resource

All Http Headers.

Specified by:

httpHeaders in interface Resource

Returns:

Headers

uriInfo

@NotNull
public final javax.ws.rs.core.UriInfo uriInfo()

Description copied from interface: Resource

Get URI Info.

Specified by:

uriInfo in interface Resource

Returns:

URI info

httpServletRequest

@NotNull
public final javax.servlet.http.HttpServletRequest httpServletRequest()

Description copied from interface: Resource

Request just received.

Specified by:

httpServletRequest in interface Resource

Returns:

The request

securityContext

@NotNull
public final javax.ws.rs.core.SecurityContext securityContext()

Security context.

Specified by:

securityContext in interface Resource

Returns:

The context

Since:

0.4.7

servletContext

@NotNull
public final javax.servlet.ServletContext servletContext()

Servlet context.

Specified by:

servletContext in interface Resource

Returns:

The context

Since:

0.4.9

setUriInfo

@Context
public final void setUriInfo(@NotNull
                      javax.ws.rs.core.UriInfo info)

Set URI Info. Should be called by JAX-RS implementation because of @Context annotation.

Parameters:

info - The info to inject

setProviders

@Context
public final void setProviders(@NotNull
                        javax.ws.rs.ext.Providers prov)

Set Providers. Should be called by JAX-RS implementation because of @Context annotation.

Parameters:

prov - List of providers

setHttpHeaders

@Context
public final void setHttpHeaders(@NotNull
                          javax.ws.rs.core.HttpHeaders headers)

Set HttpHeaders. Should be called by JAX-RS implementation because of @Context annotation.

Parameters:

headers - List of headers

setHttpServletRequest

@Context
public final void setHttpServletRequest(@NotNull
                                 javax.servlet.http.HttpServletRequest request)

Set HttpServletRequest. Should be called by JAX-RS implementation because of @Context annotation.

Parameters:

request - The request

setSecurityContext

@Context
public final void setSecurityContext(@NotNull
                              javax.ws.rs.core.SecurityContext context)

Set Security Context. Should be called by JAX-RS implementation because of @Context annotation.

Parameters:

context - The security context

Since:

0.4.7

setServletContext

@Context
public final void setServletContext(@NotNull
                             javax.servlet.ServletContext context)

Set Servlet Context. Should be called by JAX-RS implementation because of @Context annotation.

Parameters:

context - The security context

Since:

0.4.9