Package org.apache.juneau.terminal.region

Interface TerminalMixin

All Known Implementing Classes:

JobsRest

public interface TerminalMixin

Mixin interface that serves the terminal bytes and raw endpoints, plus this module's own JS and CSS.

The one abstract method is the application's resolver, which is where authorization lives: an unknown id and a forbidden id both answer 404. Ids match ^[A-Za-z0-9_-]{1,128}$; anything else answers 400 before the resolver runs. The mixin adds no auth of its own; the host resource's guards apply.

Step events are not served here: pair the terminal with TerminalViewMixin over the same id.

Example:

@Rest public class RunsResource extends BasicRestServlet implements TerminalMixin, TerminalViewMixin { @Override public Optional<TerminalSource> terminalSource(String id, RestRequest req) { return runs.find(id).map(Run::terminal); } }

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BYTES_PATH	The URL path template of the bytes endpoint.
static final String	CSS_PATH	The URL path of the terminal stylesheet.
static final String	JS_PATH	The URL path of the terminal runtime.
static final String	RAW_PATH	The URL path template of the raw download.
static final String	TERMINAL_PREFIX	The URL path prefix of the terminal endpoints (relative to the host mount).
static final String	XTERM_CSS_ASSET	The WebJarResolver asset id of the xterm.js stylesheet.
static final String	XTERM_JS_ASSET	The WebJarResolver asset id of the xterm.js UMD bundle.

Method Summary

Modifier and Type	Method	Description
static String	terminalAssetUrl(RestRequest req, String path)	The absolute URL of a terminal asset; the toolkit pack resolver for the terminal pack.
default void	terminalBytes(String id, RestRequest req, RestResponse res)	[GET /juneau-terminal/{id}/bytes] — raw bytes from an offset.
default void	terminalRaw(String id, RestRequest req, RestResponse res)	[GET /juneau-terminal/{id}/raw] — the whole log as an attachment.
default HttpResource	terminalScript()	[GET /juneau-terminal.js] — the terminal runtime.
Optional<TerminalSource>	terminalSource(String id, RestRequest req)	Resolves the source for a terminal id, applying the application's own access rules.
default HttpResource	terminalStylesheet()	[GET /juneau-terminal.css] — the terminal stylesheet.

Field Details

TERMINAL_PREFIX

static final String TERMINAL_PREFIX

The URL path prefix of the terminal endpoints (relative to the host mount).

See Also:

• Constant Field Values

BYTES_PATH

static final String BYTES_PATH

The URL path template of the bytes endpoint.

See Also:

• Constant Field Values

RAW_PATH

static final String RAW_PATH

The URL path template of the raw download.

See Also:

• Constant Field Values

JS_PATH

static final String JS_PATH

The URL path of the terminal runtime.

See Also:

• Constant Field Values

CSS_PATH

static final String CSS_PATH

The URL path of the terminal stylesheet.

See Also:

• Constant Field Values

XTERM_JS_ASSET

static final String XTERM_JS_ASSET

The WebJarResolver asset id of the xterm.js UMD bundle.

See Also:

• Constant Field Values

XTERM_CSS_ASSET

static final String XTERM_CSS_ASSET

The WebJarResolver asset id of the xterm.js stylesheet.

See Also:

• Constant Field Values

Method Details

terminalSource

Optional<TerminalSource> terminalSource(String id,
 RestRequest req)

Resolves the source for a terminal id, applying the application's own access rules.

Parameters:

id - The id from the URL path (already checked against the grammar).

req - The in-flight request.

Returns:

The source, or empty when the id is unknown or the caller may not read it.

terminalBytes

default void terminalBytes(@Path("id")
 String id,
 RestRequest req,
 RestResponse res)
                    throws IOException

[GET /juneau-terminal/{id}/bytes] — raw bytes from an offset.

Parameters:

id - The terminal id.

req - The request.

res - The response.

Throws:

IOException - If the response could not be written.

terminalRaw

default void terminalRaw(@Path("id")
 String id,
 RestRequest req,
 RestResponse res)
                  throws IOException

[GET /juneau-terminal/{id}/raw] — the whole log as an attachment.

Parameters:

id - The terminal id.

req - The request.

res - The response.

Throws:

IOException - If the response could not be written.

terminalScript

default HttpResource terminalScript()

[GET /juneau-terminal.js] — the terminal runtime.

Returns:

The script.

terminalStylesheet

default HttpResource terminalStylesheet()

[GET /juneau-terminal.css] — the terminal stylesheet.

Returns:

The stylesheet.

terminalAssetUrl

static String terminalAssetUrl(RestRequest req,
 String path)

The absolute URL of a terminal asset; the toolkit pack resolver for the terminal pack.

Parameters:

req - The current request.

path - JS_PATH or CSS_PATH.

Returns:

The asset URL with its cache-buster.