Package com.helger.photon.app

Class PhotonUnifiedResponse

java.lang.Object

com.helger.servlet.response.UnifiedResponse

com.helger.photon.app.PhotonUnifiedResponse

public class PhotonUnifiedResponse
extends com.helger.servlet.response.UnifiedResponse

Extends the UnifiedResponse with additional sanity methods for easier pratical use.

Author:

Philip Helger

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	PhotonUnifiedResponse.HtmlHelper

Field Summary

Fields inherited from class com.helger.servlet.response.UnifiedResponse

DEFAULT_ALLOW_CONTENT_ON_REDIRECT, DEFAULT_ALLOW_CONTENT_ON_STATUS_CODE, DEFAULT_CONTENT_DISPOSITION_TYPE, DEFAULT_WARN_ON_DUPLICATE_COOKIES, MAX_CSS_KB_FOR_IE

Constructor Summary

Constructors

Constructor	Description
PhotonUnifiedResponse(com.helger.http.EHttpVersion eHttpVersion, com.helger.commons.http.EHttpMethod eHttpMethod, jakarta.servlet.http.HttpServletRequest aHttpRequest, com.helger.web.scope.IRequestWebScopeWithoutResponse aRequestScope)

Method Summary

Modifier and Type	Method	Description
PhotonUnifiedResponse	attachment(String sFilename)
PhotonUnifiedResponse	binary(com.helger.commons.io.stream.NonBlockingByteArrayOutputStream aBAOS, com.helger.commons.mime.IMimeType aMimeType, String sFilename)
PhotonUnifiedResponse	createAccepted()	HTTP 202 Accepted
PhotonUnifiedResponse	createBadRequest()	HTTP 400 Bad Request
PhotonUnifiedResponse	createConflict()	HTTP 409 Conflict
PhotonUnifiedResponse	createInternalServerError()	HTTP 500 Internal Server Error
PhotonUnifiedResponse	createNoContent()	HTTP 204 No Content
PhotonUnifiedResponse	createNotFound()	HTTP 404 Not Found
PhotonUnifiedResponse	createOk()	HTTP 200 OK
PhotonUnifiedResponse	createPreconditionFailed()	HTTP 412 Precondition Failed
PhotonUnifiedResponse	createSeeOther(com.helger.commons.url.ISimpleURL aRedirectTargetURL)	HTTP 303 See Other
static PhotonUnifiedResponse	createSimple(com.helger.web.scope.IRequestWebScopeWithoutResponse aRequestScope)	Factory method
final com.helger.json.serialize.IJsonWriterSettings	getJsonWriterSettings()
protected final com.helger.web.scope.IRequestWebScopeWithoutResponse	getRequestScope()
final com.helger.xml.serialize.write.IXMLWriterSettings	getXMLWriterSettings()
PhotonUnifiedResponse	html(com.helger.html.hc.IHCHasChildrenMutable<?,? super com.helger.html.hc.IHCNode> aNode, com.helger.html.hc.config.IHCOnDocumentReadyProvider aOnDocumentReadyProvider, com.helger.json.IJsonObject aCustomJson)
PhotonUnifiedResponse	html(com.helger.html.hc.IHCNode aNode)
PhotonUnifiedResponse	htmlSimple(com.helger.html.hc.IHCNode aNode)	Create a simple HTML response without JSON structuring
PhotonUnifiedResponse	json(com.helger.json.IJson aValue)
PhotonUnifiedResponse	jsonEmpty()
PhotonUnifiedResponse	pdf(byte[] aData, String sFilename)
PhotonUnifiedResponse	pdf(com.helger.commons.io.stream.NonBlockingByteArrayOutputStream aBAOS)
PhotonUnifiedResponse	pdf(com.helger.commons.io.stream.NonBlockingByteArrayOutputStream aBAOS, String sFilename)
PhotonUnifiedResponse	serialized(Serializable aObj)
PhotonUnifiedResponse	setContent(com.helger.commons.io.stream.NonBlockingByteArrayOutputStream aBAOS)
final void	setJsonWriterSettings(com.helger.json.serialize.IJsonWriterSettings aJWS)
final void	setXMLWriterSettings(com.helger.xml.serialize.write.IXMLWriterSettings aXWS)
PhotonUnifiedResponse	text(String sValue)
PhotonUnifiedResponse	xml(byte[] aXML, Charset aCharset)
PhotonUnifiedResponse	xml(com.helger.xml.microdom.IMicroNode aNode)
PhotonUnifiedResponse	xml(com.helger.xml.microdom.IMicroNode aNode, com.helger.xml.serialize.write.IXMLWriterSettings aSettings)
PhotonUnifiedResponse	xml(String sXML, Charset aCharset)
PhotonUnifiedResponse	xml(Node aNode)
PhotonUnifiedResponse	xml(Node aNode, com.helger.xml.serialize.write.IXMLWriterSettings aSettings)

Methods inherited from class com.helger.servlet.response.UnifiedResponse

addCookie, addCustomResponseHeader, addCustomResponseHeaders, applyToResponse, cacheControl, createSimple, disableCaching, enableCaching, getAllCookies, getCharset, getContentDispositionFilename, getContentDispositionType, getHttpMethod, getHttpVersion, getLogPrefix, getMimeType, getRequestBrowserInfo, getRequestURL, getStatusCode, hasContent, hasCookies, isAllowContentOnRedirect, isAllowContentOnStatusCode, isHttpHeaderValuesQuoteIfNecessary, isHttpHeaderValuesUnified, isRedirectDefined, isSilentMode, isStatusCodeDefined, isWarnOnDuplicateCookies, logError, logInfo, logWarn, removeAllCookies, removeCacheControl, removeCaching, removeCharset, removeContent, removeContentDispositionFilename, removeCookie, removeCustomResponseHeaders, removeETag, removeExpires, removeLastModified, removeMimeType, removeStrictTransportSecurity, removeXFrameOptions, responseHeaderMap, setAllowContentOnRedirect, setAllowContentOnStatusCode, setAllowMimeSniffing, setCacheControl, setCharset, setContent, setContent, setContent, setContentAndCharset, setContentDispositionFilename, setContentDispositionType, setCustomResponseHeader, setCustomResponseHeaders, setDownloadFilename, setEmptyContent, setEnableXSSFilter, setETag, setETagIfApplicable, setExpires, setHttpHeaderValuesQuoteIfNecessary, setHttpHeaderValuesUnified, setLastModified, setMimeType, setMimeTypeString, setRedirect, setRedirect, setRedirect, setRedirect, setRequestBrowserInfo, setSilentMode, setStatus, setStatusUnauthorized, setStrictTransportSecurity, setWarnOnDuplicateCookies, setXFrameOptions, showRequestInfo

Methods inherited from class java.lang.Object

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

Constructor Details

PhotonUnifiedResponse

public PhotonUnifiedResponse(@Nonnull
 com.helger.http.EHttpVersion eHttpVersion,
 @Nonnull
 com.helger.commons.http.EHttpMethod eHttpMethod,
 @Nonnull
 jakarta.servlet.http.HttpServletRequest aHttpRequest,
 @Nonnull
 com.helger.web.scope.IRequestWebScopeWithoutResponse aRequestScope)

Method Details

getRequestScope

protected final com.helger.web.scope.IRequestWebScopeWithoutResponse getRequestScope()

getXMLWriterSettings

@Nonnull
public final com.helger.xml.serialize.write.IXMLWriterSettings getXMLWriterSettings()

setXMLWriterSettings

public final void setXMLWriterSettings(@Nonnull
 com.helger.xml.serialize.write.IXMLWriterSettings aXWS)

getJsonWriterSettings

@Nonnull
public final com.helger.json.serialize.IJsonWriterSettings getJsonWriterSettings()

setJsonWriterSettings

public final void setJsonWriterSettings(@Nonnull
 com.helger.json.serialize.IJsonWriterSettings aJWS)

jsonEmpty

@Nonnull
public PhotonUnifiedResponse jsonEmpty()

json

@Nonnull
public PhotonUnifiedResponse json(@Nullable
 com.helger.json.IJson aValue)

xml

@Nonnull
public PhotonUnifiedResponse xml(@Nullable
 String sXML,
 @Nonnull
 Charset aCharset)

xml

@Nonnull
public PhotonUnifiedResponse xml(@Nonnull
 byte[] aXML,
 @Nonnull
 Charset aCharset)

xml

@Nonnull
public PhotonUnifiedResponse xml(@Nullable
 com.helger.xml.microdom.IMicroNode aNode)

xml

@Nonnull
public PhotonUnifiedResponse xml(@Nullable
 com.helger.xml.microdom.IMicroNode aNode,
 @Nonnull
 com.helger.xml.serialize.write.IXMLWriterSettings aSettings)

xml

@Nonnull
public PhotonUnifiedResponse xml(@Nullable
 Node aNode)

xml

@Nonnull
public PhotonUnifiedResponse xml(@Nullable
 Node aNode,
 @Nonnull
 com.helger.xml.serialize.write.IXMLWriterSettings aSettings)

text

@Nonnull
public PhotonUnifiedResponse text(@Nullable
 String sValue)

html

@Nonnull
public PhotonUnifiedResponse html(@Nullable
 com.helger.html.hc.IHCNode aNode)

html

@Nonnull
public PhotonUnifiedResponse html(@Nullable
 com.helger.html.hc.IHCHasChildrenMutable<?,? super com.helger.html.hc.IHCNode> aNode,
 @Nullable
 com.helger.html.hc.config.IHCOnDocumentReadyProvider aOnDocumentReadyProvider,
 @Nullable
 com.helger.json.IJsonObject aCustomJson)

htmlSimple

@Nonnull
public PhotonUnifiedResponse htmlSimple(@Nullable
 com.helger.html.hc.IHCNode aNode)

Create a simple HTML response without JSON structuring

Parameters:

aNode - The node to be rendered. May be null.

Returns:

this for chaining

createOk

@Nonnull
public PhotonUnifiedResponse createOk()

HTTP 200 OK

Returns:

this for chaining

createAccepted

@Nonnull
public PhotonUnifiedResponse createAccepted()

HTTP 202 Accepted

Returns:

this for chaining

Since:

8.1.3

createNoContent

@Nonnull
public PhotonUnifiedResponse createNoContent()

HTTP 204 No Content

Returns:

this for chaining

createSeeOther

@Nonnull
public PhotonUnifiedResponse createSeeOther(@Nonnull
 com.helger.commons.url.ISimpleURL aRedirectTargetURL)

HTTP 303 See Other

Parameters:

aRedirectTargetURL - The redirect URL. May not be null.

Returns:

this for chaining

createBadRequest

@Nonnull
public PhotonUnifiedResponse createBadRequest()

HTTP 400 Bad Request

Returns:

this for chaining

createNotFound

@Nonnull
public PhotonUnifiedResponse createNotFound()

HTTP 404 Not Found

Returns:

this for chaining

createConflict

@Nonnull
public PhotonUnifiedResponse createConflict()

HTTP 409 Conflict

Returns:

this for chaining

createPreconditionFailed

@Nonnull
public PhotonUnifiedResponse createPreconditionFailed()

HTTP 412 Precondition Failed

Returns:

this for chaining

createInternalServerError

@Nonnull
public PhotonUnifiedResponse createInternalServerError()

HTTP 500 Internal Server Error

Returns:

this for chaining

setContent

@Nonnull
public PhotonUnifiedResponse setContent(@Nonnull
 com.helger.commons.io.stream.NonBlockingByteArrayOutputStream aBAOS)

serialized

@Nonnull
public PhotonUnifiedResponse serialized(@Nonnull
 Serializable aObj)

pdf

@Nonnull
public PhotonUnifiedResponse pdf(@Nonnull
 com.helger.commons.io.stream.NonBlockingByteArrayOutputStream aBAOS)

pdf

@Nonnull
public PhotonUnifiedResponse pdf(@Nonnull
 byte[] aData,
 @Nonnull @Nonempty
 String sFilename)

pdf

@Nonnull
public PhotonUnifiedResponse pdf(@Nonnull
 com.helger.commons.io.stream.NonBlockingByteArrayOutputStream aBAOS,
 @Nonnull @Nonempty
 String sFilename)

attachment

@Nonnull
public PhotonUnifiedResponse attachment(@Nonnull @Nonempty
 String sFilename)

binary

@Nonnull
public PhotonUnifiedResponse binary(@Nonnull
 com.helger.commons.io.stream.NonBlockingByteArrayOutputStream aBAOS,
 @Nonnull
 com.helger.commons.mime.IMimeType aMimeType,
 @Nonnull @Nonempty
 String sFilename)

createSimple

@Nonnull
public static PhotonUnifiedResponse createSimple(@Nonnull
 com.helger.web.scope.IRequestWebScopeWithoutResponse aRequestScope)

Factory method

Parameters:

aRequestScope - The current request scope. May not be null.

Returns:

New PhotonUnifiedResponse. Never null.