com.raritantechnologies.quickstart.taglibrary.request
Class BackLinkRequestFormatter

java.lang.Object
  com.raritantechnologies.quickstart.taglibrary.request.BackLinkRequestFormatter

All Implemented Interfaces:

IConfigurable, IRequestFormatter

public class BackLinkRequestFormatter

extends java.lang.Object

implements IRequestFormatter

Creates a back link by copying the http requests to cache. When triggered by a "mark" event in the HTTP request, creates a link using the current URL and copies the url to CACHE.

XML Configuration Template:

  <RequestFormatter class="com.raritantechnologies.quickstart.taglibrary.request.BackLinkRequestFormatter"
                       action="[ action page for link ]"
                       target="[ target of back link ]"
                       setLinkParam="[ name of request param that triggers back link ]"
                       setLinkValue="[ value of request param that triggers back link ]"
                       clearLinkParam="[ name of request param that clears back link, initiaties caching ]"
                       clearLinkValue="[ value of request param that clears back link, initiates caching ]"
                       cacheKey="[ key to use to cache back link urls ]"
                       linkMessage="[ message to display on back link ]"
                       cssClass="[ css class for hyperlink ]"
                       useCurrentParams="[ true(default)|false ]"
                       sessionDataParams="[ list of sessionData params to add to cached link ]" >

    <!-- One or more fixed parameters -->
    <Param ID="[ name of parameter ]" value="[ value of parameter ]" />

  </RequestFormatter>
 

Developed by Raritan Technologies Inc..

Author:

Ted Sullivan

Constructor Summary

BackLinkRequestFormatter()

Method Summary

java.lang.String	formatSearchRequest(RaritanPageContext pageContext) Reformat the http request as a String.
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.

Methods inherited from class java.lang.Object

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

Constructor Detail

BackLinkRequestFormatter

public BackLinkRequestFormatter()

Method Detail

initialize

public void initialize(org.w3c.dom.Element elem)

Description copied from interface: IConfigurable

Initializes the object from an XML tag or element. This method is called by the Framework as part of the application initializtion. see ConfigurationManager, XMLConfigurationManager, XMLSearchFieldMapFactory, XMLSearchSourceFactory. Configurable objects that are owned or contained by other configurable objects will be initialized in by the parent object.

Specified by:

initialize in interface IRequestFormatter

formatSearchRequest

public java.lang.String formatSearchRequest(RaritanPageContext pageContext)

Description copied from interface: IRequestFormatter

Reformat the http request as a String.

Specified by:

formatSearchRequest in interface IRequestFormatter