Skip navigation links
A B C D E F G H I L M O P R S T U V W 

A

and(Middleware<? super T, ? extends K>) - Method in interface com.spotify.apollo.route.Middleware
 
AppInit - Interface in com.spotify.apollo
An application initializer that will set up the application using an Environment.
arrivalTimeNanos() - Method in interface com.spotify.apollo.RequestContext
Get the arrival time of the incoming request in nanoseconds.
async(String, String, AsyncHandler<T>) - Static method in interface com.spotify.apollo.route.Route
 
AsyncHandler<T> - Interface in com.spotify.apollo.route
Asynchronous endpoint handler.

B

byteString() - Method in interface com.spotify.apollo.Serializer.Payload
Deprecated.
The bytes of the payload.

C

clearHeaders() - Method in interface com.spotify.apollo.Request
Creates a new Request based on this, but with no header information.
Client - Interface in com.spotify.apollo
An Apollo service client.
client() - Method in interface com.spotify.apollo.Environment
Get an Apollo client for communicating with a backend service.
closer() - Method in interface com.spotify.apollo.Environment
Returns a Closer which can be used to register resources that need to be closed on application shutdown.
code() - Method in enum com.spotify.apollo.Status
 
code() - Method in class com.spotify.apollo.Status.WithReasonPhrase
 
code() - Method in interface com.spotify.apollo.StatusType
 
com.spotify.apollo - package com.spotify.apollo
 
com.spotify.apollo.route - package com.spotify.apollo.route
 
config() - Method in interface com.spotify.apollo.Environment
Returns configuration loaded by the framework on an application behalf.
contentType() - Method in interface com.spotify.apollo.Serializer.Payload
Deprecated.
An optional content-type
copy(String, String, K, Route.DocString) - Method in interface com.spotify.apollo.route.Route
 
create(Environment) - Method in interface com.spotify.apollo.AppInit
Sets up an application.
create(ByteString) - Static method in class com.spotify.apollo.Payloads
Deprecated.
Create a Serializer.Payload from ByteString without contentType
create(ByteString, String) - Static method in class com.spotify.apollo.Payloads
Deprecated.
Create a Serializer.Payload from ByteString with the specified contentType
create(ByteString, Optional<String>) - Static method in class com.spotify.apollo.Payloads
Deprecated.
Create a Serializer.Payload from ByteString with an optional contentType
create(String, String, H, Route.DocString) - Static method in interface com.spotify.apollo.route.Route
 
create(String, String, H) - Static method in interface com.spotify.apollo.route.Route
 
create(int, String) - Static method in class com.spotify.apollo.Status.WithReasonPhrase
 
createForCode(int) - Static method in enum com.spotify.apollo.Status
 

D

description() - Method in class com.spotify.apollo.route.Route.DocString
 
doc(String, String) - Static method in class com.spotify.apollo.route.Route.DocString
 
docString() - Method in interface com.spotify.apollo.route.Route
 
DocString() - Constructor for class com.spotify.apollo.route.Route.DocString
 
domain() - Method in interface com.spotify.apollo.Environment
The domain that the application is running in.

E

Environment - Interface in com.spotify.apollo
An interface that an application can use to interact with the execution environment of an Apollo application.
Environment.RoutingEngine - Interface in com.spotify.apollo
 
existingFromStatusCode(int) - Static method in enum com.spotify.apollo.Status
 

F

family() - Method in enum com.spotify.apollo.Status
 
family() - Method in class com.spotify.apollo.Status.WithReasonPhrase
 
family() - Method in interface com.spotify.apollo.StatusType
 
familyOf(int) - Static method in enum com.spotify.apollo.StatusType.Family
Get the response status family for the status code.
findExistingFromStatusCode(int) - Static method in enum com.spotify.apollo.Status
 
flatMap(Function<? super T, ? extends AsyncHandler<? extends V>>) - Method in interface com.spotify.apollo.route.AsyncHandler
Create a new AsyncHandler that will map the return value of invoke(RequestContext) through the given map function.
flatMap(Function<? super T, ? extends SyncHandler<? extends V>>) - Method in interface com.spotify.apollo.route.SyncHandler
Create a new SyncHandler that will map the return value of SyncHandler.invoke(RequestContext) through the given map function.
flatMapSync(Function<? super T, ? extends SyncHandler<? extends V>>) - Method in interface com.spotify.apollo.route.AsyncHandler
Synchronous version of flatMap(Function).
forPayload(T) - Static method in interface com.spotify.apollo.Response
Creates a 200 OK Response with the given payload of type T .
forStatus(StatusType) - Static method in interface com.spotify.apollo.Response
Creates a Response with the given status code.
forUri(String, String) - Static method in interface com.spotify.apollo.Request
Creates a Request for the given uri and method.
forUri(String) - Static method in interface com.spotify.apollo.Request
Creates a Request for the given uri.
future(String, String, ListenableFutureHandler<T>) - Static method in interface com.spotify.apollo.route.Route
 

G

guavaToAsync(ListenableFutureHandler<T>) - Static method in interface com.spotify.apollo.route.Middleware
 

H

handler() - Method in interface com.spotify.apollo.route.Route
 
header(String) - Method in interface com.spotify.apollo.Request
A header of the request message, or empty if no header with that name is found.
headers() - Method in interface com.spotify.apollo.Request
The headers of the request message.
headers() - Method in interface com.spotify.apollo.Response
The response headers.

I

invoke(RequestContext) - Method in interface com.spotify.apollo.route.AsyncHandler
 
invoke(RequestContext) - Method in interface com.spotify.apollo.route.ListenableFutureHandler
 
invoke(RequestContext) - Method in interface com.spotify.apollo.route.SyncHandler
 

L

ListenableFutureHandler<T> - Interface in com.spotify.apollo.route
Asynchronous endpoint handler.

M

map(Function<? super T, ? extends V>) - Method in interface com.spotify.apollo.route.AsyncHandler
Create a new AsyncHandler that will map the return value of invoke(RequestContext) through the given map function.
map(Function<? super T, ? extends V>) - Method in interface com.spotify.apollo.route.SyncHandler
Create a new SyncHandler that will map the return value of SyncHandler.invoke(RequestContext) through the given map function.
method() - Method in interface com.spotify.apollo.Request
The method of the request message.
method() - Method in interface com.spotify.apollo.route.Route
 
Middleware<H,T> - Interface in com.spotify.apollo.route
Defines a function that can be used to share functionality among routes using Route.with(Middleware, String, String, Object).

O

of(StatusType, T) - Static method in interface com.spotify.apollo.Response
Creates a Response with the given status code and a payload with type T.
ok() - Static method in interface com.spotify.apollo.Response
Returns a typed 200 OK Response.

P

parameter(String) - Method in interface com.spotify.apollo.Request
A uri query parameter of the request message, or empty if no parameter with that name is found.
parameters() - Method in interface com.spotify.apollo.Request
The uri query parameters of the request message.
pathArgs() - Method in interface com.spotify.apollo.RequestContext
Gets a map of parsed path arguments.
payload() - Method in interface com.spotify.apollo.Request
The request message payload, or empty if there is no payload.
payload() - Method in interface com.spotify.apollo.Response
The single payload of the response.
Payloads - Class in com.spotify.apollo
Deprecated.
the new preferred way to do response serialization is via a Middleware, see Serializer.

R

rangeName() - Method in enum com.spotify.apollo.StatusType.Family
 
reasonPhrase() - Method in enum com.spotify.apollo.Status
 
reasonPhrase() - Method in class com.spotify.apollo.Status.WithReasonPhrase
 
reasonPhrase() - Method in interface com.spotify.apollo.StatusType
 
registerAutoRoute(Route<? extends AsyncHandler<?>>) - Method in interface com.spotify.apollo.Environment.RoutingEngine
Registers a Route.
registerAutoRoutes(RouteProvider) - Method in interface com.spotify.apollo.Environment.RoutingEngine
Registers a RouteProvider.
registerRoute(Route<? extends AsyncHandler<? extends Response<ByteString>>>) - Method in interface com.spotify.apollo.Environment.RoutingEngine
Registers a Route.
registerRoutes(Stream<? extends Route<? extends AsyncHandler<? extends Response<ByteString>>>>) - Method in interface com.spotify.apollo.Environment.RoutingEngine
Registers routes.
Request - Interface in com.spotify.apollo
Defines the data Apollo presents for an incoming request.
request() - Method in interface com.spotify.apollo.RequestContext
Get the incoming request message.
RequestContext - Interface in com.spotify.apollo
This object contains all the needed information related to an incoming request.
requestScopedClient() - Method in interface com.spotify.apollo.RequestContext
Get an Apollo client that can be used to make backend service requests.
resolve(Class<T>) - Method in interface com.spotify.apollo.Environment
Resolves an instance of a class out of the underlying apollo-core module system.
Response<T> - Interface in com.spotify.apollo
Defines the data Apollo needs to construct and send a response to an incoming request.
Route<H> - Interface in com.spotify.apollo.route
The Route defines an endpoint to the service.
Route.DocString - Class in com.spotify.apollo.route
 
RouteProvider - Interface in com.spotify.apollo.route
A programmatic way of defining Routes in an Apollo service.
routes() - Method in interface com.spotify.apollo.route.RouteProvider
 
routingEngine() - Method in interface com.spotify.apollo.Environment
Returns the Environment.RoutingEngine of this application.

S

send(Request) - Method in interface com.spotify.apollo.Client
Send a Request and get an asynchronous Response as a CompletionStage.
serialize(Request, Object) - Method in interface com.spotify.apollo.Serializer
Deprecated.
Produce a Serializer.Payload from the incoming request Request and the endpoint returned object.
Serializer - Interface in com.spotify.apollo
Deprecated.
This interface is deprecated; the new preferred way to do response serialization is via a Middleware that converts the response object into a Response. The reasons for preferring a Middleware are: - This interface is not typesafe, whereas Middlewares can be. This means the compiler can help you spot mistakes. Simply define your Middleware as a function from something like AsyncHandler<MyDomainObject> to AsyncHandler<Response<ByteString>>. - Middlewares are more powerful; they can directly set headers and can also modify other things on the Response, such as status codes and reason phrases.
Serializer.Payload - Interface in com.spotify.apollo
Deprecated.
 
service() - Method in interface com.spotify.apollo.Request
The calling service of the request, if known.
status() - Method in interface com.spotify.apollo.Response
The status of the response message.
Status - Enum in com.spotify.apollo
Lists more-or-less common status codes, taken from http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html.
Status.WithReasonPhrase - Class in com.spotify.apollo
 
StatusType - Interface in com.spotify.apollo
Definition of a type for HTTP status codes.
StatusType.Family - Enum in com.spotify.apollo
Defines classes of status codes as described in http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html, using the name Family since 'class' is overloaded in Java.
summary() - Method in class com.spotify.apollo.route.Route.DocString
 
sync(String, String, SyncHandler<T>) - Static method in interface com.spotify.apollo.route.Route
 
SyncHandler<T> - Interface in com.spotify.apollo.route
Synchronous endpoint handler.
syncToAsync(SyncHandler<T>) - Static method in interface com.spotify.apollo.route.Middleware
 

T

ttl() - Method in interface com.spotify.apollo.Request
The request ttl.

U

uri() - Method in interface com.spotify.apollo.Request
The uri of the request message.
uri() - Method in interface com.spotify.apollo.route.Route
 

V

valueOf(String) - Static method in enum com.spotify.apollo.Status
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.spotify.apollo.StatusType.Family
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.spotify.apollo.Status
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.spotify.apollo.StatusType.Family
Returns an array containing the constants of this enum type, in the order they are declared.

W

with(Middleware<? super H, ? extends K>, String, String, H) - Static method in interface com.spotify.apollo.route.Route
Allows creating routes with middleware and lambdas in a type-inference-proof way.
withContentTypeIfAbsent(String) - Method in interface com.spotify.apollo.Serializer.Payload
Deprecated.
Create a new Serializer.Payload based on the content of this instance but with the given contentType if no contentType is present already.
withDocString(String, String) - Method in interface com.spotify.apollo.route.Route
 
withHandler(K) - Method in interface com.spotify.apollo.route.Route
 
withHeader(String, String) - Method in interface com.spotify.apollo.Request
Creates a new Request based on this, but with an additional header.
withHeader(String, String) - Method in interface com.spotify.apollo.Response
Creates a new Response based on this, but with an additional header.
withHeaders(Map<String, String>) - Method in interface com.spotify.apollo.Request
Creates a new Request based on this, but with additional headers.
withHeaders(Map<String, String>) - Method in interface com.spotify.apollo.Response
Creates a new Response based on this, but with additional headers.
withMiddleware(Middleware<? super H, ? extends K>) - Method in interface com.spotify.apollo.route.Route
 
withPayload(ByteString) - Method in interface com.spotify.apollo.Request
Creates a new Request based on this, but with a different payload.
withPayload(P) - Method in interface com.spotify.apollo.Response
Creates a new Response based on this, but with a different payload.
withPrefix(String) - Method in interface com.spotify.apollo.route.Route
 
withReasonPhrase(String) - Method in enum com.spotify.apollo.Status
 
WithReasonPhrase() - Constructor for class com.spotify.apollo.Status.WithReasonPhrase
 
withReasonPhrase(String) - Method in class com.spotify.apollo.Status.WithReasonPhrase
 
withReasonPhrase(String) - Method in interface com.spotify.apollo.StatusType
Returns a StatusType instance with the same code value as the current instance, but using the supplied reasonPhrase.
withService(String) - Method in interface com.spotify.apollo.Request
Creates a new Request based on this, but with a different calling service.
withTtl(Duration) - Method in interface com.spotify.apollo.Request
Creates a new Request based on this, but with a different ttl.
withUri(String) - Method in interface com.spotify.apollo.Request
Creates a new Request based on this, but with a different URI.
A B C D E F G H I L M O P R S T U V W 
Skip navigation links

Copyright © 2016. All rights reserved.