A B C D E F G H I L M N P R S T U V W

A

abort() - Method in class io.apiman.gateway.engine.impl.EngineResultImpl

abort() - Method in interface io.apiman.gateway.engine.io.IAbortable

Signal abort.

abort() - Method in class io.apiman.gateway.engine.policy.Chain

Send abort signal to all policies.

AbstractEngineFactory - Class in io.apiman.gateway.engine.impl

Base class useful for creating engine factories.

AbstractEngineFactory() - Constructor for class io.apiman.gateway.engine.impl.AbstractEngineFactory

Constructor.

AbstractSignalStream<H> - Class in io.apiman.gateway.engine.io

As AbstractSignalStream but with ISignalReadStream.transmit() to signal body transmission may begin

AbstractSignalStream() - Constructor for class io.apiman.gateway.engine.io.AbstractSignalStream

AbstractStream<H> - Class in io.apiman.gateway.engine.io

Generic representation of a three part stream: head, body and end, with handlers and operators for each.

AbstractStream() - Constructor for class io.apiman.gateway.engine.io.AbstractStream

accept(String, RateBucketPeriod, int, IAsyncResultHandler<Boolean>) - Method in interface io.apiman.gateway.engine.components.IRateLimiterComponent

Adds another request to the given rate bucket.

accept(String, RateBucketPeriod, int, IAsyncResultHandler<Boolean>) - Method in class io.apiman.gateway.engine.impl.InMemoryRateLimiterComponent

addHeader(String, String) - Method in interface io.apiman.gateway.engine.components.http.IHttpClientRequest

Adds a header to the request.

append(IApimanBuffer) - Method in interface io.apiman.gateway.engine.io.IApimanBuffer

append(IApimanBuffer, int, int) - Method in interface io.apiman.gateway.engine.io.IApimanBuffer

append(byte) - Method in interface io.apiman.gateway.engine.io.IApimanBuffer

append(byte[]) - Method in interface io.apiman.gateway.engine.io.IApimanBuffer

append(byte[], int, int) - Method in interface io.apiman.gateway.engine.io.IApimanBuffer

Byte array to append with given offset and length.

append(String) - Method in interface io.apiman.gateway.engine.io.IApimanBuffer

append(String, String) - Method in interface io.apiman.gateway.engine.io.IApimanBuffer

apply(ServiceRequest, IPolicyContext, Object, IPolicyChain<ServiceRequest>) - Method in interface io.apiman.gateway.engine.policy.IPolicy

Applies a policy upon a ServiceRequest based on information included in the request itself in addition to its context and configuration.

apply(ServiceResponse, IPolicyContext, Object, IPolicyChain<ServiceResponse>) - Method in interface io.apiman.gateway.engine.policy.IPolicy

Applies a policy upon a ServiceResponse based on information included in the response itself in addition to its context and configuration.

applyPolicy(PolicyWithConfiguration, IPolicyContext) - Method in class io.apiman.gateway.engine.policy.Chain

Called to apply the given policy to the service object (request or response).

applyPolicy(PolicyWithConfiguration, IPolicyContext) - Method in class io.apiman.gateway.engine.policy.RequestChain

applyPolicy(PolicyWithConfiguration, IPolicyContext) - Method in class io.apiman.gateway.engine.policy.ResponseChain

AsyncResultImpl<T> - Class in io.apiman.gateway.engine.async

A simple implementation of the async result interface.

B

bodyHandler - Variable in class io.apiman.gateway.engine.io.AbstractStream

bodyHandler(IAsyncHandler<IApimanBuffer>) - Method in class io.apiman.gateway.engine.io.AbstractStream

bodyHandler(IAsyncHandler<IApimanBuffer>) - Method in interface io.apiman.gateway.engine.io.IReadStream

Handler called when a body chunk has arrived.

C

Chain<H> - Class in io.apiman.gateway.engine.policy

Traverses and executes a series of policies according to implementor's settings and iterator.

Chain(List<PolicyWithConfiguration>, IPolicyContext) - Constructor for class io.apiman.gateway.engine.policy.Chain

Constructor.

chainPolicyHandlers() - Method in class io.apiman.gateway.engine.policy.Chain

Chain together the body handlers.

clearProperty(String, String, IAsyncResultHandler<T>) - Method in interface io.apiman.gateway.engine.components.ISharedStateComponent

Clears a property from the shared state environment, returning the previous value of the property or null if it was not previously set.

clearProperty(String, String, IAsyncResultHandler<T>) - Method in class io.apiman.gateway.engine.impl.InMemorySharedStateComponent

close() - Method in interface io.apiman.gateway.engine.components.http.IHttpClientResponse

Called to close the connection to the remote server.

ConfigDrivenComponentRegistry - Class in io.apiman.gateway.engine.impl

A simple component registry.

ConfigDrivenComponentRegistry(IEngineConfig) - Constructor for class io.apiman.gateway.engine.impl.ConfigDrivenComponentRegistry

Constructor.

ConfigDrivenEngineFactory - Class in io.apiman.gateway.engine.impl

Factory for creating the engine, obviously.

ConfigDrivenEngineFactory(IEngineConfig) - Constructor for class io.apiman.gateway.engine.impl.ConfigDrivenEngineFactory

Constructor.

connect(ServiceRequest, IAsyncResultHandler<IServiceConnectionResponse>) - Method in interface io.apiman.gateway.engine.IServiceConnector

Invokes the back-end system.

count - Variable in class io.apiman.gateway.engine.rates.RateLimiterBucket

create(T) - Static method in class io.apiman.gateway.engine.async.AsyncResultImpl

Convenience method for creating an async result.

create(Throwable) - Static method in class io.apiman.gateway.engine.async.AsyncResultImpl

Convenience method for creating an async result.

create(Class<T>, Map<String, String>) - Static method in class io.apiman.gateway.engine.impl.ConfigDrivenEngineFactory

Creates a new instance of the given type, passing the given config map if possible (if the class has a Map constructor).

createAndRegisterComponent(Class<T>) - Method in class io.apiman.gateway.engine.impl.ConfigDrivenComponentRegistry

Creates the component and registers it in the registry.

createComponentRegistry() - Method in class io.apiman.gateway.engine.impl.AbstractEngineFactory

Creates a component registry.

createComponentRegistry() - Method in class io.apiman.gateway.engine.impl.ConfigDrivenEngineFactory

createComponentRegistry() - Method in class io.apiman.gateway.engine.impl.DefaultEngineFactory

createConnector(ServiceRequest, Service) - Method in interface io.apiman.gateway.engine.IConnectorFactory

Creates a connector to a back-end system.

createConnectorFactory() - Method in class io.apiman.gateway.engine.impl.AbstractEngineFactory

Creates a connector factory.

createConnectorFactory() - Method in class io.apiman.gateway.engine.impl.ConfigDrivenEngineFactory

createEngine() - Method in interface io.apiman.gateway.engine.IEngineFactory

Call this to create a new engine.

createEngine() - Method in class io.apiman.gateway.engine.impl.AbstractEngineFactory

Call this to create a new engine.

createFailure(PolicyFailureType, int, String) - Method in interface io.apiman.gateway.engine.components.IPolicyFailureFactoryComponent

Creates a policy failure for the given information.

createFailure(PolicyFailureType, int, String) - Method in class io.apiman.gateway.engine.impl.DefaultPolicyFailureFactoryComponent

createPolicyFactory() - Method in class io.apiman.gateway.engine.impl.AbstractEngineFactory

Creates a policy factory.

createPolicyFactory() - Method in class io.apiman.gateway.engine.impl.ConfigDrivenEngineFactory

createPolicyFactory() - Method in class io.apiman.gateway.engine.impl.DefaultEngineFactory

createRegistry() - Method in class io.apiman.gateway.engine.impl.AbstractEngineFactory

Creates a registry.

createRegistry() - Method in class io.apiman.gateway.engine.impl.ConfigDrivenEngineFactory

createRegistry() - Method in class io.apiman.gateway.engine.impl.DefaultEngineFactory

D

DefaultComponentRegistry - Class in io.apiman.gateway.engine.impl

A default component registry, useful primarily for testing and bootstrapping.

DefaultComponentRegistry() - Constructor for class io.apiman.gateway.engine.impl.DefaultComponentRegistry

Constructor.

DefaultEngineFactory - Class in io.apiman.gateway.engine.impl

A default engine factory useful for quickly getting ramped up with apiman.

DefaultEngineFactory() - Constructor for class io.apiman.gateway.engine.impl.DefaultEngineFactory

Constructor.

DefaultPolicyFailureFactoryComponent - Class in io.apiman.gateway.engine.impl

A simple failure factory.

DefaultPolicyFailureFactoryComponent() - Constructor for class io.apiman.gateway.engine.impl.DefaultPolicyFailureFactoryComponent

Constructor.

doApply(H) - Method in class io.apiman.gateway.engine.policy.Chain

doApply(T) - Method in interface io.apiman.gateway.engine.policy.IPolicyChain

Called by a policy when it has successfully completed applying itself.

doFailure(PolicyFailure) - Method in class io.apiman.gateway.engine.policy.Chain

Handle a policy failure.

doFailure(PolicyFailure) - Method in interface io.apiman.gateway.engine.policy.IPolicyChain

Called by a policy when it has detected a violation or failure in the policy.

E

end() - Method in interface io.apiman.gateway.engine.components.http.IHttpClientRequest

Called once all headers have been set and all data has been written.

end() - Method in class io.apiman.gateway.engine.io.AbstractStream

end() - Method in interface io.apiman.gateway.engine.io.IWriteStream

Signal transmission has ended.

end() - Method in class io.apiman.gateway.engine.policy.Chain

endHandler - Variable in class io.apiman.gateway.engine.io.AbstractStream

endHandler(IAsyncHandler<Void>) - Method in class io.apiman.gateway.engine.io.AbstractStream

endHandler(IAsyncHandler<Void>) - Method in interface io.apiman.gateway.engine.io.IReadStream

Handler signals when transmission has completed; no further calls to IReadStream.bodyHandler(IAsyncHandler) should occur after this has been invoked.

EngineImpl - Class in io.apiman.gateway.engine.impl

The implementation of the API Management runtime engine.

EngineImpl(IRegistry, IComponentRegistry, IConnectorFactory, IPolicyFactory) - Constructor for class io.apiman.gateway.engine.impl.EngineImpl

Constructor.

EngineResultImpl - Class in io.apiman.gateway.engine.impl

The result of a call through the policy engine.

EngineResultImpl() - Constructor for class io.apiman.gateway.engine.impl.EngineResultImpl

Constructor.

EngineResultImpl(ServiceResponse) - Constructor for class io.apiman.gateway.engine.impl.EngineResultImpl

Construct a successful EngineResult.

EngineResultImpl(PolicyFailure) - Constructor for class io.apiman.gateway.engine.impl.EngineResultImpl

Construct an unsuccessful EngineResult.

execute() - Method in class io.apiman.gateway.engine.impl.ServiceRequestExecutorImpl

execute() - Method in interface io.apiman.gateway.engine.IServiceRequestExecutor

Execute the policy chain and request.

executor(ServiceRequest, IAsyncResultHandler<IEngineResult>) - Method in interface io.apiman.gateway.engine.IEngine

Executes an asynchronous request for a managed service, with the provided handler being passed an EngineResultImpl with the status and result of the policy chain invocation.

executor(ServiceRequest, IAsyncResultHandler<IEngineResult>) - Method in class io.apiman.gateway.engine.impl.EngineImpl

F

finished - Variable in class io.apiman.gateway.engine.io.AbstractStream

G

get(int) - Method in interface io.apiman.gateway.engine.io.IApimanBuffer

get() - Static method in class io.apiman.gateway.engine.Version

getAttribute(String, T) - Method in interface io.apiman.gateway.engine.policy.IPolicyContext

Fetches an attribute value from the conversation.

getAttribute(String, T) - Method in class io.apiman.gateway.engine.policy.PolicyContextImpl

getBody() - Method in interface io.apiman.gateway.engine.components.http.IHttpClientResponse

getBytes() - Method in interface io.apiman.gateway.engine.io.IApimanBuffer

getBytes(int, int) - Method in interface io.apiman.gateway.engine.io.IApimanBuffer

Get ApimanBuffer as byte array constrained by indices.

getComponent(Class<T>) - Method in interface io.apiman.gateway.engine.IComponentRegistry

Gets a specific type of component from the registry.

getComponent(Class<T>) - Method in class io.apiman.gateway.engine.impl.ConfigDrivenComponentRegistry

getComponent(Class<T>) - Method in class io.apiman.gateway.engine.impl.DefaultComponentRegistry

getComponent(Class<T>) - Method in interface io.apiman.gateway.engine.policy.IPolicyContext

Gets a component by type.

getComponent(Class<T>) - Method in class io.apiman.gateway.engine.policy.PolicyContextImpl

getComponentClass(Class<T>) - Method in interface io.apiman.gateway.engine.IEngineConfig

getComponentConfig(Class<T>) - Method in interface io.apiman.gateway.engine.IEngineConfig

getComponentRegistry() - Method in class io.apiman.gateway.engine.impl.EngineImpl

getConfiguration() - Method in class io.apiman.gateway.engine.policy.PolicyWithConfiguration

getConnectorFactory() - Method in class io.apiman.gateway.engine.impl.EngineImpl

getConnectorFactoryClass() - Method in interface io.apiman.gateway.engine.IEngineConfig

getConnectorFactoryConfig() - Method in interface io.apiman.gateway.engine.IEngineConfig

getContext() - Method in class io.apiman.gateway.engine.policy.Chain

getContract(ServiceRequest) - Method in class io.apiman.gateway.engine.impl.InMemoryRegistry

getContract(ServiceRequest) - Method in interface io.apiman.gateway.engine.IRegistry

Gets the Contract to use based on information included in the inbound service request.

getError() - Method in class io.apiman.gateway.engine.async.AsyncResultImpl

getError() - Method in interface io.apiman.gateway.engine.async.IAsyncResult

Any unhandled exception raised during the course of execution.

getHead() - Method in class io.apiman.gateway.engine.impl.EngineResultImpl

getHead() - Method in interface io.apiman.gateway.engine.io.IReadStream

Return the head object's handler (e.g.

getHead() - Method in class io.apiman.gateway.engine.policy.Chain

getHeader(String) - Method in interface io.apiman.gateway.engine.components.http.IHttpClientResponse

getNativeBuffer() - Method in interface io.apiman.gateway.engine.io.IApimanBuffer

Get encapsulated native buffer.

getPolicies() - Method in class io.apiman.gateway.engine.policy.Chain

getPolicy() - Method in class io.apiman.gateway.engine.policy.PolicyWithConfiguration

getPolicyConfig(IPolicy, Policy) - Method in class io.apiman.gateway.engine.impl.EngineImpl

Gets the policy config object for the given policy.

getPolicyFactory() - Method in class io.apiman.gateway.engine.impl.EngineImpl

getPolicyFactoryClass() - Method in interface io.apiman.gateway.engine.IEngineConfig

getPolicyFactoryConfig() - Method in interface io.apiman.gateway.engine.IEngineConfig

getPolicyFailure() - Method in interface io.apiman.gateway.engine.IEngineResult

getPolicyFailure() - Method in class io.apiman.gateway.engine.impl.EngineResultImpl

getProperty(String, String, T, IAsyncResultHandler<T>) - Method in interface io.apiman.gateway.engine.components.ISharedStateComponent

Gets the value of a single property stored in the shared state environment.

getProperty(String, String, T, IAsyncResultHandler<T>) - Method in class io.apiman.gateway.engine.impl.InMemorySharedStateComponent

getRegistry() - Method in class io.apiman.gateway.engine.impl.EngineImpl

getRegistryClass() - Method in interface io.apiman.gateway.engine.IEngineConfig

getRegistryConfig() - Method in interface io.apiman.gateway.engine.IEngineConfig

getRequestDataHandler(ServiceRequest, IPolicyContext) - Method in interface io.apiman.gateway.engine.policy.IDataPolicy

This method should return a stream that will be used when piping the request data from the client to the back-end service.

getResponseCode() - Method in interface io.apiman.gateway.engine.components.http.IHttpClientResponse

getResponseDataHandler(ServiceResponse, IPolicyContext) - Method in interface io.apiman.gateway.engine.policy.IDataPolicy

This method should return a stream that will be used when piping the response data from the back-end service to the client.

getResponseMessage() - Method in interface io.apiman.gateway.engine.components.http.IHttpClientResponse

getResult() - Method in class io.apiman.gateway.engine.async.AsyncResultImpl

getResult() - Method in interface io.apiman.gateway.engine.async.IAsyncResult

Contains the async call if it succeeded, otherwise null.

getServiceHandler(IPolicy) - Method in class io.apiman.gateway.engine.policy.Chain

Gets the service handler for the policy.

getServiceHandler(IPolicy) - Method in class io.apiman.gateway.engine.policy.RequestChain

getServiceHandler(IPolicy) - Method in class io.apiman.gateway.engine.policy.ResponseChain

getServiceResponse() - Method in interface io.apiman.gateway.engine.IEngineResult

getServiceResponse() - Method in class io.apiman.gateway.engine.impl.EngineResultImpl

getString(int, int) - Method in interface io.apiman.gateway.engine.io.IApimanBuffer

getString(int, int, String) - Method in interface io.apiman.gateway.engine.io.IApimanBuffer

getVersion() - Method in interface io.apiman.gateway.engine.IEngine

getVersion() - Method in class io.apiman.gateway.engine.impl.EngineImpl

getVersionDate() - Method in class io.apiman.gateway.engine.Version

getVersionString() - Method in class io.apiman.gateway.engine.Version

H

handle(T) - Method in interface io.apiman.gateway.engine.async.IAsyncHandler

Called when an async result is available.

handleBody(IApimanBuffer) - Method in class io.apiman.gateway.engine.io.AbstractStream

Called to handle a body chunk.

handleEnd() - Method in class io.apiman.gateway.engine.io.AbstractStream

Signals the end of the stream.

handleHead(ServiceResponse) - Method in class io.apiman.gateway.engine.impl.EngineResultImpl

handleHead(H) - Method in class io.apiman.gateway.engine.io.AbstractStream

Called to handle the head.

handleHead(H) - Method in class io.apiman.gateway.engine.policy.Chain

handleStream() - Method in class io.apiman.gateway.engine.impl.ServiceRequestExecutorImpl

Called when the service connector is ready to receive data from the inbound client request.

headHandler - Variable in class io.apiman.gateway.engine.io.AbstractStream

headHandler(IAsyncHandler<H>) - Method in class io.apiman.gateway.engine.io.AbstractStream

Sets the head handler.

HttpMethod - Enum in io.apiman.gateway.engine.components.http

The http method to use when sending a client request.

I

i18n - Static variable in class io.apiman.gateway.engine.i18n.Messages

IAbortable - Interface in io.apiman.gateway.engine.io

An object that can be aborted.

IApimanBuffer - Interface in io.apiman.gateway.engine.io

A generic buffer used throughout APIMan, principally for streaming body chunks.

IAsyncHandler<T> - Interface in io.apiman.gateway.engine.async

Asynchronous handler called when an async operation completes.

IAsyncResult<T> - Interface in io.apiman.gateway.engine.async

Models the result of an asynchronous operation in the API Gateway.

IAsyncResultHandler<T> - Interface in io.apiman.gateway.engine.async

Asynchronous handler called when an async operation wrapped in a result completes.

IComponent - Interface in io.apiman.gateway.engine

All components provided to policies during their runtime must implement this interface.

IComponentRegistry - Interface in io.apiman.gateway.engine

A registry to discover and lookup components used by the policy implementations.

IConnectorFactory - Interface in io.apiman.gateway.engine

Factory used to create connectors to back-end systems.

IDataPolicy - Interface in io.apiman.gateway.engine.policy

Policies that wish to be applied to the data handling phase of apiman must implement this interface.

IEngine - Interface in io.apiman.gateway.engine

The API Management runtime engine.

IEngineConfig - Interface in io.apiman.gateway.engine

Engine configuration - used by the engine factory when creating the engine.

IEngineFactory - Interface in io.apiman.gateway.engine

Factory for creating the engine.

IEngineResult - Interface in io.apiman.gateway.engine

This is what is passed to the original caller when the engine wants to return either a successful ServiceResponse or a PolicyFailure.

IHttpClientComponent - Interface in io.apiman.gateway.engine.components

A component that policies can use to make HTTP calls.

IHttpClientRequest - Interface in io.apiman.gateway.engine.components.http

An async client request returned by the http client component.

IHttpClientResponse - Interface in io.apiman.gateway.engine.components.http

An http client response is returned when an http client request is made to some remote server.

InMemoryRateLimiterComponent - Class in io.apiman.gateway.engine.impl

A simple in-memory implementation of a rate limiter.

InMemoryRateLimiterComponent() - Constructor for class io.apiman.gateway.engine.impl.InMemoryRateLimiterComponent

Constructor.

InMemoryRegistry - Class in io.apiman.gateway.engine.impl

An in-memory implementation of the registry.

InMemoryRegistry() - Constructor for class io.apiman.gateway.engine.impl.InMemoryRegistry

Constructor.

InMemorySharedStateComponent - Class in io.apiman.gateway.engine.impl

An in-memory only implementation of the shared state component.

InMemorySharedStateComponent() - Constructor for class io.apiman.gateway.engine.impl.InMemorySharedStateComponent

Constructor.

insert(int, IApimanBuffer) - Method in interface io.apiman.gateway.engine.io.IApimanBuffer

Inserts data at given index with buffer.

insert(int, IApimanBuffer, int, int) - Method in interface io.apiman.gateway.engine.io.IApimanBuffer

Inserts data at the given index with buffer at given offset and constrained length.

insert(int, byte[]) - Method in interface io.apiman.gateway.engine.io.IApimanBuffer

Inserts data from byte array into the index location.

insert(int, byte[], int, int) - Method in interface io.apiman.gateway.engine.io.IApimanBuffer

Inserts data from the byte array constrained by offset and length.

insert(int, String) - Method in interface io.apiman.gateway.engine.io.IApimanBuffer

Inserts data at index from value of string.

insert(int, String, String) - Method in interface io.apiman.gateway.engine.io.IApimanBuffer

Inserts data at index from value of string.

io.apiman.gateway.engine - package io.apiman.gateway.engine

io.apiman.gateway.engine.async - package io.apiman.gateway.engine.async

io.apiman.gateway.engine.components - package io.apiman.gateway.engine.components

io.apiman.gateway.engine.components.http - package io.apiman.gateway.engine.components.http

io.apiman.gateway.engine.i18n - package io.apiman.gateway.engine.i18n

io.apiman.gateway.engine.impl - package io.apiman.gateway.engine.impl

io.apiman.gateway.engine.io - package io.apiman.gateway.engine.io

io.apiman.gateway.engine.policy - package io.apiman.gateway.engine.policy

io.apiman.gateway.engine.rates - package io.apiman.gateway.engine.rates

IPolicy - Interface in io.apiman.gateway.engine.policy

All policy implementations must implement this interface.

IPolicyChain<T> - Interface in io.apiman.gateway.engine.policy

The interface given to policies that allows them to asynchronously signal when events occur.

IPolicyContext - Interface in io.apiman.gateway.engine.policy

Context information provided to an executing policy.

IPolicyFactory - Interface in io.apiman.gateway.engine.policy

Factory used to create instances of policies.

IPolicyFailureFactoryComponent - Interface in io.apiman.gateway.engine.components

Component that can be used to create policy failures.

IRateLimiterComponent - Interface in io.apiman.gateway.engine.components

A component used to enforce rate limits.

IReadStream<H> - Interface in io.apiman.gateway.engine.io

Read a chunked stream by setting handlers.

IReadWriteStream<H> - Interface in io.apiman.gateway.engine.io

A stream where both read and write aspects can be manipulated.

IRegistry - Interface in io.apiman.gateway.engine

A registry that maintains a collection of Services and Contracts that have been published to the API Management runtime engine.

isError() - Method in class io.apiman.gateway.engine.async.AsyncResultImpl

isError() - Method in interface io.apiman.gateway.engine.async.IAsyncResult

Whether the call failed.

IServiceConnection - Interface in io.apiman.gateway.engine

A connection to a back-end service.

IServiceConnectionResponse - Interface in io.apiman.gateway.engine

A service connection response represents the result of a successful connection to a back-end service.

IServiceConnector - Interface in io.apiman.gateway.engine

Interface implemented by connectors to back end systems.

IServiceRequestExecutor - Interface in io.apiman.gateway.engine

IPolicyRequestExecutor interface.

isFailure() - Method in interface io.apiman.gateway.engine.IEngineResult

Whether a failure occurred during engine execution.

isFailure() - Method in class io.apiman.gateway.engine.impl.EngineResultImpl

isFinished() - Method in class io.apiman.gateway.engine.impl.ServiceRequestExecutorImpl

isFinished() - Method in class io.apiman.gateway.engine.io.AbstractStream

isFinished() - Method in interface io.apiman.gateway.engine.io.IStream

Indicates whether the stream has finished.

isFinished() - Method in interface io.apiman.gateway.engine.IServiceRequestExecutor

Policy request-response sequence has completed.

ISharedStateComponent - Interface in io.apiman.gateway.engine.components

A component that allows policies to share information across invokations and potentially across nodes in a cluster.

ISignalReadStream<H> - Interface in io.apiman.gateway.engine.io

As IReadStream but with explicit ISignalReadStream.transmit() which indicates to the sender that they may begin transmitting.

ISignalWriteStream - Interface in io.apiman.gateway.engine.io

As IWriteStream but with IAbortable.abort().

isResponse() - Method in interface io.apiman.gateway.engine.IEngineResult

Whether a response has been set.

isResponse() - Method in class io.apiman.gateway.engine.impl.EngineResultImpl

isSuccess() - Method in class io.apiman.gateway.engine.async.AsyncResultImpl

isSuccess() - Method in interface io.apiman.gateway.engine.async.IAsyncResult

Whether the call was successful.

IStream - Interface in io.apiman.gateway.engine.io

Common Stream interface.

iterator() - Method in class io.apiman.gateway.engine.policy.RequestChain

iterator() - Method in class io.apiman.gateway.engine.policy.ResponseChain

IWriteStream - Interface in io.apiman.gateway.engine.io

Write into a stream by repeatedly submitting chunks via IWriteStream.write(IApimanBuffer).

L

last - Variable in class io.apiman.gateway.engine.rates.RateLimiterBucket

length() - Method in interface io.apiman.gateway.engine.io.IApimanBuffer

M

Messages - Class in io.apiman.gateway.engine.i18n

I18N Messages

Messages() - Constructor for class io.apiman.gateway.engine.i18n.Messages

Constructor.

mutex - Variable in class io.apiman.gateway.engine.rates.RateLimiterBucket

N

newPolicy(String) - Method in interface io.apiman.gateway.engine.policy.IPolicyFactory

Instantiate a new preconfigured policy.

newPolicy(String) - Method in class io.apiman.gateway.engine.policy.PolicyFactoryImpl

P

parseConfiguration(String) - Method in interface io.apiman.gateway.engine.policy.IPolicy

Parses the JSON configuration into a policy specific configuration object type.

PolicyContextImpl - Class in io.apiman.gateway.engine.policy

A simple implementation of a IPolicyContext.

PolicyContextImpl(IComponentRegistry) - Constructor for class io.apiman.gateway.engine.policy.PolicyContextImpl

Constructor.

policyErrorHandler(IAsyncHandler<Throwable>) - Method in class io.apiman.gateway.engine.policy.Chain

Sets the policy error handler.

PolicyFactoryImpl - Class in io.apiman.gateway.engine.policy

An implementation of the IPolicyFactory interface.

PolicyFactoryImpl() - Constructor for class io.apiman.gateway.engine.policy.PolicyFactoryImpl

Constructor.

policyFailureHandler(IAsyncHandler<PolicyFailure>) - Method in class io.apiman.gateway.engine.policy.Chain

Sets the policy failure handler.

PolicyWithConfiguration - Class in io.apiman.gateway.engine.policy

A simple container to hold both the policy impl and its configuration information.

PolicyWithConfiguration(IPolicy, Object) - Constructor for class io.apiman.gateway.engine.policy.PolicyWithConfiguration

Constructor.

publishService(Service) - Method in interface io.apiman.gateway.engine.IEngine

Publishes a new Service.

publishService(Service) - Method in class io.apiman.gateway.engine.impl.EngineImpl

publishService(Service) - Method in class io.apiman.gateway.engine.impl.InMemoryRegistry

publishService(Service) - Method in interface io.apiman.gateway.engine.IRegistry

Publishes a new Service into the registry.

R

RateBucketPeriod - Enum in io.apiman.gateway.engine.rates

The type of bucket to use when enforcing rate limits.

RateLimiterBucket - Class in io.apiman.gateway.engine.rates

May be used by IRateLimiterComponent implementations.

RateLimiterBucket() - Constructor for class io.apiman.gateway.engine.rates.RateLimiterBucket

registerApplication(Application) - Method in interface io.apiman.gateway.engine.IEngine

Registers a new Application.

registerApplication(Application) - Method in class io.apiman.gateway.engine.impl.EngineImpl

registerApplication(Application) - Method in class io.apiman.gateway.engine.impl.InMemoryRegistry

registerApplication(Application) - Method in interface io.apiman.gateway.engine.IRegistry

Registers a new Application with the registry.

removeAttribute(String) - Method in interface io.apiman.gateway.engine.policy.IPolicyContext

Removes an attribute from the conversation.

removeAttribute(String) - Method in class io.apiman.gateway.engine.policy.PolicyContextImpl

removeHeader(String) - Method in interface io.apiman.gateway.engine.components.http.IHttpClientRequest

Removes a header.

request(String, HttpMethod, IAsyncResultHandler<IHttpClientResponse>) - Method in interface io.apiman.gateway.engine.components.IHttpClientComponent

Creates a new http client request.

RequestChain - Class in io.apiman.gateway.engine.policy

Request phase policy chain.

RequestChain(List<PolicyWithConfiguration>, IPolicyContext) - Constructor for class io.apiman.gateway.engine.policy.RequestChain

Constructor.

resetIfNecessary(RateBucketPeriod) - Method in class io.apiman.gateway.engine.rates.RateLimiterBucket

Resets the count if the period boundary has been crossed.

ResponseChain - Class in io.apiman.gateway.engine.policy

Response phase policy chain.

ResponseChain(List<PolicyWithConfiguration>, IPolicyContext) - Constructor for class io.apiman.gateway.engine.policy.ResponseChain

Constructor.

retireService(String, String, String) - Method in interface io.apiman.gateway.engine.IEngine

Retires (removes) a Service from the registry.

retireService(String, String, String) - Method in class io.apiman.gateway.engine.impl.EngineImpl

retireService(Service) - Method in class io.apiman.gateway.engine.impl.InMemoryRegistry

retireService(Service) - Method in interface io.apiman.gateway.engine.IRegistry

Retires (removes) a Service from the registry.

S

ServiceRequestExecutorImpl - Class in io.apiman.gateway.engine.impl

Manages a single request-response sequence.

ServiceRequestExecutorImpl(ServiceRequest, IAsyncResultHandler<IEngineResult>, ServiceContract, IPolicyContext, List<PolicyWithConfiguration>, IConnectorFactory) - Constructor for class io.apiman.gateway.engine.impl.ServiceRequestExecutorImpl

Constructs a new ServiceRequestExecutorImpl.

set(int, byte) - Method in interface io.apiman.gateway.engine.io.IApimanBuffer

setAttribute(String, Object) - Method in interface io.apiman.gateway.engine.policy.IPolicyContext

Sets a conversation-scoped attribute, allowing policies to pass interesting information to each other and to themselves.

setAttribute(String, Object) - Method in class io.apiman.gateway.engine.policy.PolicyContextImpl

setComponentRegistry(IComponentRegistry) - Method in class io.apiman.gateway.engine.impl.EngineImpl

setConfiguration(Object) - Method in class io.apiman.gateway.engine.policy.PolicyWithConfiguration

setConnectorFactory(IConnectorFactory) - Method in class io.apiman.gateway.engine.impl.EngineImpl

setConnectorResponseStream(ISignalReadStream<ServiceResponse>) - Method in class io.apiman.gateway.engine.impl.EngineResultImpl

setPolicy(IPolicy) - Method in class io.apiman.gateway.engine.policy.PolicyWithConfiguration

setPolicyFactory(IPolicyFactory) - Method in class io.apiman.gateway.engine.impl.EngineImpl

setPolicyFailure(PolicyFailure) - Method in class io.apiman.gateway.engine.impl.EngineResultImpl

setProperty(String, String, T, IAsyncResultHandler<T>) - Method in interface io.apiman.gateway.engine.components.ISharedStateComponent

Sets a single property in the shared state environment, returning the previous value of the property or null if it was not previously set.

setProperty(String, String, T, IAsyncResultHandler<T>) - Method in class io.apiman.gateway.engine.impl.InMemorySharedStateComponent

setRegistry(IRegistry) - Method in class io.apiman.gateway.engine.impl.EngineImpl

setServiceResponse(ServiceResponse) - Method in class io.apiman.gateway.engine.impl.EngineResultImpl

streamHandler(IAsyncHandler<ISignalWriteStream>) - Method in class io.apiman.gateway.engine.impl.ServiceRequestExecutorImpl

streamHandler(IAsyncHandler<ISignalWriteStream>) - Method in interface io.apiman.gateway.engine.IServiceRequestExecutor

Indicates when the back-end connector is ready to handle streamed data.

T

throwError(Throwable) - Method in class io.apiman.gateway.engine.policy.Chain

Called when an unexpected and unrecoverable error is encountered.

throwError(Throwable) - Method in interface io.apiman.gateway.engine.policy.IPolicyChain

Called by a policy when an unexpected and unrecoverable error is encountered.

toString() - Method in interface io.apiman.gateway.engine.io.IApimanBuffer

toString(String) - Method in interface io.apiman.gateway.engine.io.IApimanBuffer

transmit() - Method in interface io.apiman.gateway.engine.io.ISignalReadStream

Signal that transmission may begin.

U

unregisterApplication(String, String, String) - Method in interface io.apiman.gateway.engine.IEngine

Removes an Application from the registry.

unregisterApplication(String, String, String) - Method in class io.apiman.gateway.engine.impl.EngineImpl

unregisterApplication(Application) - Method in class io.apiman.gateway.engine.impl.InMemoryRegistry

unregisterApplication(Application) - Method in interface io.apiman.gateway.engine.IRegistry

Removes an Application from the registry.

V

valueOf(String) - Static method in enum io.apiman.gateway.engine.components.http.HttpMethod

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

valueOf(String) - Static method in enum io.apiman.gateway.engine.rates.RateBucketPeriod

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

values() - Static method in enum io.apiman.gateway.engine.components.http.HttpMethod

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

values() - Static method in enum io.apiman.gateway.engine.rates.RateBucketPeriod

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

Version - Class in io.apiman.gateway.engine

Accessor - used to get the current version of the engine.

W

write(byte[]) - Method in interface io.apiman.gateway.engine.components.http.IHttpClientRequest

Writes some data to the request.

write(String, String) - Method in interface io.apiman.gateway.engine.components.http.IHttpClientRequest

Writes some data to the request, forming the body.

write(IApimanBuffer) - Method in class io.apiman.gateway.engine.io.AbstractStream

write(IApimanBuffer) - Method in interface io.apiman.gateway.engine.io.IWriteStream

Write a chunk to the stream.

write(IApimanBuffer) - Method in class io.apiman.gateway.engine.policy.Chain

A B C D E F G H I L M N P R S T U V W