Some cleanup for the PortletDataProvider code

git-svn-id: https://svn.libreccm.org/ccm/trunk@2588 8810af33-2d31-482b-a856-94f89814c4df
master
jensp 2014-03-27 19:23:18 +00:00
parent 8e1bb1c395
commit 0061cbec18
1 changed files with 68 additions and 17 deletions

View File

@ -26,6 +26,7 @@ import com.arsdigita.cms.CMS;
import com.arsdigita.cms.ContentItem;
import com.arsdigita.cms.dispatcher.SimpleXMLGenerator;
import com.arsdigita.domain.DataObjectNotFoundException;
import com.arsdigita.persistence.OID;
import com.arsdigita.templating.PresentationManager;
import com.arsdigita.templating.Templating;
import com.arsdigita.web.Application;
@ -39,7 +40,8 @@ import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
/**
*
* Servlet for the PortletDataProvider application.
*
* @author Jens Pelzetter <jens@jp-digital.de>
* @version $Id$
*/
@ -50,12 +52,23 @@ public class PortletDataProviderServlet extends BaseApplicationServlet {
private static final String ITEMS = "items";
private static final String CATEGORIES = "categories";
/**
* This method is the entry point to the logic of this class. The method analyses the
* path (from {@link HttpServletRequest#getPathInfo()}) and delegates to the responsible
* method of this class.
*
* @param request
* @param response
* @param app
* @throws ServletException
* @throws IOException
*/
@Override
protected void doService(final HttpServletRequest request,
final HttpServletResponse response,
final Application app) throws ServletException, IOException {
String path = request.getPathInfo();
if (path.startsWith("/")) {
if (path.charAt(0) == '/') {
path = path.substring(1);
}
final String[] pathTokens = path.split("/");
@ -65,6 +78,7 @@ public class PortletDataProviderServlet extends BaseApplicationServlet {
return;
}
//Check the first token of the path and delegate the clal
if (ITEMS.equals(pathTokens[0])) {
serveContentItem(pathTokens, request, response);
} else if (CATEGORIES.equals(pathTokens[0])) {
@ -74,23 +88,25 @@ public class PortletDataProviderServlet extends BaseApplicationServlet {
}
}
/**
* Serves an HTML fragment showing the detail view of a specific content item.
* Will create a BAD_REQUEST HTTP error if the provided ID/OID is invalid and a
* NOT_FOUND HTTP error if no content item with the provided ID/OID is found.
*
* @param pathTokens The tokens of the path
* @param request
* @param response
* @throws IOException
* @throws ServletException
*/
protected void serveContentItem(final String[] pathTokens,
final HttpServletRequest request,
final HttpServletResponse response) throws IOException,
ServletException {
final String itemIdString = pathTokens[1];
final BigDecimal itemId;
try {
itemId = new BigDecimal(itemIdString);
} catch (NumberFormatException ex) {
response.sendError(HttpServletResponse.SC_BAD_REQUEST,
String.format("'%s' is not a valid item id", itemIdString));
return;
}
//Retrieve the content item and ensure that we work with the live version of the item.
ContentItem item = null;
try {
final ContentItem tmpItem = new ContentItem(itemId);
final ContentItem tmpItem = retrieveContentItem(pathTokens[1]);
if (tmpItem.isLiveVersion()) {
item = tmpItem;
} else {
@ -99,33 +115,68 @@ public class PortletDataProviderServlet extends BaseApplicationServlet {
} else {
response.sendError(HttpServletResponse.SC_NOT_FOUND,
String.format("Item with ID %d is not published.",
itemIdString));
pathTokens[1]));
}
}
} catch (DataObjectNotFoundException ex) {
//No item with the provided ID/OID found, respond with NOT_FOUND (404).
response.sendError(HttpServletResponse.SC_NOT_FOUND,
String.format("Item with ID %d not found.", itemIdString));
String.format("Item with ID/PID %d not found.", pathTokens[1]));
return;
} catch (NumberFormatException ex) {
//The provided ID was not a number, respond with bad request error.
response.sendError(HttpServletResponse.SC_BAD_REQUEST,
String.format("'%s' is not a valid item id", pathTokens[1]));
return;
} catch(IllegalArgumentException ex) {
//The provided OID is was invalid, respond with bad request error.
response.sendError(HttpServletResponse.SC_BAD_REQUEST,
String.format("'%s' is not a valid item OID", pathTokens[1]));
return;
}
//Create the XML output
final Page page = PageFactory.buildPage(
"PortletDataProvider",
String.format("ContentItem %s", item.getOID().toString()));
final PortletDataItemPanel panel = new PortletDataItemPanel(item);
page.add(panel);
page.lock();
//Delegate to theming enging
final Document document = page.buildDocument(request, response);
final PresentationManager presenter = Templating.getPresentationManager();
presenter.servePage(document, request, response);
}
/**
* Helper method encapsulating the logic for retrieving a content item.
* If the first character of the provided item id is a digit the
* method assumes that the numeric ID of the item was provided. Otherwise
* the method assumes that the OID of the item to serve was provided.
*
* @param itemId
* @return
*/
private ContentItem retrieveContentItem(final String itemId) {
if (Character.isDigit(itemId.charAt(0))) {
return new ContentItem(new BigDecimal(itemId));
} else {
return new ContentItem(OID.valueOf(itemId));
}
}
/**
* Special component to make it possible to use special XSL for the
* data served by the PortletDataProvider
*
*/
private class PortletDataItemPanel extends SimpleComponent {
private final XMLGenerator xmlGenerator;
public PortletDataItemPanel(final ContentItem item) {
super();
this.xmlGenerator = new XMLGenerator(item);
}