dk.heick.properties.web.servlet

Class AbstractPropertyCollectionHandlingServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

dk.heick.properties.web.servlet.AbstractPropertyCollectionHandlingServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public abstract class AbstractPropertyCollectionHandlingServlet
extends javax.servlet.http.HttpServlet

This is the abstract implementation of PropertyCollectionHandlingServlet, you MUST implement a PropertyCollectionHandlingServlet in your war file.
This is the servlet which ALL the PropertyRenderers refeere to.

Since:

1.1

Author:

Frederik Heick

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	MESSAGE String post appended to a property name to return a Property specific message.

Constructor Summary

Constructors

Constructor and Description
AbstractPropertyCollectionHandlingServlet() Constructor

Method Summary

Modifier and Type	Method and Description
protected void	doPost(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
static String	getCollectionMessage(javax.servlet.http.HttpServletRequest request) Gets the WebName.COLLECTION_MESSAGE from the the request.
abstract dk.heick.properties.PropertyCollection	getPropertyCollection() Returns the PropertyCollection initialized in a WebContext .
static String	getPropertyHandlingMessage(javax.servlet.http.HttpServletRequest request, dk.heick.properties.Property<?> property) Gets a message set for an individual Property.
abstract String	getPropertyIndexURL(String contextPath) The page url for the page which displays your properties.
String	getReferer(javax.servlet.http.HttpServletRequest request) Get the page where the request originated from, otherwise "PropertyIndexURL" is used.

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPut, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, init, log, log

Methods inherited from class java.lang.Object

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

Field Detail

MESSAGE

public static final String MESSAGE

String post appended to a property name to return a Property specific message.

See Also:

Constant Field Values

Constructor Detail

AbstractPropertyCollectionHandlingServlet

public AbstractPropertyCollectionHandlingServlet()

Constructor

Method Detail

getPropertyCollection

public abstract dk.heick.properties.PropertyCollection getPropertyCollection()

Returns the PropertyCollection initialized in a WebContext .

Returns:

the PropertyCollection for your application.

getPropertyIndexURL

public abstract String getPropertyIndexURL(String contextPath)

The page url for the page which displays your properties. The servlet will redirect to this page when a change is made for a property.

Parameters:

contextPath - the contextPath from the HttpServletRequest.

Returns:

the url for the properties display page, where to go back to after an action has been performed.

doPost

protected void doPost(javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response)
               throws javax.servlet.ServletException,
                      IOException

Overrides:

doPost in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException

getReferer

public String getReferer(javax.servlet.http.HttpServletRequest request)

Get the page where the request originated from, otherwise "PropertyIndexURL" is used.

Parameters:

request - the httpServletRequest

Returns:

the last requested page url, otherwise "PropertyIndexURL" is returned.

getCollectionMessage

public static String getCollectionMessage(javax.servlet.http.HttpServletRequest request)

Gets the WebName.COLLECTION_MESSAGE from the the request.

Parameters:

request - the HttpServletRequest

Returns:

the value of the parameter "WebName.COLLECTION_MESSAGE".

See Also:

WebName.COLLECTION_MESSAGE

getPropertyHandlingMessage

public static String getPropertyHandlingMessage(javax.servlet.http.HttpServletRequest request,
                                                dk.heick.properties.Property<?> property)

Gets a message set for an individual Property.

Parameters:

request - the HttpServletRequest

property - the Property

Returns:

the message set for the Property, if none, "Ok" is returned.