com.semanticcms.core.servlet.Element Maven / Gradle / Ivy
/*
* semanticcms-core-servlet - Java API for modeling web page content and relationships in a Servlet environment.
* Copyright (C) 2013, 2014, 2015, 2016 AO Industries, Inc.
* [email protected]
* 7262 Bull Pen Cir
* Mobile, AL 36695
*
* This file is part of semanticcms-core-servlet.
*
* semanticcms-core-servlet is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* semanticcms-core-servlet is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with semanticcms-core-servlet. If not, see implements ElementWriter {
private final ServletContext servletContext;
private final HttpServletRequest request;
private final HttpServletResponse response;
protected final E element;
protected Element(
ServletContext servletContext,
HttpServletRequest request,
HttpServletResponse response,
E element
) {
this.servletContext = servletContext;
this.request = request;
this.response = response;
this.element = element;
}
public Element id(String id) {
this.element.setId(id);
return this;
}
public static interface Body {
void doBody(HttpServletRequest req, HttpServletResponse resp, E element) throws ServletException, IOException, SkipPageException;
}
/**
*
* Adds this element to the current page, if part of a page.
* Sets this element as the current element.
* Then, if not capturing or capturing META or higher, calls {@link #doBody}
*
*
* Also establishes a new {@link PageContext}.
*
*
* @see PageContext
*/
public void invoke(Body body) throws ServletException, IOException, SkipPageException {
// Get the current capture state
CaptureLevel captureLevel = CaptureLevel.getCaptureLevel(request);
if(captureLevel.compareTo(CaptureLevel.META) >= 0) {
// Set currentNode
Node parentNode = CurrentNode.getCurrentNode(request);
CurrentNode.setCurrentNode(request, element);
try {
// Find the optional parent page
Page currentPage = CurrentPage.getCurrentPage(request);
if(currentPage != null) currentPage.addElement(element);
Long elementKey;
if(parentNode != null) elementKey = parentNode.addChildElement(element, this);
else elementKey = null;
// Freeze element once body done
try {
doBody(request, response, captureLevel, body);
} finally {
// Note: Page freezes all of its elements after setting missing ids
if(currentPage == null || element.getId() != null) {
element.freeze();
}
}
PrintWriter out = response.getWriter();
if(elementKey == null) {
// Write now
writeTo(out, new ServletElementContext(servletContext, request, response));
} else {
// Write an element marker instead
// TODO: Do not write element marker for empty elements, such as passwordTable at http://localhost:8080/docs/ao/infrastructure/ao/regions/mobile-al/workstations/francis.aoindustries.com/
NodeBodyWriter.writeElementMarker(elementKey, out);
}
} finally {
// Restore previous currentNode
CurrentNode.setCurrentNode(request, parentNode);
}
}
}
/**
* @see #invoke(com.aoindustries.web.page.servlet.Element.Body)
*/
public void invoke() throws ServletException, IOException, SkipPageException {
invoke((Body)null);
}
public static interface PageContextBody {
void doBody(E element) throws ServletException, IOException, SkipPageException;
}
/**
* @see #invoke(com.aoindustries.web.page.servlet.Element.Body)
*/
public void invoke(final PageContextBody body) throws ServletException, IOException, SkipPageException {
invoke(
body == null
? null
// Java 1.8: (req, resp, e) -> body.doBody(e)
: new Body() {
@Override
public void doBody(HttpServletRequest req, HttpServletResponse resp, E element) throws ServletException, IOException, SkipPageException {
body.doBody(element);
}
}
);
}
public static interface PageContextNoElementBody {
void doBody() throws ServletException, IOException, SkipPageException;
}
/**
* @see #invoke(com.aoindustries.web.page.servlet.Element.Body)
*/
public void invoke(final PageContextNoElementBody body) throws ServletException, IOException, SkipPageException {
invoke(
body == null
? null
// Java 1.8: : (req, resp, e) -> body.doBody()
: new Body() {
@Override
public void doBody(HttpServletRequest req, HttpServletResponse resp, E element) throws ServletException, IOException, SkipPageException {
body.doBody();
}
}
);
}
/**
* Only called at capture level of META and higher.
*/
protected void doBody(
final HttpServletRequest request,
HttpServletResponse response,
CaptureLevel captureLevel,
final Body body
) throws ServletException, IOException, SkipPageException {
if(body != null) {
if(captureLevel == CaptureLevel.BODY) {
// Invoke tag body, capturing output
BufferWriter capturedOut = new SegmentedWriter();
try {
// Enable temp files if temp file context active
capturedOut = TempFileContext.wrapTempFileList(
capturedOut,
request,
// Java 1.8: AutoTempFileWriter::new
new TempFileContext.Wrapper() {
@Override
public BufferWriter call(BufferWriter original, TempFileList tempFileList) {
return new AutoTempFileWriter(original, tempFileList);
}
}
);
final PrintWriter capturedPW = new PrintWriter(capturedOut);
try {
final HttpServletResponse newResponse = new HttpServletResponseWrapper(response) {
@Override
public PrintWriter getWriter() throws IOException {
return capturedPW;
}
@Override
public ServletOutputStream getOutputStream() {
throw new NotImplementedException();
}
};
// Set PageContext
PageContext.newPageContextSkip(
servletContext,
request,
newResponse,
// Java 1.8: () -> body.doBody(request, newResponse, element)
new PageContext.PageContextCallableSkip() {
@Override
public void call() throws ServletException, IOException, SkipPageException {
body.doBody(request, newResponse, element);
}
}
);
if(capturedPW.checkError()) throw new IOException("Error on capturing PrintWriter");
} finally {
capturedPW.close();
}
} finally {
capturedOut.close();
}
element.setBody(capturedOut.getResult().trim());
} else if(captureLevel == CaptureLevel.META) {
// Invoke body for any meta data, but discard any output
final HttpServletResponse newResponse = new NullHttpServletResponseWrapper(response);
// Set PageContext
PageContext.newPageContextSkip(
servletContext,
request,
newResponse,
// Java 1.8: () -> body.doBody(request, newResponse, element)
new PageContext.PageContextCallableSkip() {
@Override
public void call() throws ServletException, IOException, SkipPageException {
body.doBody(request, newResponse, element);
}
}
);
} else {
throw new AssertionError();
}
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy