com.endeca.infront.assembler.servlet

Class AbstractPreviewLinkServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

com.endeca.infront.assembler.servlet.AbstractPreviewLinkServlet

All Implemented Interfaces:

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

Direct Known Subclasses:

SpringPreviewLinkServlet

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

Link service for Workbench Preview functionality. This service constructs a link to the page that is being previewed; it is also used for auditing content items.

This is the input to the service, as specified by request parameters:

• __jsonp: JSONP callback name (required).
• __contentUri: content URI path, for instance, "/browse/pages" (required). Note that page names are double encoded so that the value returned from ServletRequest.getParameter(String) is single encoded.
• __link: navigation state, for instance, "N=101012" or "Ntt=canon" (optional). Note that the "N" or "Ntt" values are double encoded so that the value returned from ServletRequest.getParameter(String) is single encoded.

The expected output from the service is a JSONP callback with data {action: "link"}, where "link" represents the encoded URL action string.

As an example, suppose that the user triggers preview on a content item contained within a page named "browse%" (note that "%25" is the encoded value of the character '%').

• The request query string would look like __contentUri=%2Fpages%2Fbrowse%2525&__link=N%3D101012&__jsonp=Ext.data.JsonP.callback3&_dc=1338310267465.
• The service would return an object via JSONP with data {action: "/browse%25/_/N-25xw"}.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractPreviewLinkServlet()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Creates and returns a link to the page specified using request parameters.
protected abstract ContentSource	getContentSource() A method to retrieve a ContentSource to use for creating links.
protected abstract NavigationStateBuilder	getNavigationStateBuilder() A method to retrieve a NavigationStateBuilder to use for creating links.
protected String	getSiteIdParamForAction(NavigationAction action) Returns the site id parameter and parameter value to append to the preview URL.
protected abstract SiteManager	getSiteManager() A method to retrieve a SiteManager to use for creating links.
protected String	getUrlForAction(NavigationAction action) Constructs and returns a URL representing the given NavigationAction.

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPost, 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

Constructor Detail

AbstractPreviewLinkServlet

public AbstractPreviewLinkServlet()

Method Detail

doGet

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

Creates and returns a link to the page specified using request parameters. See AbstractPreviewLinkServlet.

Overrides:

doGet in class javax.servlet.http.HttpServlet

Parameters:

request - The request the client has made of the servlet

response - The response the servlet sends to the client

Throws:

IOException - If an input or output error is detected when the servlet handles the GET request

javax.servlet.ServletException - If the GET request could not be handled

getNavigationStateBuilder

protected abstract NavigationStateBuilder getNavigationStateBuilder()

A method to retrieve a NavigationStateBuilder to use for creating links. Subclasses must override this method to provide a specific means of acquiring the state builder.

Returns:

the NavigationStateBuilder

getContentSource

protected abstract ContentSource getContentSource()

A method to retrieve a ContentSource to use for creating links. Subclasses must override this method to provide a specific means of acquiring the content source.

Returns:

the ContentSource

getSiteManager

protected abstract SiteManager getSiteManager()

A method to retrieve a SiteManager to use for creating links. Subclasses must override this method to provide a specific means of acquiring the site manager.

Returns:

the SiteManager

getUrlForAction

protected String getUrlForAction(NavigationAction action)
                          throws javax.servlet.ServletException

Constructs and returns a URL representing the given NavigationAction. The default implementation simply concatenates Action.getContentPath() and NavigationAction.getNavigationState() and appends a 'siteId' parameter with the site of the page we are previewing Applications with more complicated ways of constructing URLs can extend this method to provide their own implementation.

Parameters:

action - The input action

Returns:

The output URL

Throws:

javax.servlet.ServletException

getSiteIdParamForAction

protected String getSiteIdParamForAction(NavigationAction action)
                                  throws javax.servlet.ServletException

Returns the site id parameter and parameter value to append to the preview URL.

Parameters:

action - The input action

Returns:

The output URL

Throws:

javax.servlet.ServletException