Package org.apache.juneau.marshall.html

Class HtmlDocSerializerSession

java.lang.Object

org.apache.juneau.marshall.ContextSession

org.apache.juneau.marshall.MarshallingSession

org.apache.juneau.marshall.MarshallingTraverseSession

org.apache.juneau.marshall.serializer.SerializerSession

org.apache.juneau.marshall.serializer.WriterSerializerSession

org.apache.juneau.marshall.xml.XmlSerializerSession

org.apache.juneau.marshall.html.HtmlSerializerSession

org.apache.juneau.marshall.html.HtmlStrippedDocSerializerSession

org.apache.juneau.marshall.html.HtmlDocSerializerSession

All Implemented Interfaces:

BeanSession, ConverterSession, RecordWritable

Direct Known Subclasses:

HtmlSchemaDocSerializerSession

public class HtmlDocSerializerSession
extends HtmlStrippedDocSerializerSession

Context object that lives for the duration of a single serialization of HtmlSerializer and its subclasses.

See Serializer for details.

Notes:

• This class is not thread safe and is typically discarded after one use.

See Also:

• HTML

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HtmlDocSerializerSession.Builder<SELF extends HtmlDocSerializerSession.Builder<SELF>>	Builder class.
static final class	HtmlDocSerializerSession.DefaultBuilder	Concrete default builder leaf for the non-subclassed create() path (CRTP terminal).

Nested classes/interfaces inherited from class org.apache.juneau.marshall.xml.XmlSerializerSession

XmlSerializerSession.ContentResult

Field Summary

Fields inherited from class org.apache.juneau.marshall.MarshallingTraverseSession

indent

Fields inherited from class org.apache.juneau.marshall.MarshallingSession

NAME_PROPERTY_NAME

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HtmlDocSerializerSession(HtmlDocSerializerSession.Builder<?> builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
static HtmlDocSerializerSession.Builder<?>	create(HtmlDocSerializer ctx)	Creates a new builder for this object.
protected VarResolverSession	createDefaultVarResolverSession()	Adds a session object to the VarResolverSession in this session.
protected void	doWrite(SerializerPipe out, Object o)	Serializes a POJO to the specified pipe.
protected final HtmlDocSerializerSession	forEachWidget(Consumer<HtmlWidget> action)	Performs an action on all widgets defined in his session.
protected final String[]	getAside()	Aside section contents.
protected final AsideFloat	getAsideFloat()	Aside section contents float.
protected final String[]	getFooter()	Footer section contents.
protected final String[]	getHead()	Additional head section content.
protected final String[]	getHeader()	Header section contents.
protected final String[]	getNav()	Nav section contents.
protected final String[]	getNavlinks()	Page navigation links.
final String[]	getNavLinks()	Returns the HtmlDocSerializer.Builder.navlinks(String...) setting value in this context.
final String	getNonce()	The per-response Content-Security-Policy nonce for this render.
protected final String	getNoResultsMessage()	No-results message.
protected final String[]	getScript()	Javascript code.
protected final String[]	getStyle()	CSS style code.
protected final String[]	getStylesheet()	Stylesheet import URLs.
protected final HtmlDocTemplate	getTemplate()	HTML document template.
protected final boolean	isNowrap()	Prevent word wrap on page.
protected final boolean	isResolveBodyVars()	Resolve $ variables in serialized POJO.
void	parentSerialize(Object out, Object o)	Calls the parent doWrite(SerializerPipe, Object) method which invokes just the HTML serializer.
protected FluentMap<String,Object>	properties()	Returns the properties on this bean as a map for debugging.
String	resolveHtmlDoc(String string)	Resolves SVL variables for HTML-doc chrome fields that write raw HTML.
String	resolveScriptStyle(String string)	Resolves SVL variables for <script> and <style> chrome.

Methods inherited from class org.apache.juneau.marshall.html.HtmlStrippedDocSerializerSession

create

Methods inherited from class org.apache.juneau.marshall.html.HtmlSerializerSession

create, getAnchorText, getHtmlBeanPropertyMeta, getHtmlClassMeta, getHtmlWriter, getLabelParameter, getUriAnchorText, isAddBeanTypes, isAddKeyValueTableHeaders, isDetectLabelParameters, isDetectLinksInStrings, isHtmlMode, isUri, writeAnything, writeAnything

Methods inherited from class org.apache.juneau.marshall.xml.XmlSerializerSession

create, findNsfMappings, getDefaultNamespace, getNamespaces, getXmlBeanMeta, getXmlBeanPropertyMeta, getXmlClassMeta, getXmlWriter, isAddJsonTags, isAddNamespaceUrisToRoot, isAutoDetectNamespaces, isEnableNamespaces, isRecordStreaming, writeRecords

Methods inherited from class org.apache.juneau.marshall.serializer.WriterSerializerSession

create, createPipe, getMaxIndent, getQuoteChar, getStreamCharset, isUseWhitespace, isWriterSerializer, write, writeToString

Methods inherited from class org.apache.juneau.marshall.serializer.SerializerSession

addVarBean, canIgnoreValue, canIgnoreValue, create, createBeanTypeNameProperty, forEachEntry, forEachEntry, forEachStreamableEntry, generalize, getBeanTypeName, getCalendarFormat, getDateFormat, getDurationFormat, getExpectedRootType, getJavaMethod, getListener, getListener, getLocaleFormat, getPeriodFormat, getResponseHeaders, getSchema, getTemporalFormat, getTimeZoneFormat, getUriContext, getUriRelativity, getUriResolution, getUriResolver, getVarResolver, handleThrown, isAddRootType, isKeepNullProperties, isNonDefault, isSortCollections, isSortMaps, isTrimEmptyCollections, isTrimEmptyMaps, isTrimStrings, onBeanGetterException, onError, push2, relativizeUri, resolve, resolveUri, sort, sort, sort, swap, toList, toListFromStreamable, toString, trim, unwrapSupplier, write, writeCalendar, writeDate, writeDuration, writePeriod, writeTemporal

Methods inherited from class org.apache.juneau.marshall.MarshallingTraverseSession

getInitialDepth, getLastLocation, getMaxDepth, getOptionalType, getOptionalValue, getStack, isDetectRecursions, isIgnoreRecursions, isOptional, isRoot, pop, push, setCurrentClass, setCurrentProperty, willExceedDepth, willRecurse

Methods inherited from class org.apache.juneau.marshall.MarshallingSession

addWarning, convertToMemberType, convertToMemberType, convertToMemberType, convertToType, convertToType, convertToType, convertToType, create, get, getActiveView, getAnnotationProvider, getArgsClassMeta, getBeanClassVisibility, getBeanConstructorVisibility, getBeanDictionary, getBeanFieldVisibility, getBeanMeta, getBeanMethodVisibility, getBeanRegistry, getBeanTypePropertyName, getBeanTypePropertyName, getClassLoader, getClassMeta, getClassMeta, getClassMetaForObject, getClassMetaForObject, getLocale, getMarshallingContext, getMediaType, getNotBeanClasses, getNotBeanPackagesNames, getPropertyNamer, getSwaps, getTimeZone, getTimeZoneId, isBean, isBean, isBeanMapPutReturnsOldValue, isBeansRequireDefaultConstructor, isBeansRequireSerializable, isBeansRequireSettersForGetters, isBeansRequireSomeProperties, isFindFluentSetters, isIgnoreInvocationExceptionsOnGetters, isIgnoreInvocationExceptionsOnSetters, isIgnoreMissingSetters, isIgnoreUnknownBeanProperties, isIgnoreUnknownNullBeanProperties, isPropertyInActiveView, isRecordComponentOrder, isUnsortedProperties, isUseInterfaceProxies, isUseJavaBeanIntrospector, isValidateSchema, newBean, newBean, newBeanMap, newBeanMap, newGenericList, newGenericMap, newGenericMap, object, parseToList, parseToMap, string, toArray, toBeanMap, toBeanMap, toBeanMap

Methods inherited from class org.apache.juneau.marshall.ContextSession

checkForWarnings, getContext, getSessionProperties, getWarnings, isDebug, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.juneau.commons.conversion.ConverterSession

get

Constructor Details

HtmlDocSerializerSession

protected HtmlDocSerializerSession(HtmlDocSerializerSession.Builder<?> builder)

Constructor.

Parameters:

builder - The builder for this object.

Method Details

create

public static HtmlDocSerializerSession.Builder<?> create(HtmlDocSerializer ctx)

Creates a new builder for this object.

Parameters:

ctx - The context creating this session.

Returns:

A new builder.

getNonce

public final String getNonce()

The per-response Content-Security-Policy nonce for this render.

When non-null, inline <script>/<style> tags emitted by the HtmlDoc template are stamped with a matching nonce="..." attribute so they satisfy a nonce-based CSP.

Returns:

The nonce token, or null if nonce stamping is disabled.

See Also:

• HtmlDocSerializerSession.Builder.nonce(String)

getNavLinks

public final String[] getNavLinks()

Returns the HtmlDocSerializer.Builder.navlinks(String...) setting value in this context.

Returns:

The HtmlDocSerializer.Builder.navlinks(String...) setting value in this context. null if not specified. Never an empty map.

parentSerialize

public void parentSerialize(Object out,
 Object o)
                     throws Exception

Calls the parent doWrite(SerializerPipe, Object) method which invokes just the HTML serializer.

Parameters:

out - Where to send the output from the serializer.

o - The object being serialized.

Throws:

Exception - Error occurred during serialization.

createDefaultVarResolverSession

protected VarResolverSession createDefaultVarResolverSession()

Description copied from class: SerializerSession

Adds a session object to the VarResolverSession in this session.

Overrides:

createDefaultVarResolverSession in class SerializerSession

Returns:

This object.

doWrite

protected void doWrite(SerializerPipe out,
 Object o)
                throws IOException,
SerializeException

Description copied from class: SerializerSession

Serializes a POJO to the specified pipe.

This method should NOT close the context object.

The default implementation of this method simply calls Serializer.doWrite(SerializerSession,SerializerPipe,Object).

Overrides:

doWrite in class HtmlStrippedDocSerializerSession

Parameters:

out - Where to send the output from the serializer.

o - The object to serialize.

Throws:

IOException - Thrown by underlying stream.

SerializeException - Problem occurred trying to serialize object.

forEachWidget

protected final HtmlDocSerializerSession forEachWidget(Consumer<HtmlWidget> action)

Performs an action on all widgets defined in his session.

Parameters:

action - The action to perform.

Returns:

This object.

See Also:

• HtmlDocSerializer.Builder.widgets(Class...)

getAside

protected final String[] getAside()

Aside section contents.

Returns:

The overridden contents of the aside section on the HTML page.

See Also:

• HtmlDocSerializer.Builder.aside(String...)

getAsideFloat

protected final AsideFloat getAsideFloat()

Aside section contents float.

Returns:

The location of where to place the aside section.

See Also:

• HtmlDocSerializer.Builder.asideFloat(AsideFloat)

getFooter

protected final String[] getFooter()

Footer section contents.

Returns:

The overridden contents of the footer section on the HTML page.

See Also:

• HtmlDocSerializer.Builder.footer(String...)

getHead

protected final String[] getHead()

Additional head section content.

Returns:

HTML content to add to the head section of the HTML page.

See Also:

• HtmlDocSerializer.Builder.head(String...)

getHeader

protected final String[] getHeader()

Header section contents.

Returns:

The overridden contents of the header section on the HTML page.

See Also:

• HtmlDocSerializer.Builder.header(String...)

getNav

protected final String[] getNav()

Nav section contents.

Returns:

The overridden contents of the nav section on the HTML page.

See Also:

• HtmlDocSerializer.Builder.nav(String...)

getNavlinks

protected final String[] getNavlinks()

Page navigation links.

Returns:

Navigation links to add to the HTML page.

See Also:

• HtmlDocSerializer.Builder.navlinks(String...)

getNoResultsMessage

protected final String getNoResultsMessage()

No-results message.

Returns:

The message used when serializing an empty array or empty list.

See Also:

• HtmlDocSerializer.Builder.noResultsMessage(String)

getScript

protected final String[] getScript()

Javascript code.

Returns:

Arbitrary Javascript to add to the HTML page.

See Also:

• HtmlDocSerializer.Builder.script(String...)

getStyle

protected final String[] getStyle()

CSS style code.

Returns:

The CSS instructions to add to the HTML page.

See Also:

• HtmlDocSerializer.Builder.style(String...)

getStylesheet

protected final String[] getStylesheet()

Stylesheet import URLs.

Returns:

The link to the stylesheet of the HTML page.

See Also:

• HtmlDocSerializer.Builder.stylesheet(String...)

getTemplate

protected final HtmlDocTemplate getTemplate()

HTML document template.

Returns:

The template to use for serializing the page.

See Also:

• HtmlDocSerializer.Builder.template(Class)

isNowrap

protected final boolean isNowrap()

Prevent word wrap on page.

Returns:

true if "* {white-space:nowrap}" should be added to the CSS instructions on the page to prevent word wrapping.

See Also:

• HtmlDocSerializer.Builder.nowrap()

isResolveBodyVars

protected final boolean isResolveBodyVars()

Resolve $ variables in serialized POJO.

Returns:

true if $ variables in serialized POJO should be resolved.

See Also:

• HtmlDocSerializer.Builder.resolveBodyVars()

resolveHtmlDoc

public String resolveHtmlDoc(String string)

Resolves SVL variables for HTML-doc chrome fields that write raw HTML.

Literal characters from the template (including tags) pass through unchanged. Each SVL substitution is XML-escaped before insert, except the HTML-passthrough vars $W, $C, and $RS.

Plain SerializerSession.resolve(String) is unchanged. Navlink href values should keep using SerializerSession.resolve(String) plus attribute encoding.

Parameters:

string - The chrome template. Can be null.

Returns:

The resolved chrome string, or null if the input was null.

resolveScriptStyle

public String resolveScriptStyle(String string)

Resolves SVL variables for <script> and <style> chrome.

Request-derived vars ($RQ, $RH, $RF, $RP, $RA, $SA, $R) are left unresolved (same as an unknown var). Other vars including $W, $C, and $RS still resolve.

Parameters:

string - The script or style template. Can be null.

Returns:

The resolved string, or null if the input was null.

properties

protected FluentMap<String,Object> properties()

Description copied from class: ContextSession

Returns the properties on this bean as a map for debugging.

Overrides:

properties in class WriterSerializerSession

Returns:

The properties on this bean as a map for debugging.