Package org.apache.juneau.terminal.region

Class TerminalDef

java.lang.Object

org.apache.juneau.terminal.region.TerminalDef

public class TerminalDef
extends Object

The options of a terminal card: where its bytes and (optionally) its step events come from.

Example:

TerminalDef def = TerminalDef.forMixin("build", "/runs", "r42") .eventsUrl("/runs/juneau-terminal-view/r42/events") .title("Build") .validate();

Since:

10.0.0

Field Summary

Fields

Modifier and Type	Field	Description
String	bytesUrl	The bytes endpoint path.
static final long	DEFAULT_TAIL_BYTES	The tail the card replays on its first load when tailBytes is not set: 2 MiB.
String	eventsUrl	The terminal-view events endpoint path, or null for no steps.
final String	id	The card id.
Boolean	input	Whether the card lets the user type into the job; needs inputId.
String	inputId	The terminal id sent as the payload id of a term.input frame.
static final List<String>	KEYS	The keys fromMap(String, Map) accepts, in toMap() order.
static final int	MAX_SCROLLBACK	The largest terminal.scrollback, in lines.
static final long	MAX_TAIL_BYTES	The largest tailBytes: 1 GiB.
Long	refreshMs	The poll interval; clamped to TerminalViewChecks.MIN_REFRESH_MS.
Long	tailBytes	The most bytes replayed on the first load.
Map<String,Object>	terminal	The xterm options passed to the client terminal, limited to TERMINAL_KEYS; null for none.
static final List<String>	TERMINAL_KEYS	The keys the terminal option map accepts, in toMap() order; they match the client-side xterm allowlist.
String	title	The card header title.

Method Summary

Modifier and Type	Method	Description
TerminalDef	bytesUrl(String value)
static TerminalDef	create(String id)	Creates a declaration.
TerminalDef	eventsUrl(String value)
static TerminalDef	forMixin(String id, String mountPath, String terminalId)	Creates a declaration whose bytesUrl points at a TerminalMixin mounted at mountPath.
static TerminalDef	fromMap(String id, Map<String,?> map)	Creates a declaration from a parsed map (the console-ui card body).
TerminalDef	input(boolean value)
TerminalDef	inputId(String value)
TerminalDef	refreshMs(long value)
TerminalDef	tailBytes(long value)
TerminalDef	terminal(Map<String,?> value)
TerminalDef	title(String value)
Map<String,Object>	toMap()	Returns the set options in KEYS order, with refreshMs clamped.
TerminalDef	validate()	Validates this declaration (fail-closed).

Methods inherited from class java.lang.Object

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

Field Details

KEYS

public static final List<String> KEYS

The keys fromMap(String, Map) accepts, in toMap() order.

TERMINAL_KEYS

public static final List<String> TERMINAL_KEYS

The keys the terminal option map accepts, in toMap() order; they match the client-side xterm allowlist.

MAX_SCROLLBACK

public static final int MAX_SCROLLBACK

The largest terminal.scrollback, in lines.

See Also:

• Constant Field Values

DEFAULT_TAIL_BYTES

public static final long DEFAULT_TAIL_BYTES

The tail the card replays on its first load when tailBytes is not set: 2 MiB.

See Also:

• Constant Field Values

MAX_TAIL_BYTES

public static final long MAX_TAIL_BYTES

The largest tailBytes: 1 GiB.

See Also:

• Constant Field Values

id

public final String id

The card id.

bytesUrl

public String bytesUrl

The bytes endpoint path.

eventsUrl

public String eventsUrl

The terminal-view events endpoint path, or null for no steps.

refreshMs

public Long refreshMs

The poll interval; clamped to TerminalViewChecks.MIN_REFRESH_MS.

title

public String title

The card header title.

tailBytes

public Long tailBytes

The most bytes replayed on the first load.

input

public Boolean input

Whether the card lets the user type into the job; needs inputId.

inputId

public String inputId

The terminal id sent as the payload id of a term.input frame.

terminal

public Map<String,Object> terminal

The xterm options passed to the client terminal, limited to TERMINAL_KEYS; null for none.

Method Details

create

public static TerminalDef create(String id)

Creates a declaration.

Parameters:

id - The card id.

Returns:

A new declaration.

forMixin

public static TerminalDef forMixin(String id,
 String mountPath,
 String terminalId)

Creates a declaration whose bytesUrl points at a TerminalMixin mounted at mountPath.

Parameters:

id - The card id.

mountPath - The resource mount path, for example "/runs".

terminalId - The terminal id; must match [A-Za-z0-9_-]{1,128}.

Returns:

A new declaration.

fromMap

public static TerminalDef fromMap(String id,
 Map<String,?> map)

Creates a declaration from a parsed map (the console-ui card body).

Parameters:

id - The card id.

map - The terminal object; keys must be a subset of KEYS.

Returns:

A new declaration (not yet validated).

bytesUrl

public TerminalDef bytesUrl(String value)

Parameters:

value - The bytes endpoint path. @return This object.

eventsUrl

public TerminalDef eventsUrl(String value)

Parameters:

value - The terminal-view events endpoint path. @return This object.

refreshMs

public TerminalDef refreshMs(long value)

Parameters:

value - The poll interval; clamped to TerminalViewChecks.MIN_REFRESH_MS. @return This object.

title

public TerminalDef title(String value)

Parameters:

value - The card header title. @return This object.

tailBytes

public TerminalDef tailBytes(long value)

Parameters:

value - The most bytes replayed on the first load, 1..1073741824L. @return This object.

input

public TerminalDef input(boolean value)

Parameters:

value - Whether the card lets the user type into the job. @return This object.

inputId

public TerminalDef inputId(String value)

Parameters:

value - The terminal id sent as the term.input payload id. @return This object.

terminal

public TerminalDef terminal(Map<String,?> value)

Parameters:

value - The xterm options, a map of convertEol (boolean), scrollback (integer 0..1000000) and fontFamily (non-empty string); checked by validate().

Returns:

This object.

validate

public TerminalDef validate()

Validates this declaration (fail-closed).

Returns:

This object.

Throws:

IllegalArgumentException - If a rule is broken.

toMap

public Map<String,Object> toMap()

Returns the set options in KEYS order, with refreshMs clamped.

Returns:

A new ordered map.

Throws:

IllegalArgumentException - If the terminal options are invalid.