Ether Framework
Unified API docs for Ether modules
Loading...
Searching...
No Matches
dev.rafex.ether.http.core.HttpExchange Interface Reference
Inheritance diagram for dev.rafex.ether.http.core.HttpExchange:
Collaboration diagram for dev.rafex.ether.http.core.HttpExchange:

Classes

interface  EventStream
 A long-lived, transport-agnostic handle for pushing Server-Sent Events. More...

Public Member Functions

Set< String > allowedMethods ()
void json (int status, Object body)
String method ()
default void methodNotAllowed ()
void noContent (int status)
default void options ()
String path ()
String pathParam (String name)
Map< String, String > pathParams ()
List< String > queryAll (String name)
String queryFirst (String name)
Map< String, List< String > > queryParams ()
default EventStream startEventStream ()
 Starts a Server-Sent Events stream.
void text (int status, String body)

Detailed Description

Definition at line 33 of file HttpExchange.java.

Member Function Documentation

◆ allowedMethods()

Set< String > dev.rafex.ether.http.core.HttpExchange.allowedMethods ( )

◆ json()

void dev.rafex.ether.http.core.HttpExchange.json ( int status,
Object body )

Implemented in dev.rafex.ether.http.jetty12.exchange.JettyHttpExchange.

Referenced by methodNotAllowed().

Here is the caller graph for this function:

◆ method()

String dev.rafex.ether.http.core.HttpExchange.method ( )

◆ methodNotAllowed()

default void dev.rafex.ether.http.core.HttpExchange.methodNotAllowed ( )

Implemented in dev.rafex.ether.http.jetty12.exchange.JettyHttpExchange.

Definition at line 57 of file HttpExchange.java.

References json().

Referenced by dev.rafex.ether.http.jetty12.exchange.JettyHttpExchange.methodNotAllowed().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ noContent()

void dev.rafex.ether.http.core.HttpExchange.noContent ( int status)

Implemented in dev.rafex.ether.http.jetty12.exchange.JettyHttpExchange.

Referenced by options().

Here is the caller graph for this function:

◆ options()

default void dev.rafex.ether.http.core.HttpExchange.options ( )

Implemented in dev.rafex.ether.http.jetty12.exchange.JettyHttpExchange.

Definition at line 61 of file HttpExchange.java.

References noContent().

Referenced by dev.rafex.ether.http.jetty12.exchange.JettyHttpExchange.options().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ path()

String dev.rafex.ether.http.core.HttpExchange.path ( )

◆ pathParam()

String dev.rafex.ether.http.core.HttpExchange.pathParam ( String name)

◆ pathParams()

Map< String, String > dev.rafex.ether.http.core.HttpExchange.pathParams ( )

◆ queryAll()

List< String > dev.rafex.ether.http.core.HttpExchange.queryAll ( String name)

◆ queryFirst()

String dev.rafex.ether.http.core.HttpExchange.queryFirst ( String name)

◆ queryParams()

Map< String, List< String > > dev.rafex.ether.http.core.HttpExchange.queryParams ( )

◆ startEventStream()

default EventStream dev.rafex.ether.http.core.HttpExchange.startEventStream ( )

Starts a Server-Sent Events stream.

Sets the transport's event-stream headers and returns an EventStream for subsequent writes; json, text and noContent must not be called after this.

Default throws — only transports that implement long-lived/chunked writes (e.g. the Jetty 12 transport) support this.

Implemented in dev.rafex.ether.http.jetty12.exchange.JettyHttpExchange.

Definition at line 73 of file HttpExchange.java.

◆ text()

void dev.rafex.ether.http.core.HttpExchange.text ( int status,
String body )

Implemented in dev.rafex.ether.http.jetty12.exchange.JettyHttpExchange.

Referenced by dev.rafex.ether.http.core.HttpExchange.EventStream.comment().

Here is the caller graph for this function:

The documentation for this interface was generated from the following file:
  • ether-http-core/ether-http-core/src/main/java/dev/rafex/ether/http/core/HttpExchange.java