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

A

AbstractApolloModule - Class in com.spotify.apollo.module
A base implementation of an Apollo module.
AbstractApolloModule() - Constructor for class com.spotify.apollo.module.AbstractApolloModule
 
activeTracked - Variable in class com.spotify.apollo.test.experimental.ResponseTimeMetric
 
addMethod(String) - Method in interface com.spotify.apollo.meta.model.MetaGatherer.EndpointGatherer
 
addQueryParameterName(String) - Method in interface com.spotify.apollo.meta.model.MetaGatherer.EndpointGatherer
 
and(Middleware<? super T, ? extends K>) - Method in interface com.spotify.apollo.route.Middleware
 
ApolloCliException - Exception in com.spotify.apollo.core
An exception related to command-line processing.
ApolloCliException(String) - Constructor for exception com.spotify.apollo.core.ApolloCliException
 
ApolloCliException(String, Throwable) - Constructor for exception com.spotify.apollo.core.ApolloCliException
 
ApolloConfig - Class in com.spotify.apollo.environment
Configuration object for keys under the apollo keyspace
ApolloConfig(Config) - Constructor for class com.spotify.apollo.environment.ApolloConfig
 
ApolloConfigurationException - Exception in com.spotify.apollo.core
Thrown if the Apollo configuration is invalid due to a programmer error, e.g.
ApolloConfigurationException(String, Throwable) - Constructor for exception com.spotify.apollo.core.ApolloConfigurationException
 
apolloDefaults() - Static method in class com.spotify.apollo.route.Middlewares
Returns the default middlewares applied by Apollo to routes supplied by a RouteProvider.
ApolloEnvironment - Interface in com.spotify.apollo.environment
 
ApolloEnvironmentModule - Class in com.spotify.apollo.environment
A module setting up implementations of Apollo API Framework components such as Environment, Environment.RoutingEngine and a managed Client.
ApolloEnvironmentModule() - Constructor for class com.spotify.apollo.environment.ApolloEnvironmentModule
 
ApolloException - Exception in com.spotify.apollo.core
 
ApolloException() - Constructor for exception com.spotify.apollo.core.ApolloException
 
ApolloException(String) - Constructor for exception com.spotify.apollo.core.ApolloException
 
ApolloException(String, Throwable) - Constructor for exception com.spotify.apollo.core.ApolloException
 
ApolloException(Throwable) - Constructor for exception com.spotify.apollo.core.ApolloException
 
ApolloHelpException - Exception in com.spotify.apollo.core
An exception indicating that the user wants to show help information.
ApolloHelpException(String) - Constructor for exception com.spotify.apollo.core.ApolloHelpException
 
ApolloModule - Interface in com.spotify.apollo.module
A module that can be loaded by Apollo to add more functionality to a service.
apolloVersion() - Method in class com.spotify.apollo.meta.MetaDescriptor
 
AppInit - Interface in com.spotify.apollo
An application initializer that will set up the application using an Environment.
ApplicationOrMetaRouter<E> - Class in com.spotify.apollo.meta
 
ApplicationOrMetaRouter(ApplicationRouter<E>, ApplicationRouter<E>) - Constructor for class com.spotify.apollo.meta.ApplicationOrMetaRouter
 
ApplicationRouter<T> - Interface in com.spotify.apollo.route
 
apply(Statement, Description) - Method in class com.spotify.apollo.test.ServiceHelper
 
args(String...) - Method in class com.spotify.apollo.test.ServiceHelper
Run the service with the given program arguments.
arrivalTimeNanos() - Method in class com.spotify.apollo.request.ForwardingOngoingRequest
 
arrivalTimeNanos() - Method in interface com.spotify.apollo.request.OngoingRequest
Get the arrival time of the incoming request in nanoseconds.
arrivalTimeNanos() - Method in class com.spotify.apollo.request.RequestContexts
 
arrivalTimeNanos() - Method in interface com.spotify.apollo.RequestContext
Get the arrival time of the incoming request in nanoseconds.
asFuture(CompletionStage<T>) - Static method in class com.spotify.apollo.concurrent.Util
 
asStage(ListenableFuture<T>) - Static method in class com.spotify.apollo.concurrent.Util
 
asUnawareClient() - Method in interface com.spotify.apollo.environment.IncomingRequestAwareClient
 
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.
AsyncRequester - Class in com.spotify.apollo.test.experimental
 
AsyncRequester(ScheduledExecutorService) - Constructor for class com.spotify.apollo.test.experimental.AsyncRequester
 
autoSerialize(AsyncHandler<T>) - Static method in class com.spotify.apollo.route.Middlewares
Converts an AsyncHandler with unspecified return type to one that returns Response<ByteString>.
AutoSerializer - Class in com.spotify.apollo.serialization
Deprecated.
the new preferred way to do response serialization is via a Middleware, see Serializer.
AutoSerializer() - Constructor for class com.spotify.apollo.serialization.AutoSerializer
Deprecated.
 

B

backend() - Method in class com.spotify.apollo.environment.ApolloConfig
 
belongsToFamily(StatusType.Family) - Static method in class com.spotify.apollo.test.unit.StatusTypeMatchers
Builds a matcher for StatusTypes belonging to a StatusType.Family.
boot(AppInit, String, String...) - Static method in class com.spotify.apollo.httpservice.HttpService
 
boot(AppInit, String, InstanceListener, String...) - Static method in class com.spotify.apollo.httpservice.HttpService
 
boot(Service, String...) - Static method in class com.spotify.apollo.httpservice.HttpService
 
boot(Service, InstanceListener, String...) - Static method in class com.spotify.apollo.httpservice.HttpService
 
boot(Service, InstanceListener, Thread.UncaughtExceptionHandler, String...) - Static method in class com.spotify.apollo.httpservice.HttpService
Boot up a service and wait for it to shut down.
build() - Method in interface com.spotify.apollo.core.Service.Builder
Creates a new service based off of this builder.
build() - Method in class com.spotify.apollo.environment.EnvironmentFactoryBuilder
 
builder(String) - Static method in class com.spotify.apollo.httpservice.HttpService
 
buildVersion() - Method in interface com.spotify.apollo.meta.model.Model.MetaInfo
 
byteString() - Method in interface com.spotify.apollo.Serializer.Payload
Deprecated.
The bytes of the payload.

C

call() - Method in class com.spotify.apollo.test.experimental.PerformanceFixture
Dummy implementation that should be overriden if doing perf tests with pump.
CallResult(long, boolean, int) - Constructor for class com.spotify.apollo.test.experimental.ResponseTimeMetric.CallResult
 
calls() - Method in class com.spotify.apollo.meta.model.DefaultMetaGatherer
 
calls() - Method in interface com.spotify.apollo.meta.model.MetaGatherer
 
clear() - Method in class com.spotify.apollo.test.experimental.PerformanceFixture
 
clear() - Method in class com.spotify.apollo.test.StubClient
Clears the previously setup request to response mappings, but not the history of sent messages.
clearHeaders() - Method in interface com.spotify.apollo.Request
Creates a new Request based on this, but with no header information.
clearRequests() - Method in class com.spotify.apollo.test.StubClient
Clears the requests and responses tracked by this client.
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.
client - Variable in class com.spotify.apollo.test.experimental.PerformanceFixture
 
ClientDecorator - Interface in com.spotify.apollo.environment
Allows the user to decorate the managed IncomingRequestAwareClient with additional behavior.
close() - Method in class com.spotify.apollo.request.RequestTracker
 
close() - Method in class com.spotify.apollo.test.ServiceHelper
 
close() - Method in class com.spotify.apollo.test.StubClient
 
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.concurrent - package com.spotify.apollo.concurrent
 
com.spotify.apollo.core - package com.spotify.apollo.core
 
com.spotify.apollo.dispatch - package com.spotify.apollo.dispatch
 
com.spotify.apollo.environment - package com.spotify.apollo.environment
 
com.spotify.apollo.http.client - package com.spotify.apollo.http.client
 
com.spotify.apollo.http.server - package com.spotify.apollo.http.server
 
com.spotify.apollo.httpservice - package com.spotify.apollo.httpservice
 
com.spotify.apollo.meta - package com.spotify.apollo.meta
 
com.spotify.apollo.meta.model - package com.spotify.apollo.meta.model
 
com.spotify.apollo.module - package com.spotify.apollo.module
 
com.spotify.apollo.request - package com.spotify.apollo.request
 
com.spotify.apollo.route - package com.spotify.apollo.route
 
com.spotify.apollo.serialization - package com.spotify.apollo.serialization
 
com.spotify.apollo.slack - package com.spotify.apollo.slack
 
com.spotify.apollo.test - package com.spotify.apollo.test
 
com.spotify.apollo.test.experimental - package com.spotify.apollo.test.experimental
 
com.spotify.apollo.test.response - package com.spotify.apollo.test.response
 
com.spotify.apollo.test.unit - package com.spotify.apollo.test.unit
 
conf(String, String) - Method in class com.spotify.apollo.test.ServiceHelper
Run the service with the key/value pair defined in the loaded configuration.
conf(String, Object) - Method in class com.spotify.apollo.test.ServiceHelper
Run the service with the key/value pair defined in the loaded configuration.
config() - Method in interface com.spotify.apollo.Environment
Returns configuration loaded by the framework on an application behalf.
configure() - Method in class com.spotify.apollo.environment.ApolloEnvironmentModule
 
configure() - Method in class com.spotify.apollo.http.client.HttpClientModule
 
configure() - Method in class com.spotify.apollo.http.server.HttpServerModule
 
configure() - Method in class com.spotify.apollo.slack.SlackModule
 
ConfigUtil - Class in com.spotify.apollo.environment
Helper functions for reading keys as Optional values.
constant(ResponseWithDelay) - Static method in class com.spotify.apollo.test.response.Responses
 
containerVersion() - Method in interface com.spotify.apollo.meta.model.Model.MetaInfo
 
contentType - Variable in class com.spotify.apollo.meta.model.Model.PayloadSchema
 
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(OngoingRequest, RequestContext, Endpoint) - Method in class com.spotify.apollo.dispatch.EndpointInvocationHandler
 
create() - Static method in class com.spotify.apollo.environment.ApolloEnvironmentModule
 
create(String, EnvironmentFactory.RoutingContext) - Method in interface com.spotify.apollo.environment.EnvironmentFactory
Create a new application environment.
create() - Static method in class com.spotify.apollo.http.client.HttpClientModule
 
create() - Static method in class com.spotify.apollo.http.server.HttpServerModule
 
create(String, String) - Static method in class com.spotify.apollo.meta.Descriptor
Create a new application artifact descriptor.
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(OngoingRequest, RequestContext, Endpoint) - Method in interface com.spotify.apollo.request.EndpointRunnableFactory
 
create(Request, Client, Map<String, String>) - Static method in class com.spotify.apollo.request.RequestContexts
 
create(Request, Client, Map<String, String>, long) - Static method in class com.spotify.apollo.request.RequestContexts
 
create(OngoingRequest) - Method in interface com.spotify.apollo.request.RequestRunnableFactory
 
create(String, InetSocketAddress) - Static method in class com.spotify.apollo.request.ServerInfos
 
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() - Static method in class com.spotify.apollo.slack.SlackModule
 
create(int, String) - Static method in class com.spotify.apollo.Status.WithReasonPhrase
 
create(Request) - Method in interface com.spotify.apollo.test.response.ResponseSource
 
create(AppInit, String) - Static method in class com.spotify.apollo.test.ServiceHelper
Creates a ServiceHelper using the given AppInit and service name.
create(AppInit, String, StubClient) - Static method in class com.spotify.apollo.test.ServiceHelper
Creates a ServiceHelper using the given AppInit, service name and stub client.
create(Request, Response<ByteString>) - Static method in class com.spotify.apollo.test.StubClient.RequestResponsePair
 
createForCode(int) - Static method in enum com.spotify.apollo.Status
 
createGatherer(Model.MetaInfo) - Static method in class com.spotify.apollo.meta.model.Meta
 
createGatherer(Model.MetaInfo, Config) - Static method in class com.spotify.apollo.meta.model.Meta
 
createMetric() - Method in class com.spotify.apollo.test.experimental.PerformanceFixture
Create a metric for tracking load tests.
createRoutingContext() - Method in interface com.spotify.apollo.environment.EnvironmentFactory
Creates a EnvironmentFactory.RoutingContext to be used with an Environment.

D

DEFAULT_SIZE_LIMIT - Static variable in class com.spotify.apollo.meta.model.DefaultMetaGatherer
 
DefaultMetaGatherer - Class in com.spotify.apollo.meta.model
 
description() - Method in class com.spotify.apollo.route.Route.DocString
 
Descriptor - Class in com.spotify.apollo.meta
Describes an application with serviceName and version.
Descriptor() - Constructor for class com.spotify.apollo.meta.Descriptor
 
descriptor() - Method in class com.spotify.apollo.meta.MetaDescriptor
 
disableMetaApi() - Method in class com.spotify.apollo.test.ServiceHelper
Don't set up /_meta/* routes for the application.
doc(String, String) - Static method in class com.spotify.apollo.route.Route.DocString
 
docstring - Variable in class com.spotify.apollo.meta.model.Model.EndpointInfo
 
docstring - Variable in class com.spotify.apollo.meta.model.Model.EndpointsInfo
 
docString() - Method in interface com.spotify.apollo.route.Route
 
DocString() - Constructor for class com.spotify.apollo.route.Route.DocString
 
doesNotHaveHeader(String) - Static method in class com.spotify.apollo.test.unit.ResponseMatchers
Builds a matcher for Responses without specific header.
domain() - Method in interface com.spotify.apollo.Environment
The domain that the application is running in.
domain(String) - Method in class com.spotify.apollo.test.ServiceHelper
Run the service in the given domain.
drop() - Method in class com.spotify.apollo.request.ForwardingOngoingRequest
 
drop() - Method in interface com.spotify.apollo.request.OngoingRequest
Drop the request.
drop() - Method in class com.spotify.apollo.test.FakeOngoingRequest
 

E

either(Optional<T>, Optional<T>) - Static method in class com.spotify.apollo.environment.ConfigUtil
 
elapsed - Variable in class com.spotify.apollo.test.experimental.ResponseTimeMetric.CallResult
 
enableIncomingRequestLogging() - Method in class com.spotify.apollo.environment.ApolloConfig
 
enableMetaApi() - Method in class com.spotify.apollo.environment.ApolloConfig
 
enableOutgoingRequestLogging() - Method in class com.spotify.apollo.environment.ApolloConfig
 
Endpoint - Interface in com.spotify.apollo.dispatch
An application endpoint that can handle a specific uri pattern.
EndpointInfo - Class in com.spotify.apollo.dispatch
 
EndpointInfo(String, String, String, Optional<Route.DocString>) - Constructor for class com.spotify.apollo.dispatch.EndpointInfo
 
EndpointInfo() - Constructor for class com.spotify.apollo.meta.model.Model.EndpointInfo
 
EndpointInvocationHandler - Class in com.spotify.apollo.dispatch
 
EndpointInvocationHandler() - Constructor for class com.spotify.apollo.dispatch.EndpointInvocationHandler
 
endpointObjects() - Method in interface com.spotify.apollo.environment.EnvironmentFactory.RoutingContext
 
EndpointRunnableFactory - Interface in com.spotify.apollo.request
A factory responsible for producting a Runnable that encapsulates the handling of a OngoingRequest together with the RequestContext that is made available to the Endpoint.
endpointRunnableFactory() - Static method in class com.spotify.apollo.request.Handlers
 
EndpointRunnableFactoryDecorator - Interface in com.spotify.apollo.environment
A decorator for modifying the behavior of a EndpointRunnableFactory.
endpoints() - Method in class com.spotify.apollo.meta.model.DefaultMetaGatherer
 
endpoints() - Method in interface com.spotify.apollo.meta.model.MetaGatherer
 
endpoints - Variable in class com.spotify.apollo.meta.model.Model.EndpointsInfo
 
EndpointsInfo() - Constructor for class com.spotify.apollo.meta.model.Model.EndpointsInfo
 
Environment - Interface in com.spotify.apollo
An interface that an application can use to interact with the execution environment of an Apollo application.
environment() - Method in interface com.spotify.apollo.environment.ApolloEnvironment
 
environment(Service.Instance) - Static method in class com.spotify.apollo.environment.ApolloEnvironmentModule
Gets the ApolloEnvironment that can be used to initialize applications.
Environment.RoutingEngine - Interface in com.spotify.apollo
 
EnvironmentConfigResolver - Interface in com.spotify.apollo.environment
 
EnvironmentFactory - Interface in com.spotify.apollo.environment
A factory that provides Apollo application environments.
EnvironmentFactory.Resolver - Interface in com.spotify.apollo.environment
 
EnvironmentFactory.RoutingContext - Interface in com.spotify.apollo.environment
A EnvironmentFactory.RoutingContext is a context object for routing components set up by the application.
EnvironmentFactoryBuilder - Class in com.spotify.apollo.environment
 
executor - Variable in class com.spotify.apollo.test.experimental.AsyncRequester
 
executor - Variable in class com.spotify.apollo.test.experimental.PerformanceFixture
 
existingFromStatusCode(int) - Static method in enum com.spotify.apollo.Status
 
expand(Stream<VersionedRoute>) - Method in class com.spotify.apollo.route.Versions
 
ExternalCallsInfo() - Constructor for class com.spotify.apollo.meta.model.Model.ExternalCallsInfo
 
extract(int) - Method in class com.spotify.apollo.route.RuleMatch
 

F

FakeOngoingRequest - Class in com.spotify.apollo.test
A mock service request used when injecting a request into an Apollo application.
FakeOngoingRequest(Request) - Constructor for class com.spotify.apollo.test.FakeOngoingRequest
Create a new mock service request holding an Apollo Request.
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 AsyncHandler.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 AsyncHandler.flatMap(Function).
forPayload(T) - Static method in interface com.spotify.apollo.Response
Creates a 200 OK Response with the given payload of type T .
forResponse(Response<ByteString>) - Static method in class com.spotify.apollo.test.response.ResponseWithDelay
 
forResponse(Response<ByteString>, long, TimeUnit) - Static method in class com.spotify.apollo.test.response.ResponseWithDelay
 
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.
forwardingNonStubbedRequests(boolean) - Method in class com.spotify.apollo.test.ServiceHelper
Determines whether to forward requests for which nothing has been stubbed.
ForwardingOngoingRequest - Class in com.spotify.apollo.request
A delegating implementation of OngoingRequest useful for implementing decorators.
ForwardingOngoingRequest(OngoingRequest) - Constructor for class com.spotify.apollo.request.ForwardingOngoingRequest
 
from(int) - Static method in class com.spotify.apollo.route.Versions
 
fromUri(String, List<String>, T) - Static method in class com.spotify.apollo.route.Rule
Create a new rule.
fromUri(String, String, T) - Static method in class com.spotify.apollo.route.Rule
Create a new rule.
future(String, String, ListenableFutureHandler<T>) - Static method in interface com.spotify.apollo.route.Route
 

G

gatherEndpoints(List<E>) - Method in class com.spotify.apollo.meta.MetaInfoTracker
 
gatherIncomingCall(OngoingRequest, Endpoint) - Method in interface com.spotify.apollo.meta.IncomingCallsGatherer
 
gatherOutgoingCall(String, Request) - Method in interface com.spotify.apollo.meta.OutgoingCallsGatherer
 
getAverageTime() - Method in class com.spotify.apollo.test.experimental.ResponseTimeMetric
 
getCloser() - Method in interface com.spotify.apollo.core.Service.Instance
Returns a Closer for convenience, where you can register Closeables that should be closed when the application exits.
getConfig() - Method in interface com.spotify.apollo.core.Service.Instance
Returns the configuration for this service instance.
getConfig(String) - Method in interface com.spotify.apollo.environment.EnvironmentConfigResolver
 
getDelayMillis() - Method in class com.spotify.apollo.test.response.ResponseWithDelay
 
getDocString() - Method in class com.spotify.apollo.dispatch.EndpointInfo
 
getExecutorService() - Method in interface com.spotify.apollo.core.Service.Instance
Returns a shared ListeningExecutorService that has virtually infinite capacity and that can be used for long-running jobs.
getExtractionCount() - Method in class com.spotify.apollo.route.Rule
 
getGatherer() - Method in class com.spotify.apollo.meta.MetaInfoTracker
 
getId() - Method in class com.spotify.apollo.environment.ApolloEnvironmentModule
 
getId() - Method in class com.spotify.apollo.http.client.HttpClientModule
 
getId() - Method in class com.spotify.apollo.http.server.HttpServerModule
 
getId() - Method in interface com.spotify.apollo.module.ApolloModule
Returns the id for this module.
getId() - Method in class com.spotify.apollo.slack.SlackModule
 
getIncomingCallsGatherer(String) - Method in class com.spotify.apollo.meta.model.DefaultMetaGatherer
 
getIncomingCallsGatherer(String) - Method in interface com.spotify.apollo.meta.model.MetaGatherer
 
getJavaMethodName() - Method in class com.spotify.apollo.dispatch.EndpointInfo
 
getKey() - Method in enum com.spotify.apollo.core.Services.CommonConfigKeys
 
getLifecycleManaged() - Method in class com.spotify.apollo.module.AbstractApolloModule
 
getLifecycleManaged() - Method in interface com.spotify.apollo.module.ApolloModule
Returns the immutable, idempotently determined and stable set of injection keys that should be bound to the service lifecycle; i.e.
getMethods() - Method in class com.spotify.apollo.route.Rule
 
getMethodsForValidRules(Request) - Method in class com.spotify.apollo.meta.ApplicationOrMetaRouter
 
getMethodsForValidRules(Request) - Method in interface com.spotify.apollo.route.ApplicationRouter
Returns a collection of valid methods (such as GET and POST) for the URI of the provided request.
getMethodsForValidRules(Request) - Method in class com.spotify.apollo.route.RuleRouter
 
getName() - Method in class com.spotify.apollo.dispatch.EndpointInfo
 
getOutgoingCallsGatherer(String) - Method in class com.spotify.apollo.meta.model.DefaultMetaGatherer
 
getOutgoingCallsGatherer(String) - Method in interface com.spotify.apollo.meta.model.MetaGatherer
 
getPath() - Method in class com.spotify.apollo.route.Rule
 
getPriority() - Method in class com.spotify.apollo.http.server.HttpServerModule
 
getPriority() - Method in class com.spotify.apollo.module.AbstractApolloModule
 
getPriority() - Method in interface com.spotify.apollo.module.ApolloModule
Returns the priority of this module relative to other modules.
getPriority() - Method in class com.spotify.apollo.slack.SlackModule
 
getReply() - Method in class com.spotify.apollo.test.FakeOngoingRequest
Get a future holding the reply.
getRequestMethod() - Method in class com.spotify.apollo.dispatch.EndpointInfo
 
getResponse() - Method in class com.spotify.apollo.test.response.ResponseWithDelay
 
getRule() - Method in class com.spotify.apollo.route.RuleMatch
 
getRuleTargets() - Method in class com.spotify.apollo.meta.ApplicationOrMetaRouter
 
getRuleTargets() - Method in interface com.spotify.apollo.route.ApplicationRouter
Return a list of all target objects that this router handles.
getRuleTargets() - Method in class com.spotify.apollo.route.RuleRouter
 
getScheduledExecutorService() - Method in interface com.spotify.apollo.core.Service.Instance
Returns a shared ListeningScheduledExecutorService that has capacity appropriate for scheduled jobs, i.e.
getService() - Method in interface com.spotify.apollo.core.Service.Instance
Returns the service that this is an instance of.
getServiceCallsGatherer() - Method in class com.spotify.apollo.meta.model.DefaultMetaGatherer
 
getServiceCallsGatherer() - Method in interface com.spotify.apollo.meta.model.MetaGatherer
 
getServiceName() - Method in interface com.spotify.apollo.core.Service
Returns the name of this service.
getSignaller() - Method in interface com.spotify.apollo.core.Service.Instance
Returns a signaller that can be used to send signals to this service instance.
getTarget() - Method in class com.spotify.apollo.route.Rule
 
getUnprocessedArgs() - Method in interface com.spotify.apollo.core.Service.Instance
Returns the list of command-line arguments that were not recognized by Apollo, in order.
getUri() - Method in class com.spotify.apollo.dispatch.EndpointInfo
 
guavaToAsync(ListenableFutureHandler<T>) - Static method in interface com.spotify.apollo.route.Middleware
 

H

handle(OngoingRequest) - Method in interface com.spotify.apollo.request.RequestHandler
 
handler() - Method in interface com.spotify.apollo.route.Route
 
Handlers - Class in com.spotify.apollo.request
Factory for an Apollo RequestHandler.
hasHeader(String, Matcher<String>) - Static method in class com.spotify.apollo.test.unit.ResponseMatchers
Builds a matcher for Responses with matching header.
hasMethod(String) - Static method in class com.spotify.apollo.test.unit.RouteMatchers
 
hasNoHeaders() - Static method in class com.spotify.apollo.test.unit.ResponseMatchers
Builds a matcher for Responses with no headers.
hasNoPayload() - Static method in class com.spotify.apollo.test.unit.ResponseMatchers
Builds a matcher for Responses with no payload.
hasPayload(Matcher<? super T>) - Static method in class com.spotify.apollo.test.unit.ResponseMatchers
Builds a matcher for Responses with matching payload.
hasStatus(Matcher<StatusType>) - Static method in class com.spotify.apollo.test.unit.ResponseMatchers
Builds a matcher for Responses with matching status.
hasUri(String) - Static method in class com.spotify.apollo.test.unit.RouteMatchers
 
hasUriAndMethod(String, String) - Static method in class com.spotify.apollo.test.unit.RouteMatchers
Build a matcher.
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.
htmlSerialize(String) - Static method in class com.spotify.apollo.route.HtmlSerializerMiddlewares
Async middleware for POJO.
htmlSerializeResponse(String) - Static method in class com.spotify.apollo.route.HtmlSerializerMiddlewares
Async middleware for a Response object.
htmlSerializeResponseSync(String) - Static method in class com.spotify.apollo.route.HtmlSerializerMiddlewares
Sync middleware for a Response object.
HtmlSerializerMiddlewares - Class in com.spotify.apollo.route
A generic serializer for Object -> HTML using Freemarker templating.
htmlSerializeSync(String) - Static method in class com.spotify.apollo.route.HtmlSerializerMiddlewares
Sync middleware for POJO.
HttpClientModule - Class in com.spotify.apollo.http.client
 
httpPayloadSemantics(AsyncHandler<Response<ByteString>>) - Static method in class com.spotify.apollo.route.Middlewares
Applies logic to the inner AsyncHandler that makes it conform to the semantics specified in HTTP regarding when to return response bodies, Content-Length headers, etc.
HttpServer - Interface in com.spotify.apollo.http.server
A fully configured server that can be started and stopped.
HttpServerModule - Class in com.spotify.apollo.http.server
 
HttpService - Class in com.spotify.apollo.httpservice
A standard setup for and apollo http-based api service.

I

id() - Method in interface com.spotify.apollo.request.ServerInfo
 
in(long, TimeUnit) - Method in class com.spotify.apollo.test.StubClient.StubbedResponseBuilder
Configure delay before the response should be sent.
incoming - Variable in class com.spotify.apollo.meta.model.Model.ExternalCallsInfo
 
IncomingCallsGatherer - Interface in com.spotify.apollo.meta
 
incomingCallsGatherer() - Method in class com.spotify.apollo.meta.MetaInfoTracker
 
IncomingRequestAwareClient - Interface in com.spotify.apollo.environment
An Apollo service client for calls that optionally originate from an incoming Request.
incrementDownstreamRequests() - Method in interface com.spotify.apollo.request.TrackedOngoingRequest
This should be called for each downstream request to other services that is triggered by this request's endpoint handler.
info() - Method in interface com.spotify.apollo.dispatch.Endpoint
 
info() - Method in class com.spotify.apollo.meta.model.DefaultMetaGatherer
 
info() - Method in interface com.spotify.apollo.meta.model.MetaGatherer
 
initialize(AppInit) - Method in interface com.spotify.apollo.environment.ApolloEnvironment
 
INJECT_SERVICE_NAME - Static variable in class com.spotify.apollo.core.Services
 
INJECT_UNPROCESSED_ARGS - Static variable in class com.spotify.apollo.core.Services
 
instanceCreated(Service.Instance) - Method in interface com.spotify.apollo.httpservice.InstanceListener
 
InstanceListener - Interface in com.spotify.apollo.httpservice
 
InvalidUriException - Exception in com.spotify.apollo.route
 
InvalidUriException() - Constructor for exception com.spotify.apollo.route.InvalidUriException
 
invoke(RequestContext) - Method in interface com.spotify.apollo.dispatch.Endpoint
 
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
 
isExpired() - Method in class com.spotify.apollo.request.ForwardingOngoingRequest
 
isExpired() - Method in interface com.spotify.apollo.request.OngoingRequest
 
isExpired() - Method in class com.spotify.apollo.test.FakeOngoingRequest
 
isShutdown() - Method in interface com.spotify.apollo.core.Service.Instance
Returns whether the service has gotten a shutdown signal, meaning that Service.Instance.waitForShutdown() will not block.

J

JsonMetaSerializer - Class in com.spotify.apollo.meta
Custom Serializer for serializing to json.
JsonMetaSerializer() - Constructor for class com.spotify.apollo.meta.JsonMetaSerializer
 
jsonSerialize(ObjectWriter) - Static method in class com.spotify.apollo.route.JsonSerializerMiddlewares
Middleware that serializes the result of the inner handler using the supplied ObjectWriter, and sets the Content-Type header to application/json.
JsonSerializer - Class in com.spotify.apollo.serialization
Deprecated.
the new preferred way to do response serialization is via a Middleware, see Serializer.
JsonSerializer() - Constructor for class com.spotify.apollo.serialization.JsonSerializer
Deprecated.
 
jsonSerializeResponse(ObjectWriter) - Static method in class com.spotify.apollo.route.JsonSerializerMiddlewares
Middleware that serializes the payload of the result response of the inner handler using the supplied ObjectWriter, and sets the Content-Type header to application/json.
jsonSerializeResponseSync(ObjectWriter) - Static method in class com.spotify.apollo.route.JsonSerializerMiddlewares
 
JsonSerializerMiddlewares - Class in com.spotify.apollo.route
 
jsonSerializeSync(ObjectWriter) - Static method in class com.spotify.apollo.route.JsonSerializerMiddlewares
 

L

ListenableFutureHandler<T> - Interface in com.spotify.apollo.route
Asynchronous endpoint handler.
loadApolloVersion(ClassLoader) - Static method in class com.spotify.apollo.meta.MetaDescriptor
 
loadedConfig() - Method in class com.spotify.apollo.meta.model.DefaultMetaGatherer
 
loadedConfig() - Method in interface com.spotify.apollo.meta.model.MetaGatherer
 
LoadingException - Exception in com.spotify.apollo.httpservice
 
LoadingException(String) - Constructor for exception com.spotify.apollo.httpservice.LoadingException
 
LoadingException(String, Throwable) - Constructor for exception com.spotify.apollo.httpservice.LoadingException
 

M

manageLifecycle(Key<?>) - Method in class com.spotify.apollo.module.AbstractApolloModule
 
manageLifecycle(Class<?>) - Method in class com.spotify.apollo.module.AbstractApolloModule
 
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 AsyncHandler.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.
match(Request) - Method in class com.spotify.apollo.meta.ApplicationOrMetaRouter
 
match(Request) - Method in interface com.spotify.apollo.route.ApplicationRouter
Match a request to a configured entity.
match(Request) - Method in class com.spotify.apollo.route.RuleRouter
 
Meta - Class in com.spotify.apollo.meta.model
Factory methods for creating metadata gatherers.
MetaApplication - Class in com.spotify.apollo.meta
An implementation of a meta api.
MetaApplication(MetaGatherer) - Constructor for class com.spotify.apollo.meta.MetaApplication
 
MetaApplication.Result<T> - Class in com.spotify.apollo.meta
 
MetaDescriptor - Class in com.spotify.apollo.meta
 
MetaGatherer - Interface in com.spotify.apollo.meta.model
 
MetaGatherer.CallsGatherer - Interface in com.spotify.apollo.meta.model
 
MetaGatherer.EndpointGatherer - Interface in com.spotify.apollo.meta.model
 
MetaInfoTracker - Class in com.spotify.apollo.meta
 
MetaInfoTracker(Descriptor, String, Config) - Constructor for class com.spotify.apollo.meta.MetaInfoTracker
 
method - Variable in class com.spotify.apollo.meta.model.Model.EndpointInfo
 
method() - Method in interface com.spotify.apollo.Request
The method of the request message.
method() - Method in interface com.spotify.apollo.route.Route
 
method(String) - Static method in class com.spotify.apollo.test.unit.RequestMatchers
 
methodName - Variable in class com.spotify.apollo.meta.model.Model.EndpointInfo
 
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).
Middlewares - Class in com.spotify.apollo.route
Contains utility Middleware implementations.
Model - Interface in com.spotify.apollo.meta.model
Data model for application metadata.
Model.EndpointInfo - Class in com.spotify.apollo.meta.model
 
Model.EndpointsInfo - Class in com.spotify.apollo.meta.model
 
Model.ExternalCallsInfo - Class in com.spotify.apollo.meta.model
 
Model.LoadedConfig - Interface in com.spotify.apollo.meta.model
 
Model.MetaInfo - Interface in com.spotify.apollo.meta.model
 
Model.PayloadSchema - Class in com.spotify.apollo.meta.model
 
Model.QueryParameter - Class in com.spotify.apollo.meta.model
 

N

name - Variable in class com.spotify.apollo.meta.model.Model.QueryParameter
 
namedEndpointGatherer(String) - Method in interface com.spotify.apollo.meta.model.MetaGatherer.CallsGatherer
 
NeedsTo(int) - Constructor for class com.spotify.apollo.route.Versions.NeedsTo
 
newBuilder(String, Client, Closer, EnvironmentFactory.Resolver) - Static method in class com.spotify.apollo.environment.EnvironmentFactoryBuilder
 
newRouterFromInspecting(Object...) - Static method in class com.spotify.apollo.route.Routers
 
NO_ARGS - Static variable in class com.spotify.apollo.test.ServiceHelper
 
NoMatchingResponseFoundException(String) - Constructor for exception com.spotify.apollo.test.StubClient.NoMatchingResponseFoundException
 

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.
of(Iterable<Rule<T>>) - Static method in class com.spotify.apollo.route.RuleRouter
Create a router from a list of rules.
of(Route<AsyncHandler<Response<ByteString>>>) - Static method in interface com.spotify.apollo.route.VersionedRoute
Create a new com.spotify.apollo.route.VersionedRoute, which is valid from version 0.
ok() - Static method in interface com.spotify.apollo.Response
Returns a typed 200 OK Response.
OngoingRequest - Interface in com.spotify.apollo.request
A request that is being processed.
optionalBoolean(Config, String) - Static method in class com.spotify.apollo.environment.ConfigUtil
 
optionalConfig(Config, String) - Static method in class com.spotify.apollo.environment.ConfigUtil
 
optionalDouble(Config, String) - Static method in class com.spotify.apollo.environment.ConfigUtil
 
optionalInt(Config, String) - Static method in class com.spotify.apollo.environment.ConfigUtil
 
optionalString(Config, String) - Static method in class com.spotify.apollo.environment.ConfigUtil
 
outgoing - Variable in class com.spotify.apollo.meta.model.Model.ExternalCallsInfo
 
outgoingCallsGatherer() - Method in class com.spotify.apollo.meta.MetaInfoTracker
 
OutgoingCallsGatherer - Interface in com.spotify.apollo.meta
 
OutgoingCallsGatheringClient - Class in com.spotify.apollo.meta
An Apollo Client that gethers call info to an OutgoingCallsGatherer
OutgoingCallsGatheringClient(OutgoingCallsGatherer, IncomingRequestAwareClient) - Constructor for class com.spotify.apollo.meta.OutgoingCallsGatheringClient
 
OVER_SIZE_KEY - Static variable in class com.spotify.apollo.meta.model.DefaultMetaGatherer
 

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.
parsedPathArguments() - Method in class com.spotify.apollo.route.RuleMatch
 
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.
PayloadSchema() - Constructor for class com.spotify.apollo.meta.model.Model.PayloadSchema
 
PerformanceFixture - Class in com.spotify.apollo.test.experimental
 
PerformanceFixture() - Constructor for class com.spotify.apollo.test.experimental.PerformanceFixture
 
PerformanceFixture(int) - Constructor for class com.spotify.apollo.test.experimental.PerformanceFixture
 
PORT_ZERO - Static variable in interface com.spotify.apollo.request.OngoingRequest
 
post(String) - Method in interface com.spotify.apollo.slack.Slack
Post a message to slack.
pump(int, int, ResponseTimeMetric, Callable<ListenableFuture<T>>) - Method in class com.spotify.apollo.test.experimental.AsyncRequester
 
pump(int, int, ResponseTimeMetric) - Method in class com.spotify.apollo.test.experimental.PerformanceFixture
Run a load test with the given parameters.

Q

QueryParameter(String) - Constructor for class com.spotify.apollo.meta.model.Model.QueryParameter
 
queryParameters - Variable in class com.spotify.apollo.meta.model.Model.EndpointInfo
 

R

rangeName() - Method in enum com.spotify.apollo.StatusType.Family
 
rate - Variable in class com.spotify.apollo.test.experimental.ResponseTimeMetric.CallResult
 
RawSerializer - Class in com.spotify.apollo.serialization
Deprecated.
the new preferred way to do response serialization is via a Middleware, see Serializer.
RawSerializer() - Constructor for class com.spotify.apollo.serialization.RawSerializer
Deprecated.
 
readMetaDescriptor(String, ClassLoader) - Static method in class com.spotify.apollo.meta.MetaDescriptor
 
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
 
register(OngoingRequest) - Method in class com.spotify.apollo.request.RequestTracker
 
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.
remove(OngoingRequest) - Method in class com.spotify.apollo.request.RequestTracker
 
removedIn() - Method in interface com.spotify.apollo.route.VersionedRoute
The first version in which this route is no longer valid.
removedIn(int) - Method in interface com.spotify.apollo.route.VersionedRoute
Return a com.spotify.apollo.route.VersionedRoute based on the current one, but removed in the specified version.
reply(Response<ByteString>) - Method in class com.spotify.apollo.request.ForwardingOngoingRequest
 
reply(Response<ByteString>) - Method in interface com.spotify.apollo.request.OngoingRequest
Reply to the request with a Response.
reply(Response<ByteString>) - Method in class com.spotify.apollo.test.FakeOngoingRequest
 
replyContentType(String) - Static method in class com.spotify.apollo.route.Middlewares
Middleware that adds the ability to set the response's Content-Type header to a defined value.
replyPayloadSchema - Variable in class com.spotify.apollo.meta.model.Model.EndpointInfo
 
Request - Interface in com.spotify.apollo
Defines the data Apollo presents for an incoming request.
request() - Method in class com.spotify.apollo.request.ForwardingOngoingRequest
 
request() - Method in interface com.spotify.apollo.request.OngoingRequest
Returns the Request.
request() - Method in interface com.spotify.apollo.RequestContext
Get the incoming request message.
request() - Method in class com.spotify.apollo.test.FakeOngoingRequest
 
request(Request) - Method in class com.spotify.apollo.test.ServiceHelper
Make a call to the running application and return a CompletionStage of the response.
request(String, String) - Method in class com.spotify.apollo.test.ServiceHelper
Makes a call on the given uri.
request(String, URI) - Method in class com.spotify.apollo.test.ServiceHelper
Makes a call on the given uri.
request(String, String, ByteString) - Method in class com.spotify.apollo.test.ServiceHelper
Makes a call on the given uri.
request(String, URI, ByteString) - Method in class com.spotify.apollo.test.ServiceHelper
Makes a call on the given uri.
request() - Method in class com.spotify.apollo.test.StubClient.RequestResponsePair
 
RequestContext - Interface in com.spotify.apollo
This object contains all the needed information related to an incoming request.
RequestContexts - Class in com.spotify.apollo.request
 
RequestContexts() - Constructor for class com.spotify.apollo.request.RequestContexts
 
requestHandler(RequestRunnableFactory, EndpointRunnableFactory, IncomingRequestAwareClient) - Static method in class com.spotify.apollo.request.Handlers
 
RequestHandler - Interface in com.spotify.apollo.request
A handler that will receive OngoingRequest objects that can be replied to.
RequestMatchers - Class in com.spotify.apollo.test.unit
Provides Hamcrest matcher utilities for matching requests.
requestPayloadSchema - Variable in class com.spotify.apollo.meta.model.Model.EndpointInfo
 
RequestResponsePair() - Constructor for class com.spotify.apollo.test.StubClient.RequestResponsePair
 
RequestRunnable - Interface in com.spotify.apollo.request
A runner for request that will handle matching the request against an Endpoint.
requestRunnableFactory(ApplicationRouter<Endpoint>) - Static method in class com.spotify.apollo.request.Handlers
 
RequestRunnableFactory - Interface in com.spotify.apollo.request
A factory responsible for producing a RequestRunnable that is supposed to handle the OngoingRequest.
RequestRunnableFactoryDecorator - Interface in com.spotify.apollo.environment
A decorator for modifying the behavior of a RequestRunnableFactory.
requestsAndResponses() - Method in class com.spotify.apollo.test.StubClient
Returns all the requests sent to this stub client, together with their associated responses.
requestScopedClient() - Method in interface com.spotify.apollo.RequestContext
Get an Apollo client that can be used to make backend service requests.
RequestTracker - Class in com.spotify.apollo.request
 
RequestTracker() - Constructor for class com.spotify.apollo.request.RequestTracker
 
resetConf(String) - Method in class com.spotify.apollo.test.ServiceHelper
Reset a key in the configuration
resolve(Class<T>) - Method in interface com.spotify.apollo.core.Service.Instance
Get an instance provided by one of the Apollo modules.
resolve(Class<T>) - Method in interface com.spotify.apollo.environment.EnvironmentFactory.Resolver
 
resolve(Class<T>) - Method in interface com.spotify.apollo.Environment
Resolves an instance of a class out of the underlying apollo-core module system.
respond(Response<ByteString>) - Method in class com.spotify.apollo.test.StubClient
Configure a constant (i.e., all matching requests will always result in the same response) response for some request.
respond(ResponseSource) - Method in class com.spotify.apollo.test.StubClient
Configure a response source for matching requests.
Response<T> - Interface in com.spotify.apollo
Defines the data Apollo needs to construct and send a response to an incoming request.
response() - Method in class com.spotify.apollo.test.StubClient.RequestResponsePair
 
ResponseMatchers - Class in com.spotify.apollo.test.unit
Provides Hamcrest matcher utilities for matching Response.
Responses - Class in com.spotify.apollo.test.response
 
ResponseSource - Interface in com.spotify.apollo.test.response
 
ResponseTimeMetric - Class in com.spotify.apollo.test.experimental
 
ResponseTimeMetric.CallResult - Class in com.spotify.apollo.test.experimental
 
ResponseWithDelay - Class in com.spotify.apollo.test.response
 
Result(T) - Constructor for class com.spotify.apollo.meta.MetaApplication.Result
 
result - Variable in class com.spotify.apollo.meta.MetaApplication.Result
 
Route<H> - Interface in com.spotify.apollo.route
The Route defines an endpoint to the service.
route() - Method in interface com.spotify.apollo.route.VersionedRoute
Base route that should be mapped to some versions.
Route.DocString - Class in com.spotify.apollo.route
 
RouteMatchers - Class in com.spotify.apollo.test.unit
A matcher that will compare the method and URI.
RouteMatchers() - Constructor for class com.spotify.apollo.test.unit.RouteMatchers
 
RouteProvider - Interface in com.spotify.apollo.route
A programmatic way of defining Routes in an Apollo service.
Routers - Class in com.spotify.apollo.route
 
routes() - Method in class com.spotify.apollo.meta.MetaApplication
 
routes() - Method in interface com.spotify.apollo.route.RouteProvider
 
routingEngine() - Method in interface com.spotify.apollo.Environment
Returns the Environment.RoutingEngine of this application.
Rule<T> - Class in com.spotify.apollo.route
Simple holder for a rule.
RuleMatch<T> - Class in com.spotify.apollo.route
The result of matching a rule against an input string.
RuleMatch(Rule<T>, Map<String, String>) - Constructor for class com.spotify.apollo.route.RuleMatch
 
RuleRouter<T> - Class in com.spotify.apollo.route
 
run(Service, String...) - Static method in class com.spotify.apollo.core.Services
 
run(BiConsumer<OngoingRequest, RuleMatch<Endpoint>>) - Method in interface com.spotify.apollo.request.RequestRunnable
Do the matching and hand over the match to the given continuation BiConsumer.

S

scheme(String) - Method in class com.spotify.apollo.test.ServiceHelper
Set the scheme to be used for relative request uris on this ServiceHelper instance.
send(Request) - Method in interface com.spotify.apollo.Client
Send a Request and get an asynchronous Response as a CompletionStage.
send(Request, Optional<Request>) - Method in interface com.spotify.apollo.environment.IncomingRequestAwareClient
Send a Request with an optional originating Request and get an asynchronous Response as a CompletionStage.
send(Request, Optional<Request>) - Method in class com.spotify.apollo.meta.OutgoingCallsGatheringClient
 
send(Request) - Method in class com.spotify.apollo.test.StubClient
 
sentRequests() - Method in class com.spotify.apollo.test.StubClient
Returns all the requests sent to this stub client.
sequence(Iterable<ResponseWithDelay>) - Static method in class com.spotify.apollo.test.response.Responses
 
serialize(Request, Object) - Method in class com.spotify.apollo.meta.JsonMetaSerializer
 
serialize(String, T) - Static method in class com.spotify.apollo.route.HtmlSerializerMiddlewares
Call the template engine and return the result.
serialize(Serializer) - Static method in class com.spotify.apollo.route.Middlewares
Middleware that applies the supplied serializer to the result of the inner handler, changing the payload and optionally the Content-Type header.
serialize(Request, Object) - Method in class com.spotify.apollo.serialization.AutoSerializer
Deprecated.
 
serialize(Object) - Static method in class com.spotify.apollo.serialization.AutoSerializer
Deprecated.
 
serialize(Request, Object) - Method in class com.spotify.apollo.serialization.JsonSerializer
Deprecated.
 
serialize(Object) - Static method in class com.spotify.apollo.serialization.JsonSerializer
Deprecated.
 
serialize(Request, Object) - Method in class com.spotify.apollo.serialization.RawSerializer
Deprecated.
 
serialize(Object) - Static method in class com.spotify.apollo.serialization.RawSerializer
Deprecated.
 
serialize(Request, Object) - Method in class com.spotify.apollo.serialization.StringSerializer
Deprecated.
 
serialize(Object) - Static method in class com.spotify.apollo.serialization.StringSerializer
Deprecated.
 
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.
 
server(Service.Instance) - Static method in class com.spotify.apollo.http.server.HttpServerModule
 
serverInfo() - Method in class com.spotify.apollo.request.ForwardingOngoingRequest
 
serverInfo() - Method in interface com.spotify.apollo.request.OngoingRequest
Returns an identifier for the server where this request originated.
ServerInfo - Interface in com.spotify.apollo.request
A value type containing information about a server that is listening to some InetSocketAddress.
ServerInfos - Class in com.spotify.apollo.request
Companion class for creating ServerInfo values
Service - Interface in com.spotify.apollo.core
A service that is controlled by Apollo.
service() - Method in interface com.spotify.apollo.Request
The calling service of the request, if known.
Service.Builder - Interface in com.spotify.apollo.core
A builder for a new service.
Service.Instance - Interface in com.spotify.apollo.core
A running service instance.
Service.Signaller - Interface in com.spotify.apollo.core
A way of sending signals to a service instance.
serviceClient() - Method in class com.spotify.apollo.test.ServiceHelper
Get a Client that allows to make requests to the service created by this helper
ServiceHelper - Class in com.spotify.apollo.test
A JUnit TestRule for running tests against an apollo service.
serviceName() - Method in class com.spotify.apollo.meta.Descriptor
 
Services - Class in com.spotify.apollo.core
 
Services.CommonConfigKeys - Enum in com.spotify.apollo.core
 
serviceUptime() - Method in interface com.spotify.apollo.meta.model.Model.MetaInfo
 
setCallback(Function<ResponseTimeMetric.CallResult, Void>) - Method in class com.spotify.apollo.test.experimental.ResponseTimeMetric
 
setDocstring(String) - Method in interface com.spotify.apollo.meta.model.MetaGatherer.CallsGatherer
 
setDocstring(String) - Method in interface com.spotify.apollo.meta.model.MetaGatherer.EndpointGatherer
 
setMethodName(String) - Method in interface com.spotify.apollo.meta.model.MetaGatherer.EndpointGatherer
 
setMethods(List<String>) - Method in interface com.spotify.apollo.meta.model.MetaGatherer.EndpointGatherer
 
setRequestContentType(String) - Method in interface com.spotify.apollo.meta.model.MetaGatherer.EndpointGatherer
 
setResponseContentType(String) - Method in interface com.spotify.apollo.meta.model.MetaGatherer.EndpointGatherer
 
setUri(String) - Method in interface com.spotify.apollo.meta.model.MetaGatherer.EndpointGatherer
 
signalShutdown() - Method in interface com.spotify.apollo.core.Service.Signaller
Signals the associated service instance to shut down, if it is still running.
Slack - Interface in com.spotify.apollo.slack
 
SlackModule - Class in com.spotify.apollo.slack
 
SlackModule() - Constructor for class com.spotify.apollo.slack.SlackModule
 
socketAddress() - Method in interface com.spotify.apollo.request.ServerInfo
 
spNode() - Method in interface com.spotify.apollo.meta.model.Model.LoadedConfig
 
start(String...) - Method in interface com.spotify.apollo.core.Service
Starts a new instance of this service that is fully initialized.
start(String[], Map<String, String>) - Method in interface com.spotify.apollo.core.Service
Starts a new instance of this service that is fully initialized.
start(String[], Config) - Method in interface com.spotify.apollo.core.Service
Starts a new instance of this service that is fully initialized.
start(RequestHandler) - Method in interface com.spotify.apollo.http.server.HttpServer
Start the server using the given RequestHandler.
start() - Method in class com.spotify.apollo.test.ServiceHelper
Starts the service, blocking for maximum timeoutSeconds until it has come up.
startTimeoutSeconds(int) - Method in class com.spotify.apollo.test.ServiceHelper
Set the time to wait for the service to start before giving up.
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.
StatusTypeMatchers - Class in com.spotify.apollo.test.unit
Provides Hamcrest matcher utilities for matching StatusType.
StringSerializer - Class in com.spotify.apollo.serialization
Deprecated.
the new preferred way to do response serialization is via a Middleware, see Serializer.
StringSerializer() - Constructor for class com.spotify.apollo.serialization.StringSerializer
Deprecated.
 
stubClient() - Method in class com.spotify.apollo.test.ServiceHelper
A StubClient that can be used to mock outgoing application request responses.
StubClient - Class in com.spotify.apollo.test
A stub (http://www.martinfowler.com/articles/mocksArentStubs.html) client that allows you to preconfigure responses to certain messages, as well as verify whether expected messages are sent.
StubClient() - Constructor for class com.spotify.apollo.test.StubClient
 
StubClient(ScheduledExecutorService) - Constructor for class com.spotify.apollo.test.StubClient
 
StubClient.NoMatchingResponseFoundException - Exception in com.spotify.apollo.test
 
StubClient.RequestResponsePair - Class in com.spotify.apollo.test
 
StubClient.StubbedResponseBuilder - Class in com.spotify.apollo.test
Immutable response builder.
success - Variable in class com.spotify.apollo.test.experimental.ResponseTimeMetric.CallResult
 
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
 
systemVersion() - Method in interface com.spotify.apollo.meta.model.Model.MetaInfo
 

T

to(int) - Method in class com.spotify.apollo.route.Versions.NeedsTo
 
to(String) - Method in class com.spotify.apollo.test.StubClient.StubbedResponseBuilder
Map the previously configured response or response source to a URI.
to(Matcher<Request>) - Method in class com.spotify.apollo.test.StubClient.StubbedResponseBuilder
Map the previously configured response or response source to any messages matching the supplied Matcher.
toString() - Method in class com.spotify.apollo.module.AbstractApolloModule
 
totalFailed - Variable in class com.spotify.apollo.test.experimental.ResponseTimeMetric
 
totalRejected - Variable in class com.spotify.apollo.test.experimental.ResponseTimeMetric
 
totalResponses - Variable in class com.spotify.apollo.test.experimental.ResponseTimeMetric
 
track(ListenableFuture<T>, long, int) - Method in class com.spotify.apollo.test.experimental.ResponseTimeMetric
 
TrackedOngoingRequest - Interface in com.spotify.apollo.request
A OngoingRequest that is being tracked throughout the request handling process.
ttl() - Method in interface com.spotify.apollo.Request
The request ttl.

U

UNKNOWN_SERVER_INFO - Static variable in interface com.spotify.apollo.request.OngoingRequest
 
uri - Variable in class com.spotify.apollo.meta.model.Model.EndpointInfo
 
uri() - Method in interface com.spotify.apollo.Request
The uri of the request message.
uri() - Method in interface com.spotify.apollo.route.Route
 
uri(Matcher<String>) - Static method in class com.spotify.apollo.test.unit.RequestMatchers
 
uriEndpointGatherer(String) - Method in interface com.spotify.apollo.meta.model.MetaGatherer.CallsGatherer
 
uriMethodsEndpointGatherer(String, List<String>) - Method in interface com.spotify.apollo.meta.model.MetaGatherer.CallsGatherer
 
usingAppInit(AppInit, String) - Static method in class com.spotify.apollo.httpservice.HttpService
 
usingModuleDiscovery(boolean) - Method in interface com.spotify.apollo.core.Service.Builder
Enables or disables module discovery, which will use SPI to discover all available modules on the classpath.
usingName(String) - Static method in class com.spotify.apollo.core.Services
 
Util - Class in com.spotify.apollo.concurrent
Contains some utilities for working with futures and completion stages.

V

validFrom() - Method in interface com.spotify.apollo.route.VersionedRoute
The first version in which this route is valid
validFrom(int) - Method in interface com.spotify.apollo.route.VersionedRoute
Return a com.spotify.apollo.route.VersionedRoute based on the current one, but valid from the specified version.
valueOf(String) - Static method in enum com.spotify.apollo.core.Services.CommonConfigKeys
Returns the enum constant of this type with the specified name.
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.core.Services.CommonConfigKeys
Returns an array containing the constants of this enum type, in the order they are declared.
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.
version() - Method in class com.spotify.apollo.meta.Descriptor
 
VersionedRoute - Interface in com.spotify.apollo.route
Defines a possibly open-ended range of versions in which a particular Route should be available.
Versions - Class in com.spotify.apollo.route
Allows you to expand a stream of VersionedRoutes to a stream of Routes.
Versions(int, int) - Constructor for class com.spotify.apollo.route.Versions
 
Versions.NeedsTo - Class in com.spotify.apollo.route
 

W

waitForShutdown() - Method in interface com.spotify.apollo.core.Service.Instance
A method that will block until the service has stopped.
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.
withClassLoader(ClassLoader) - Method in class com.spotify.apollo.environment.EnvironmentFactoryBuilder
Lazily load configuration from this classloader.
withCliHelp(boolean) - Method in interface com.spotify.apollo.core.Service.Builder
Enables/disables whether Apollo should handle the --help/-h flags and display command-line help.
withCode(int) - Static method in class com.spotify.apollo.test.unit.StatusTypeMatchers
Builds a matcher for StatusTypes with specified status code.
withCode(StatusType) - Static method in class com.spotify.apollo.test.unit.StatusTypeMatchers
Builds a matcher for StatusTypes whose StatusType.code() matches the specified StatusType's status code.
withConfigResolver(EnvironmentConfigResolver) - Method in class com.spotify.apollo.environment.EnvironmentFactoryBuilder
Use custom config resolver.
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
 
withEnvVarPrefix(String) - Method in interface com.spotify.apollo.core.Service.Builder
Sets the prefix that is used to convert environment variables into configuration keys.
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
 
withModule(ApolloModule) - Method in interface com.spotify.apollo.core.Service.Builder
Registers the specified module as loadable by this service.
withModule(ApolloModule) - Method in class com.spotify.apollo.test.ServiceHelper
 
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.
withReasonPhrase(Matcher<String>) - Static method in class com.spotify.apollo.test.unit.StatusTypeMatchers
Builds a matcher for StatusTypes with matching reason phrase.
withRuntime(Runtime) - Method in interface com.spotify.apollo.core.Service.Builder
The Java runtime to use when constructing service instances.
withService(String) - Method in interface com.spotify.apollo.Request
Creates a new Request based on this, but with a different calling service.
withShutdownInterrupt(boolean) - Method in interface com.spotify.apollo.core.Service.Builder
Enables/disables whether the thread calling Service.start(String...) will be interrupted when the application is requested to shut down.
withStaticConfig(Config) - Method in class com.spotify.apollo.environment.EnvironmentFactoryBuilder
Statically inject a config object into the environment.
withTracking(EndpointRunnableFactory, IncomingCallsGatherer, RequestTracker) - Static method in class com.spotify.apollo.request.Handlers
 
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.
withWatchdogTimeout(long, TimeUnit) - Method in interface com.spotify.apollo.core.Service.Builder
Sets the timeout for how long Apollo will wait for the service to clean itself up upon shutdown.
wrapRequest(Request) - Method in interface com.spotify.apollo.environment.IncomingRequestAwareClient
Wraps a request and returns a Client where all calles use the wrapped request for the incoming argument.
A B C D E F G H I J L M N O P Q R S T U V W 
Skip navigation links

Copyright © 2016. All rights reserved.