com.rexsl.page

Class BasePage<T extends BasePage<?,?>,R extends Resource>

java.lang.Object

com.rexsl.page.BasePage<T,R>

Type Parameters:

T - Type of page

R - Type of JAX-RS resource

@Loggable(value=1)
public class BasePage<T extends BasePage<?,?>,R extends Resource>
extends Object

Base page.

Use it as a base class for your own page, for example:

 public class MyBasePage extends BasePage<MyPage> {
   @XmlAnyElement(lax = true)
   @XmlElement
   public String getUser() {
     return "John Doe";
   }
 }

However, it is recommended to use append(Object) and JaxbGroup/JaxbBundle instead of defining own methods annotated with @XmlElement.

Don't forget to call init(Resource) right after the page is built by PageBuilder, 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);
   }
 }

JAX-RS resource classes should implement Resource or even extend BaseResource, which is preferred.

This class adds date and ip attributes to the page, and links and millis element. Thus, an empty page (if you don't append(Object) anything to it) will look like:

 <?xml version="1.0" ?>
 <page date="2012-04-15T07:07Z" ip="127.0.0.1">
   <links />
   <millis>234</millis>
 </page>

This functionality is not changeable. If this is not what you need in your page - just don't use this class and create your own. However, we believe that the majority of web applications need this information in their XML pages.

The class is mutable and thread-safe.

Since:

0.3.7

Version:

$Id$

Author:

Yegor Bugayenko (yegor@tpc2.com)

See Also:

PageBuilder, Resource, BaseResource

Constructor Summary

Constructors

Constructor and Description
BasePage()

Method Summary

Methods

Modifier and Type	Method and Description
T	append(Element element) Append new DOM element.
T	append(JaxbBundle bundle) Add new element.
T	append(Object element) Append new element.
Date	getDate() Get date and time when this page is generated.
Collection<Object>	getElements() Get all elements.
String	getIp() Get IP address of the server.
Collection<Link>	getLinks() List of links.
long	getMillis() Get page generation time, in milliseconds.
R	home() Get home.
T	init(R res) Init it with Resource.
boolean	isSsl() Get SSL or non-SSL flag.
T	link(Link link) Add new HATEOAS link.
javax.ws.rs.core.Response.ResponseBuilder	render() Render it.

Methods inherited from class java.lang.Object

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

Constructor Detail

BasePage

public BasePage()

Method Detail

init

@NotNull
public final T init(@NotNull
             R res)

Init it with Resource.

Parameters:

res - The resource

Returns:

This object

render

@NotNull
public final javax.ws.rs.core.Response.ResponseBuilder render()

Render it.

Returns:

JAX-RS response

append

@NotNull
public final T append(@NotNull
               Object element)

Append new element.

Parameters:

element - The element to append

Returns:

This object

append

@NotNull
public final T append(@NotNull
               Element element)

Append new DOM element.

Parameters:

element - The element to append

Returns:

This object

append

@NotNull
public final T append(@NotNull
               JaxbBundle bundle)

Add new element.

Parameters:

bundle - The element

Returns:

This object

home

@NotNull
public final R home()

Get home.

Returns:

The home resource

link

@NotNull
public final T link(@NotNull
             Link link)

Add new HATEOAS link.

Parameters:

link - The link to add

Returns:

This object

getElements

@NotNull
public final Collection<Object> getElements()

Get all elements.

Returns:

Full list of injected elements

getLinks

public final Collection<Link> getLinks()

List of links.

Returns:

List of links.

getIp

@NotNull
public final String getIp()

Get IP address of the server.

Returns:

The IP address

getDate

@NotNull
public final Date getDate()

Get date and time when this page is generated.

Returns:

The date

isSsl

public final boolean isSsl()

Get SSL or non-SSL flag.

Returns:

The flag

getMillis

public final long getMillis()

Get page generation time, in milliseconds.

Returns:

Page generation time