org.shredzone.cilla.view

Class AbstractView

java.lang.Object

org.shredzone.cilla.view.AbstractView

Direct Known Subclasses:

FeedView, GalleryView, HeaderView, MediaView, PageListView, PageView, ResourceView, SearchView, SecurityView

@Component
public abstract class AbstractView
extends Object

An abstract view superclass that offers common methods.

Author:

Richard "Shred" Körber

Constructor Summary

Constructors

Constructor and Description
AbstractView()

Method Summary

Modifier and Type	Method and Description
protected void	addHeadersIfRestricted(Page page, HttpServletRequest req, HttpServletResponse resp) If the page is restricted and unlocked, send headers so public caches won't cache the page, but private caches (user-agent) do.
protected boolean	handleRestricted(Page page, HttpServletRequest req) Handles page restrictions.
protected boolean	isNotModifiedSince(HttpServletRequest req, Date date) Checks that the request sent an "If-Modified-Since" header, and the date matches the given date.
protected boolean	redirectRestricted(Page page, HttpServletRequest req, HttpServletResponse resp) Redirect to the section's page main view when the page is restricted and has not been unlocked yet.
protected void	streamDataSource(ResourceDataSource ds, HttpServletRequest req, HttpServletResponse resp) Streams a ResourceDataSource.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractView

public AbstractView()

Method Detail

handleRestricted

protected boolean handleRestricted(Page page,
                                   HttpServletRequest req)

Handles page restrictions.

Parameters:

page - Page to check for restrictions

req - HttpServletRequest

Returns:

if true, the page is restricted and needs to be unlocked. If false, the page either not restricted, or restricted and unlocked.

addHeadersIfRestricted

protected void addHeadersIfRestricted(Page page,
                                      HttpServletRequest req,
                                      HttpServletResponse resp)

If the page is restricted and unlocked, send headers so public caches won't cache the page, but private caches (user-agent) do.

Parameters:

page - Page to check

req - HttpServletRequest request to be checked

resp - HttpServletResponse response to add headers to

redirectRestricted

protected boolean redirectRestricted(Page page,
                                     HttpServletRequest req,
                                     HttpServletResponse resp)
                              throws org.shredzone.commons.view.exception.ViewException

Redirect to the section's page main view when the page is restricted and has not been unlocked yet. If a view of a locked page has been invoked, the visitor will be redirected to the page where the unlock question is asked.

Parameters:

page - Page that is to be shown

req - HttpServletRequest

resp - HttpServletResponse

Returns:

if true, the page access is restricted and must not be shown to the user. A redirection to the main page has already been placed.

Throws:

org.shredzone.commons.view.exception.ViewException

isNotModifiedSince

protected boolean isNotModifiedSince(HttpServletRequest req,
                                     Date date)

Checks that the request sent an "If-Modified-Since" header, and the date matches the given date.

Parameters:

req - HttpServletRequest to use

date - Date to check

Returns:

true: Resource has not changed since it was last delivered

streamDataSource

protected void streamDataSource(ResourceDataSource ds,
                                HttpServletRequest req,
                                HttpServletResponse resp)
                         throws org.shredzone.commons.view.exception.ViewException

Streams a ResourceDataSource. Also cares about setting proper HTTP response headers.

Parameters:

ds - ResourceDataSource to stream

req - HttpServletRequest

resp - HttpServletResponse

Throws:

org.shredzone.commons.view.exception.ViewException