graalvm/tools.elide.page/Context

Context

class Context : GeneratedMessage, ContextOrBuilder

Defines the notion of a *Render Context* for server-side pages in Gust. This protocol message is filled out with data
as configured by the developer (from `application.yml` and the active controller, as applicable) and provided as an
injected value to all server-side render operations.

When preparing context in Gust, adding a static script or stylesheet is done through `Context`. Setting page metadata
like the title, keywords, and manifest - also all done through `Context`. This of course has the added benefit of
being completely serializable, repeatable, and so on (i.e. all the benefits Protobuf brings).

Major context modules include:
- *Metadata*: Page-level metadata.
- *OpenGraph*: Properties for OG tags.
- *Twitter*: Properties for Twitter cards.
- *AppManifest*: Information to link or derive a web application manifest.
- *Styles*: Stylesheets and inline head-injected styles ("lifted styles").
- *Scripts*: Scripts to include, and inline head-injected logic ("lifted JS").

Protobuf type elide.page.Context

Types

AppManifest

class AppManifest : GeneratedMessage, Context.AppManifestOrBuilder

Specifies details about an application manifest, which should be or is linked to a given web
page, that is being rendered by the render engine.

Protobuf type elide.page.Context.AppManifest

AppManifestOrBuilder

interface AppManifestOrBuilder : MessageOrBuilder

Builder

class Builder : GeneratedMessage.Builder<BuilderT> , ContextOrBuilder

Defines the notion of a *Render Context* for server-side pages in Gust. This protocol message is filled out with data
as configured by the developer (from `application.yml` and the active controller, as applicable) and provided as an
injected value to all server-side render operations.

When preparing context in Gust, adding a static script or stylesheet is done through `Context`. Setting page metadata
like the title, keywords, and manifest - also all done through `Context`. This of course has the added benefit of
being completely serializable, repeatable, and so on (i.e. all the benefits Protobuf brings).

Major context modules include:
- *Metadata*: Page-level metadata.
- *OpenGraph*: Properties for OG tags.
- *Twitter*: Properties for Twitter cards.
- *AppManifest*: Information to link or derive a web application manifest.
- *Styles*: Stylesheets and inline head-injected styles ("lifted styles").
- *Scripts*: Scripts to include, and inline head-injected logic ("lifted JS").

Protobuf type elide.page.Context

ClientHint

enum ClientHint : ProtocolMessageEnum

Specifies supported client hints.

Protobuf enum elide.page.Context.ClientHint

ClientHints

class ClientHints : GeneratedMessage, Context.ClientHintsOrBuilder

Specifies client hints context information.

Protobuf type elide.page.Context.ClientHints

ClientHintsOrBuilder

interface ClientHintsOrBuilder : MessageOrBuilder

ConnectionHint

enum ConnectionHint : ProtocolMessageEnum

Specifies estimated connection speed levels.

Protobuf enum elide.page.Context.ConnectionHint

class Cookie : GeneratedMessage, Context.CookieOrBuilder

HTTP cookies to set on the response, including the content of each cookie, name, and any flags.

Protobuf type elide.page.Context.Cookie

CookieOrBuilder

interface CookieOrBuilder : MessageOrBuilder

CrossOriginResourcePolicy

enum CrossOriginResourcePolicy : ProtocolMessageEnum

Enumerates `Cross-Origin-Resource-Policy` settings.

Protobuf enum elide.page.Context.CrossOriginResourcePolicy

DynamicETag

class DynamicETag : GeneratedMessage, Context.DynamicETagOrBuilder

Defines the notion of a dynamically-served-page `ETag`, which is calculated either from weak parameters (the date/
time it was served and a simple hash of the request) or strong parameters (full hash of the response).

Protobuf type elide.page.Context.DynamicETag

DynamicETagOrBuilder

interface DynamicETagOrBuilder : MessageOrBuilder

Fonts

class Fonts : GeneratedMessage, Context.FontsOrBuilder

Specifies information about sets of fonts to include in the page via CSS declarations, or imports/link
references. Fonts are considered part of the stylesheet set of a page.

Protobuf type elide.page.Context.Fonts

FontsOrBuilder

interface FontsOrBuilder : MessageOrBuilder

FramingPolicy

enum FramingPolicy : ProtocolMessageEnum

Specifies a policy to apply via the `X-Frame-Options` header.

Protobuf enum elide.page.Context.FramingPolicy

Metadata

class Metadata : GeneratedMessage, Context.MetadataOrBuilder

Defines the structure of well-known page-level metadata, including the page title, description,
keywords, and so on.

Protobuf type elide.page.Context.Metadata

MetadataOrBuilder

interface MetadataOrBuilder : MessageOrBuilder

PageLink

class PageLink : GeneratedMessage, Context.PageLinkOrBuilder

Specifies information about an asset or foreign page linked to this page. Stylesheets, favorite icons ("favicons"),
HTTP preloading, and other features are implemented via HTML links.

Protobuf type elide.page.Context.PageLink

PageLinkOrBuilder

interface PageLinkOrBuilder : MessageOrBuilder

RDFPrefix

class RDFPrefix : GeneratedMessage, Context.RDFPrefixOrBuilder

Specifies an individual RDF prefix block to include in the HTML tag.

Protobuf type elide.page.Context.RDFPrefix

RDFPrefixOrBuilder

interface RDFPrefixOrBuilder : MessageOrBuilder

ReferrerPolicy

enum ReferrerPolicy : ProtocolMessageEnum

Specifies a policy to apply via the `Referrer-Policy` header. All policy docs come from MDN.

Protobuf enum elide.page.Context.ReferrerPolicy

ResponseHeader

class ResponseHeader : GeneratedMessage, Context.ResponseHeaderOrBuilder

Specifies custom response headers to affix to the request.

Protobuf type elide.page.Context.ResponseHeader

ResponseHeaderOrBuilder

interface ResponseHeaderOrBuilder : MessageOrBuilder

Scripts

class Scripts : GeneratedMessage, Context.ScriptsOrBuilder

Specifies information about JavaScript code that should be included with a given page render. Scripts
included in this manner may be emitted inline or by reference (URI).

Protobuf type elide.page.Context.Scripts

ScriptsOrBuilder

interface ScriptsOrBuilder : MessageOrBuilder

Styles

class Styles : GeneratedMessage, Context.StylesOrBuilder

Defines page-level style settings (CSS), including external stylesheets, lifted CSS that should
be rendered in the <head>, and more.

Protobuf type elide.page.Context.Styles

StylesOrBuilder

interface StylesOrBuilder : MessageOrBuilder

Properties

CDN_PREFIX_FIELD_NUMBER

val CDN_PREFIX_FIELD_NUMBER: Int = 17

cdnPrefixOrNull

val ContextOrBuilder.cdnPrefixOrNull: TrustedResourceUrlProto?

CONTENT_TYPE_NOSNIFF_FIELD_NUMBER

val CONTENT_TYPE_NOSNIFF_FIELD_NUMBER: Int = 16

COOKIE_FIELD_NUMBER

val COOKIE_FIELD_NUMBER: Int = 8

DNS_PREFETCH_FIELD_NUMBER

val DNS_PREFETCH_FIELD_NUMBER: Int = 18

ETAG_FIELD_NUMBER

val ETAG_FIELD_NUMBER: Int = 6

etagOrNull

val ContextOrBuilder.etagOrNull: Context.DynamicETag?

FEATURE_POLICY_FIELD_NUMBER

val FEATURE_POLICY_FIELD_NUMBER: Int = 13

FONTS_FIELD_NUMBER

val FONTS_FIELD_NUMBER: Int = 3

fontsOrNull

val ContextOrBuilder.fontsOrNull: Context.Fonts?

FRAMING_POLICY_FIELD_NUMBER

val FRAMING_POLICY_FIELD_NUMBER: Int = 15

HEADER_FIELD_NUMBER

val HEADER_FIELD_NUMBER: Int = 9

HINTS_FIELD_NUMBER

val HINTS_FIELD_NUMBER: Int = 12

hintsOrNull

val ContextOrBuilder.hintsOrNull: Context.ClientHints?

LANGUAGE_FIELD_NUMBER

val LANGUAGE_FIELD_NUMBER: Int = 11

MANIFEST_FIELD_NUMBER

val MANIFEST_FIELD_NUMBER: Int = 5

manifestOrNull

val ContextOrBuilder.manifestOrNull: Context.AppManifest?

META_FIELD_NUMBER

val META_FIELD_NUMBER: Int = 1

metaOrNull

val ContextOrBuilder.metaOrNull: Context.Metadata?

PRECONNECT_FIELD_NUMBER

val PRECONNECT_FIELD_NUMBER: Int = 19

REFERRER_POLICY_FIELD_NUMBER

val REFERRER_POLICY_FIELD_NUMBER: Int = 21

SCRIPTS_FIELD_NUMBER

val SCRIPTS_FIELD_NUMBER: Int = 4

scriptsOrNull

val ContextOrBuilder.scriptsOrNull: Context.Scripts?

STYLES_FIELD_NUMBER

val STYLES_FIELD_NUMBER: Int = 2

stylesOrNull

val ContextOrBuilder.stylesOrNull: Context.Styles?

VARY_FIELD_NUMBER

val VARY_FIELD_NUMBER: Int = 10

XSS_PROTECTION_FIELD_NUMBER

val XSS_PROTECTION_FIELD_NUMBER: Int = 20

Functions

copy

inline fun Context.copy(block: ContextKt.Dsl.() -> Unit): Context

equals

open fun equals(obj: Any): Boolean

findInitializationErrors

open fun findInitializationErrors(): List<String>

getAllFields

open fun getAllFields(): Map<Descriptors.FieldDescriptor, Any>

getCdnPrefix

open fun getCdnPrefix(): TrustedResourceUrlProto

Specifies the selected CDN prefix to use.

.webutil.html.types.TrustedResourceUrlProto cdn_prefix = 17;

getCdnPrefixOrBuilder

open fun getCdnPrefixOrBuilder(): TrustedResourceUrlProtoOrBuilder

Specifies the selected CDN prefix to use.

.webutil.html.types.TrustedResourceUrlProto cdn_prefix = 17;

getContentTypeNosniff

open fun getContentTypeNosniff(): Boolean

Specifies that the `nosniff` flag should be included in a `X-Content-Type-Options` header.

bool content_type_nosniff = 16;

getCookie

open fun getCookie(index: Int): Context.Cookie

Specifies HTTP cookies to affix to the response associated with this context.

repeated .elide.page.Context.Cookie cookie = 8;

getCookieCount

open fun getCookieCount(): Int

Specifies HTTP cookies to affix to the response associated with this context.

repeated .elide.page.Context.Cookie cookie = 8;

getCookieList

open fun getCookieList(): List<Context.Cookie>

Specifies HTTP cookies to affix to the response associated with this context.

repeated .elide.page.Context.Cookie cookie = 8;

getCookieOrBuilder

open fun getCookieOrBuilder(index: Int): Context.CookieOrBuilder

Specifies HTTP cookies to affix to the response associated with this context.

repeated .elide.page.Context.Cookie cookie = 8;

getCookieOrBuilderList

open fun getCookieOrBuilderList(): List<out Context.CookieOrBuilder>

Specifies HTTP cookies to affix to the response associated with this context.

repeated .elide.page.Context.Cookie cookie = 8;

getDefaultInstance

open fun getDefaultInstance(): Context

getDefaultInstanceForType

abstract fun getDefaultInstanceForType(): MessageLite

open fun getDefaultInstanceForType(): Context

getDescriptor

fun getDescriptor(): Descriptors.Descriptor

getDescriptorForType

open fun getDescriptorForType(): Descriptors.Descriptor

getDnsPrefetch

open fun getDnsPrefetch(index: Int): String

Specifies hostnames to pre-load DNS records for.

repeated string dns_prefetch = 18;

getDnsPrefetchBytes

open fun getDnsPrefetchBytes(index: Int): ByteString

Specifies hostnames to pre-load DNS records for.

repeated string dns_prefetch = 18;

getDnsPrefetchCount

open fun getDnsPrefetchCount(): Int

Specifies hostnames to pre-load DNS records for.

repeated string dns_prefetch = 18;

getDnsPrefetchList

open fun getDnsPrefetchList(): ProtocolStringList

Specifies hostnames to pre-load DNS records for.

repeated string dns_prefetch = 18;

getEtag

open fun getEtag(): Context.DynamicETag

`ETag` information to enclose with this page, when rendered.

.elide.page.Context.DynamicETag etag = 6;

getEtagOrBuilder

open fun getEtagOrBuilder(): Context.DynamicETagOrBuilder

`ETag` information to enclose with this page, when rendered.

.elide.page.Context.DynamicETag etag = 6;

getFeaturePolicy

open fun getFeaturePolicy(index: Int): String

Specifies feature policies for this HTTP cycle.

repeated string feature_policy = 13;

getFeaturePolicyBytes

open fun getFeaturePolicyBytes(index: Int): ByteString

Specifies feature policies for this HTTP cycle.

repeated string feature_policy = 13;

getFeaturePolicyCount

open fun getFeaturePolicyCount(): Int

Specifies feature policies for this HTTP cycle.

repeated string feature_policy = 13;

getFeaturePolicyList

open fun getFeaturePolicyList(): ProtocolStringList

Specifies feature policies for this HTTP cycle.

repeated string feature_policy = 13;

getField

open fun getField(field: Descriptors.FieldDescriptor): Any

getFonts

open fun getFonts(): Context.Fonts

Fonts to include/load on the page.

.elide.page.Context.Fonts fonts = 3;

getFontsOrBuilder

open fun getFontsOrBuilder(): Context.FontsOrBuilder

Fonts to include/load on the page.

.elide.page.Context.Fonts fonts = 3;

getFramingPolicy

open fun getFramingPolicy(): Context.FramingPolicy

Specifies options when a page is referenced as a frame.

.elide.page.Context.FramingPolicy framing_policy = 15;

getFramingPolicyValue

open fun getFramingPolicyValue(): Int

Specifies options when a page is referenced as a frame.

.elide.page.Context.FramingPolicy framing_policy = 15;

getHeader

open fun getHeader(index: Int): Context.ResponseHeader

Custom headers to affix to the response associated with this context.