A B C D F H I K M N O P Q R S T V W

A

AllowAnyOriginFilter - Class in io.spine.web

An servlet filter which appends the CORS headers to HTTP responses.

AllowAnyOriginFilter() - Constructor for class io.spine.web.AllowAnyOriginFilter

ANY_URL - Static variable in class io.spine.web.AllowAnyOriginFilter

A URL pattern which matches all the URLs.

B

BlockingQueryBridge - Class in io.spine.web.query

A QueryBridge which executes given queries in a blocking manner.

BlockingQueryBridge(QueryServiceGrpc.QueryServiceImplBase) - Constructor for class io.spine.web.query.BlockingQueryBridge

Creates a new BlockingQueryBridge.

C

cancel(Subscription) - Method in interface io.spine.web.subscription.SubscriptionBridge

Cancel the existing subscription, which stopping sending new data updates to the client.

CommandServlet - Class in io.spine.web.command

An HttpServlet representing a command endpoint.

CommandServlet(CommandService) - Constructor for class io.spine.web.command.CommandServlet

Completion - Class in io.spine.web.future

A set of utilities for working with dignified ending for a CompletionStage.

create() - Static method in class io.spine.web.future.FutureObserver

Creates a new instance of FutureObserver.

D

destroy() - Method in class io.spine.web.AllowAnyOriginFilter

dispose(CompletionStage<?>) - Static method in class io.spine.web.future.Completion

Logs the exception of the given stage if any.

doFilter(ServletRequest, ServletResponse, FilterChain) - Method in class io.spine.web.AllowAnyOriginFilter

doPost(HttpServletRequest, HttpServletResponse) - Method in class io.spine.web.MessageServlet

F

formatOf(HttpServletRequest) - Static method in enum io.spine.web.parser.MessageFormat

Finds the required format for the given request.

FutureObserver<T> - Class in io.spine.web.future

A stream observer which can provide a CompletableFuture view on the stream.

H

handle(Command) - Method in class io.spine.web.command.CommandServlet

handle(I) - Method in class io.spine.web.MessageServlet

Handles the servlet request and produces the response message.

handle(Query) - Method in class io.spine.web.query.QueryServlet

handle(Topic) - Method in class io.spine.web.subscription.servlet.SubscribeServlet

handle(Subscription) - Method in class io.spine.web.subscription.servlet.SubscriptionCancelServlet

handle(Subscription) - Method in class io.spine.web.subscription.servlet.SubscriptionKeepUpServlet

I

init(FilterConfig) - Method in class io.spine.web.AllowAnyOriginFilter

io.spine.web - package io.spine.web

This package contains the Spine web API.

io.spine.web.command - package io.spine.web.command

This package contains the interfaces and abstract definitions for sending commands to the Spine application via web requests.

io.spine.web.future - package io.spine.web.future

This package contains classes working with Futures.

io.spine.web.parser - package io.spine.web.parser

This package contains components responsible for parsing messages sent over HTTP.

io.spine.web.query - package io.spine.web.query

This package contains the interfaces and abstract definitions for querying Spine application for data on a web request and returning a response to a client.

io.spine.web.subscription - package io.spine.web.subscription

This package contains the interfaces and abstract definitions for subscribing to entity changes in a Spine application via web requests.

io.spine.web.subscription.servlet - package io.spine.web.subscription.servlet

This package contains the servlets for handling web requests related to entity state subscriptions.

K

keepUp(Subscription) - Method in interface io.spine.web.subscription.SubscriptionBridge

Keep up the subscription, prohibiting it from closing from the server-side.

M

MessageFormat - Enum in io.spine.web.parser

Message formats supported by the Spine web API.

MessageServlet<I extends com.google.protobuf.Message,O extends com.google.protobuf.Message> - Class in io.spine.web

An HTTP servlet which accepts POST requests with a message and responds with another message.

MessageServlet() - Constructor for class io.spine.web.MessageServlet

N

NAME - Static variable in class io.spine.web.AllowAnyOriginFilter

The human readable name of this filter.

NonSerializableServlet - Class in io.spine.web

An HttpServlet which cannot be serialized.

NonSerializableServlet() - Constructor for class io.spine.web.NonSerializableServlet

O

onCompleted() - Method in class io.spine.web.future.FutureObserver

onError(Throwable) - Method in class io.spine.web.future.FutureObserver

onNext(T) - Method in class io.spine.web.future.FutureObserver

P

parse(String, Class<T>) - Method in enum io.spine.web.parser.MessageFormat

Parses a given string representation into a message of the given type.

Q

QueryBridge<T extends com.google.protobuf.Message> - Interface in io.spine.web.query

An entity query bridge.

QueryServlet<T extends com.google.protobuf.Message> - Class in io.spine.web.query

An HttpServlet which receives query requests and handles them via a QueryBridge.

QueryServlet(QueryBridge<T>) - Constructor for class io.spine.web.query.QueryServlet

Creates a new instance of QueryServlet with the given QueryBridge.

R

RequestResult<T extends com.google.protobuf.Message> - Interface in io.spine.web

A result of a request to Spine Web that can be written to a servlet response.

response() - Method in interface io.spine.web.RequestResult

S

send(Query) - Method in class io.spine.web.query.BlockingQueryBridge

send(Query) - Method in interface io.spine.web.query.QueryBridge

Sends the given Query to the QueryService and dispatches the query response to the query response processor.

subscribe(Topic) - Method in interface io.spine.web.subscription.SubscriptionBridge

Creates a new Subscription to a provided topic supplying this subscription to the client as a result.

SubscribeServlet<T extends com.google.protobuf.Message> - Class in io.spine.web.subscription.servlet

An abstract servlet for a client request to create a new Subscription for the requested Topic.

SubscribeServlet(SubscriptionBridge<T, ?, ?>) - Constructor for class io.spine.web.subscription.servlet.SubscribeServlet

Creates a new instance of SubscribeServlet with the given SubscriptionBridge.

SubscriptionBridge<S extends com.google.protobuf.Message,K extends com.google.protobuf.Message,C extends com.google.protobuf.Message> - Interface in io.spine.web.subscription

A bridge for requests to a subscription SubscriptionService.

SubscriptionCancelServlet<T extends com.google.protobuf.Message> - Class in io.spine.web.subscription.servlet

An abstract servlet for a client request to cancel an existing Subscription.

SubscriptionCancelServlet(SubscriptionBridge<?, ?, T>) - Constructor for class io.spine.web.subscription.servlet.SubscriptionCancelServlet

Creates a new instance of SubscriptionCancelServlet with the given SubscriptionBridge.

SubscriptionKeepUpServlet<T extends com.google.protobuf.Message> - Class in io.spine.web.subscription.servlet

An abstract servlet for a client request to keep up an existing Subscription.

SubscriptionKeepUpServlet(SubscriptionBridge<?, T, ?>) - Constructor for class io.spine.web.subscription.servlet.SubscriptionKeepUpServlet

Creates a new instance of SubscriptionKeepUpServlet with the given SubscriptionBridge.

T

toFuture() - Method in class io.spine.web.future.FutureObserver

Retrieves the future view on this observer result.

V

valueOf(String) - Static method in enum io.spine.web.parser.MessageFormat

Returns the enum constant of this type with the specified name.

values() - Static method in enum io.spine.web.parser.MessageFormat

Returns an array containing the constants of this enum type, in the order they are declared.

W

withDefault(T) - Static method in class io.spine.web.future.FutureObserver

Creates a new instance of FutureObserver with the given defaultValue.

A B C D F H I K M N O P Q R S T V W