com.rexsl.page

Interface Inset

All Known Implementing Classes:

AuthInset, FlashInset, LinksInset, VersionInset

public interface Inset

Insertion into a page.

Post-rendering strategy applied to a BasePage and Response.Builder. You can define your own insets as anonymous classes, for example:

 @Inset.Default({ LinksInset.class, FlashInset.class })
 public class BaseRs extends BaseResource {
   @Inset.Runtime
   public Inset ver() {
     return new VersionInset("1.0", "", "13-Mar-2013");
   }
   @Inset.Runtime
   public Inset supplementary() {
     return new Inset() {
       @Override
       public void render(final BasePage<?, ?> page,
         final Response.ResponseBuilder builder) {
         builder.type(MediaType.TEXT_XML);
         builder.header(HttpHeaders.VARY, "Cookie");
     }
   };
 }

For every new page methods version() and supplementary() will be called. Returned insets will be used to help in page rendering. Their render(BasePage,Response.ResponseBuilder) methods will be used to extend the JAXB page and the JAX-RS response.

Since:

0.4.8

Version:

$Id$

Author:

Yegor Bugayenko (yegor@tpc2.com)

See Also:

BasePage

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Inset.Default Annotates a JAX-RS resource, informing the rendering mechanism about all Inset classes required for page rendering.
static interface	Inset.Runtime Annotates a method of JAX-RS resource that returns an instance of Inset.

Method Summary

Methods

Modifier and Type	Method and Description
void	render(BasePage<?,?> page, javax.ws.rs.core.Response.ResponseBuilder builder) Render it into the response builder.

Method Detail

render

void render(BasePage<?,?> page,
          javax.ws.rs.core.Response.ResponseBuilder builder)

Render it into the response builder.

Parameters:

page - The page to render

builder - The builder