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

A

abort() - Method in class io.apiman.gateway.engine.policies.connectors.CachedResponseConnection

AbstractIPListPolicy<C> - Class in io.apiman.gateway.engine.policies

Base class for the ip whitelist and blacklist policies.

AbstractIPListPolicy() - Constructor for class io.apiman.gateway.engine.policies.AbstractIPListPolicy

AbstractMappedPolicy<C> - Class in io.apiman.gateway.engine.policies

A base class for policy impls that use jackson to parse configuration info.

AbstractMappedPolicy() - Constructor for class io.apiman.gateway.engine.policies.AbstractMappedPolicy

Constructor.

apply(ServiceRequest, IPolicyContext, Object, IPolicyChain<ServiceRequest>) - Method in class io.apiman.gateway.engine.policies.AbstractMappedPolicy

apply(ServiceResponse, IPolicyContext, Object, IPolicyChain<ServiceResponse>) - Method in class io.apiman.gateway.engine.policies.AbstractMappedPolicy

B

BASIC_AUTH_FAILED - Static variable in class io.apiman.gateway.engine.policies.PolicyFailureCodes

BASIC_AUTH_REQUIRED - Static variable in class io.apiman.gateway.engine.policies.PolicyFailureCodes

BasicAuthenticationConfig - Class in io.apiman.gateway.engine.policies.config

Configuration object for the IP blacklist policy.

BasicAuthenticationConfig() - Constructor for class io.apiman.gateway.engine.policies.config.BasicAuthenticationConfig

Constructor.

BasicAuthenticationPolicy - Class in io.apiman.gateway.engine.policies

An implementation of an apiman policy that supports multiple styles of authentication.

BasicAuthenticationPolicy() - Constructor for class io.apiman.gateway.engine.policies.BasicAuthenticationPolicy

Constructor.

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

C

CACHED_RESPONSE - Static variable in class io.apiman.gateway.engine.policies.CachingPolicy

CachedResponseConnection - Class in io.apiman.gateway.engine.policies.connectors

This IServiceConnection implementation aims to simulate a back-end connection but what will do is to retrieve an existing CachedResponse from the IDataStoreComponent and generate the IServiceConnectionResponse

CachedResponseConnection(IPolicyContext) - Constructor for class io.apiman.gateway.engine.policies.connectors.CachedResponseConnection

CachingConfig - Class in io.apiman.gateway.engine.policies.config

Configuration object for the Caching policy.

CachingConfig() - Constructor for class io.apiman.gateway.engine.policies.config.CachingConfig

Constructor.

CachingPolicy - Class in io.apiman.gateway.engine.policies

Policy that enables caching for back-end services responses.

CachingPolicy() - Constructor for class io.apiman.gateway.engine.policies.CachingPolicy

Constructor.

D

doApply(ServiceRequest, IPolicyContext, C, IPolicyChain<ServiceRequest>) - Method in class io.apiman.gateway.engine.policies.AbstractMappedPolicy

doApply(ServiceResponse, IPolicyContext, C, IPolicyChain<ServiceResponse>) - Method in class io.apiman.gateway.engine.policies.AbstractMappedPolicy

Apply the policy to the response.

doApply(ServiceRequest, IPolicyContext, BasicAuthenticationConfig, IPolicyChain<ServiceRequest>) - Method in class io.apiman.gateway.engine.policies.BasicAuthenticationPolicy

doApply(ServiceRequest, IPolicyContext, CachingConfig, IPolicyChain<ServiceRequest>) - Method in class io.apiman.gateway.engine.policies.CachingPolicy

If the request is cached an IConnectorInterceptor is set in order to prevent the back-end connection to be established.

doApply(ServiceResponse, IPolicyContext, CachingConfig, IPolicyChain<ServiceResponse>) - Method in class io.apiman.gateway.engine.policies.CachingPolicy

doApply(ServiceRequest, IPolicyContext, IgnoredResourcesConfig, IPolicyChain<ServiceRequest>) - Method in class io.apiman.gateway.engine.policies.IgnoredResourcesPolicy

doApply(ServiceRequest, IPolicyContext, IPListConfig, IPolicyChain<ServiceRequest>) - Method in class io.apiman.gateway.engine.policies.IPBlacklistPolicy

doApply(ServiceRequest, IPolicyContext, IPListConfig, IPolicyChain<ServiceRequest>) - Method in class io.apiman.gateway.engine.policies.IPWhitelistPolicy

doApply(ServiceRequest, IPolicyContext, RateLimitingConfig, IPolicyChain<ServiceRequest>) - Method in class io.apiman.gateway.engine.policies.RateLimitingPolicy

doApply(ServiceResponse, IPolicyContext, RateLimitingConfig, IPolicyChain<ServiceResponse>) - Method in class io.apiman.gateway.engine.policies.RateLimitingPolicy

E

end() - Method in class io.apiman.gateway.engine.policies.connectors.CachedResponseConnection

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

G

getConfigurationClass() - Method in class io.apiman.gateway.engine.policies.AbstractMappedPolicy

getConfigurationClass() - Method in class io.apiman.gateway.engine.policies.BasicAuthenticationPolicy

getConfigurationClass() - Method in class io.apiman.gateway.engine.policies.CachingPolicy

getConfigurationClass() - Method in class io.apiman.gateway.engine.policies.IgnoredResourcesPolicy

getConfigurationClass() - Method in class io.apiman.gateway.engine.policies.IPBlacklistPolicy

getConfigurationClass() - Method in class io.apiman.gateway.engine.policies.IPWhitelistPolicy

getConfigurationClass() - Method in class io.apiman.gateway.engine.policies.RateLimitingPolicy

getDatasourcePath() - Method in class io.apiman.gateway.engine.policies.config.basicauth.JDBCIdentitySource

getDnPattern() - Method in class io.apiman.gateway.engine.policies.config.basicauth.LDAPIdentitySource

getForwardIdentityHttpHeader() - Method in class io.apiman.gateway.engine.policies.config.BasicAuthenticationConfig

getGranularity() - Method in class io.apiman.gateway.engine.policies.config.RateLimitingConfig

getHashAlgorithm() - Method in class io.apiman.gateway.engine.policies.config.basicauth.JDBCIdentitySource

getHead() - Method in class io.apiman.gateway.engine.policies.connectors.CachedResponseConnection

getHeaderLimit() - Method in class io.apiman.gateway.engine.policies.config.RateLimitingConfig

getHeaderRemaining() - Method in class io.apiman.gateway.engine.policies.config.RateLimitingConfig

getHeaderReset() - Method in class io.apiman.gateway.engine.policies.config.RateLimitingConfig

getHttpHeader() - Method in class io.apiman.gateway.engine.policies.config.IPListConfig

getIdentities() - Method in class io.apiman.gateway.engine.policies.config.basicauth.StaticIdentitySource

getIpList() - Method in class io.apiman.gateway.engine.policies.config.IPListConfig

getIsHash() - Method in class io.apiman.gateway.engine.policies.config.basicauth.StaticIdentity

getJdbcIdentity() - Method in class io.apiman.gateway.engine.policies.config.BasicAuthenticationConfig

getLdapIdentity() - Method in class io.apiman.gateway.engine.policies.config.BasicAuthenticationConfig

getLimit() - Method in class io.apiman.gateway.engine.policies.config.RateLimitingConfig

getPassword() - Method in class io.apiman.gateway.engine.policies.config.basicauth.StaticIdentity

getPathsToIgnore() - Method in class io.apiman.gateway.engine.policies.config.IgnoredResourcesConfig

getPeriod() - Method in class io.apiman.gateway.engine.policies.config.RateLimitingConfig

getQuery() - Method in class io.apiman.gateway.engine.policies.config.basicauth.JDBCIdentitySource

getRealm() - Method in class io.apiman.gateway.engine.policies.config.BasicAuthenticationConfig

getRemoteAddr(ServiceRequest, IPListConfig) - Method in class io.apiman.gateway.engine.policies.AbstractIPListPolicy

Gets the remote address for comparison.

getRequestDataHandler(ServiceRequest, IPolicyContext) - Method in class io.apiman.gateway.engine.policies.CachingPolicy

The request will not be altered.

getResponseDataHandler(ServiceResponse, IPolicyContext) - Method in class io.apiman.gateway.engine.policies.CachingPolicy

The response is received from the back-end service and needs to be written into the CachedResponse.

getStaticIdentity() - Method in class io.apiman.gateway.engine.policies.config.BasicAuthenticationConfig

getTtl() - Method in class io.apiman.gateway.engine.policies.config.CachingConfig

getUrl() - Method in class io.apiman.gateway.engine.policies.config.basicauth.LDAPIdentitySource

getUserHeader() - Method in class io.apiman.gateway.engine.policies.config.RateLimitingConfig

getUsername() - Method in class io.apiman.gateway.engine.policies.config.basicauth.StaticIdentity

I

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

IgnoredResourcesConfig - Class in io.apiman.gateway.engine.policies.config

Configuration object for the Ignored Resources policy.

IgnoredResourcesConfig() - Constructor for class io.apiman.gateway.engine.policies.config.IgnoredResourcesConfig

Constructor.

IgnoredResourcesPolicy - Class in io.apiman.gateway.engine.policies

A simple policy that causes a failure if the paths of the inbound request matching the configured set of regular expressions.

IgnoredResourcesPolicy() - Constructor for class io.apiman.gateway.engine.policies.IgnoredResourcesPolicy

Constructor.

IIdentityValidator<C> - Interface in io.apiman.gateway.engine.policies.auth

Interface used to validate an inbound user.

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

io.apiman.gateway.engine.policies.auth - package io.apiman.gateway.engine.policies.auth

io.apiman.gateway.engine.policies.config - package io.apiman.gateway.engine.policies.config

io.apiman.gateway.engine.policies.config.basicauth - package io.apiman.gateway.engine.policies.config.basicauth

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

io.apiman.gateway.engine.policies.connectors - package io.apiman.gateway.engine.policies.connectors

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

IP_BLACKLISTED - Static variable in class io.apiman.gateway.engine.policies.PolicyFailureCodes

IP_NOT_WHITELISTED - Static variable in class io.apiman.gateway.engine.policies.PolicyFailureCodes

IPBlacklistPolicy - Class in io.apiman.gateway.engine.policies

A simple policy that fails the inbound request if its IP address is included in the list of dis-allowed IPs.

IPBlacklistPolicy() - Constructor for class io.apiman.gateway.engine.policies.IPBlacklistPolicy

Constructor.

IPListConfig - Class in io.apiman.gateway.engine.policies.config

Configuration object for the IP list policies.

IPListConfig() - Constructor for class io.apiman.gateway.engine.policies.config.IPListConfig

Constructor.

IPWhitelistPolicy - Class in io.apiman.gateway.engine.policies

A simple policy that causes a failure if the IP address of the inbound request is not included in a specific list of allowed IP addresses.

IPWhitelistPolicy() - Constructor for class io.apiman.gateway.engine.policies.IPWhitelistPolicy

Constructor.

isFinished() - Method in class io.apiman.gateway.engine.policies.connectors.CachedResponseConnection

isMatch(IPListConfig, String) - Method in class io.apiman.gateway.engine.policies.AbstractIPListPolicy

Returns true if the remote address is a match for the configured values in the IP List.

J

JDBCIdentitySource - Class in io.apiman.gateway.engine.policies.config.basicauth

Information about the LDAP server to use to authenticate an inbound user.

JDBCIdentitySource() - Constructor for class io.apiman.gateway.engine.policies.config.basicauth.JDBCIdentitySource

Constructor.

JDBCIdentityValidator - Class in io.apiman.gateway.engine.policies.auth

An identity validator that uses the static information in the config to validate the user.

JDBCIdentityValidator() - Constructor for class io.apiman.gateway.engine.policies.auth.JDBCIdentityValidator

Constructor.

L

LDAPIdentitySource - Class in io.apiman.gateway.engine.policies.config.basicauth

Information about the LDAP server to use to authenticate an inbound user.

LDAPIdentitySource() - Constructor for class io.apiman.gateway.engine.policies.config.basicauth.LDAPIdentitySource

Constructor.

LDAPIdentityValidator - Class in io.apiman.gateway.engine.policies.auth

An identity validator that uses the static information in the config to validate the user.

LDAPIdentityValidator() - Constructor for class io.apiman.gateway.engine.policies.auth.LDAPIdentityValidator

Constructor.

M

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

I18N Messages

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

Constructor.

N

NO_APP_FOR_RATE_LIMITING - Static variable in class io.apiman.gateway.engine.policies.PolicyFailureCodes

NO_USER_FOR_RATE_LIMITING - Static variable in class io.apiman.gateway.engine.policies.PolicyFailureCodes

P

parseConfiguration(String) - Method in class io.apiman.gateway.engine.policies.AbstractMappedPolicy

PasswordHashAlgorithmType - Enum in io.apiman.gateway.engine.policies.config.basicauth

The supported hash algorithms when authenticating against information found in a database.

PATHS_TO_IGNORE - Static variable in class io.apiman.gateway.engine.policies.PolicyFailureCodes

PolicyFailureCodes - Class in io.apiman.gateway.engine.policies

An index of all standard apiman policy failure codes.

PolicyFailureCodes() - Constructor for class io.apiman.gateway.engine.policies.PolicyFailureCodes

R

RATE_LIMIT_EXCEEDED - Static variable in class io.apiman.gateway.engine.policies.PolicyFailureCodes

RateLimitingConfig - Class in io.apiman.gateway.engine.policies.config

Configuration object for the rate limiting policy.

RateLimitingConfig() - Constructor for class io.apiman.gateway.engine.policies.config.RateLimitingConfig

Constructor.

RateLimitingGranularity - Enum in io.apiman.gateway.engine.policies.config.rates

The granularity to use when limiting rates.

RateLimitingPeriod - Enum in io.apiman.gateway.engine.policies.config.rates

The period over which rates will be limited.

RateLimitingPolicy - Class in io.apiman.gateway.engine.policies

Policy that enforces rate limits.

RateLimitingPolicy() - Constructor for class io.apiman.gateway.engine.policies.RateLimitingPolicy

Constructor.

S

sendAuthFailure(IPolicyContext, IPolicyChain<?>, BasicAuthenticationConfig, int) - Method in class io.apiman.gateway.engine.policies.BasicAuthenticationPolicy

Sends the 'unauthenticated' response as a policy failure.

setDatasourcePath(String) - Method in class io.apiman.gateway.engine.policies.config.basicauth.JDBCIdentitySource

setDnPattern(String) - Method in class io.apiman.gateway.engine.policies.config.basicauth.LDAPIdentitySource

setForwardIdentityHttpHeader(String) - Method in class io.apiman.gateway.engine.policies.config.BasicAuthenticationConfig

setGranularity(RateLimitingGranularity) - Method in class io.apiman.gateway.engine.policies.config.RateLimitingConfig

setHashAlgorithm(PasswordHashAlgorithmType) - Method in class io.apiman.gateway.engine.policies.config.basicauth.JDBCIdentitySource

setHeaderLimit(String) - Method in class io.apiman.gateway.engine.policies.config.RateLimitingConfig

setHeaderRemaining(String) - Method in class io.apiman.gateway.engine.policies.config.RateLimitingConfig

setHeaderReset(String) - Method in class io.apiman.gateway.engine.policies.config.RateLimitingConfig

setHttpHeader(String) - Method in class io.apiman.gateway.engine.policies.config.IPListConfig

setIdentities(List<StaticIdentity>) - Method in class io.apiman.gateway.engine.policies.config.basicauth.StaticIdentitySource

setIpList(Set<String>) - Method in class io.apiman.gateway.engine.policies.config.IPListConfig

setIsHash(boolean) - Method in class io.apiman.gateway.engine.policies.config.basicauth.StaticIdentity

setJdbcIdentity(JDBCIdentitySource) - Method in class io.apiman.gateway.engine.policies.config.BasicAuthenticationConfig

setLdapIdentity(LDAPIdentitySource) - Method in class io.apiman.gateway.engine.policies.config.BasicAuthenticationConfig

setLimit(int) - Method in class io.apiman.gateway.engine.policies.config.RateLimitingConfig

setPassword(String) - Method in class io.apiman.gateway.engine.policies.config.basicauth.StaticIdentity

setPathsToIgnore(List<String>) - Method in class io.apiman.gateway.engine.policies.config.IgnoredResourcesConfig

setPeriod(RateLimitingPeriod) - Method in class io.apiman.gateway.engine.policies.config.RateLimitingConfig

setQuery(String) - Method in class io.apiman.gateway.engine.policies.config.basicauth.JDBCIdentitySource

setRealm(String) - Method in class io.apiman.gateway.engine.policies.config.BasicAuthenticationConfig

setStaticIdentity(StaticIdentitySource) - Method in class io.apiman.gateway.engine.policies.config.BasicAuthenticationConfig

setTtl(long) - Method in class io.apiman.gateway.engine.policies.config.CachingConfig

setUrl(String) - Method in class io.apiman.gateway.engine.policies.config.basicauth.LDAPIdentitySource

setUserHeader(String) - Method in class io.apiman.gateway.engine.policies.config.RateLimitingConfig

setUsername(String) - Method in class io.apiman.gateway.engine.policies.config.basicauth.StaticIdentity

StaticIdentity - Class in io.apiman.gateway.engine.policies.config.basicauth

A single static identity used for basic authentication.

StaticIdentity() - Constructor for class io.apiman.gateway.engine.policies.config.basicauth.StaticIdentity

Constructor.

StaticIdentitySource - Class in io.apiman.gateway.engine.policies.config.basicauth

A simple static set of identities used to perform basic authentication by the BasicAuthenticationPolicy implementation.

StaticIdentitySource() - Constructor for class io.apiman.gateway.engine.policies.config.basicauth.StaticIdentitySource

Constructor.

StaticIdentityValidator - Class in io.apiman.gateway.engine.policies.auth

An identity validator that uses the static information in the config to validate the user.

StaticIdentityValidator() - Constructor for class io.apiman.gateway.engine.policies.auth.StaticIdentityValidator

Constructor.

T

transmit() - Method in class io.apiman.gateway.engine.policies.connectors.CachedResponseConnection

V

validate(String, String, ServiceRequest, IPolicyContext, C, IAsyncResultHandler<Boolean>) - Method in interface io.apiman.gateway.engine.policies.auth.IIdentityValidator

Asynchronously validates a user.

validate(String, String, ServiceRequest, IPolicyContext, JDBCIdentitySource, IAsyncResultHandler<Boolean>) - Method in class io.apiman.gateway.engine.policies.auth.JDBCIdentityValidator

validate(String, String, ServiceRequest, IPolicyContext, LDAPIdentitySource, IAsyncResultHandler<Boolean>) - Method in class io.apiman.gateway.engine.policies.auth.LDAPIdentityValidator

validate(String, String, ServiceRequest, IPolicyContext, StaticIdentitySource, IAsyncResultHandler<Boolean>) - Method in class io.apiman.gateway.engine.policies.auth.StaticIdentityValidator

valueOf(String) - Static method in enum io.apiman.gateway.engine.policies.config.basicauth.PasswordHashAlgorithmType

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

valueOf(String) - Static method in enum io.apiman.gateway.engine.policies.config.rates.RateLimitingGranularity

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

valueOf(String) - Static method in enum io.apiman.gateway.engine.policies.config.rates.RateLimitingPeriod

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

values() - Static method in enum io.apiman.gateway.engine.policies.config.basicauth.PasswordHashAlgorithmType

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.policies.config.rates.RateLimitingGranularity

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.policies.config.rates.RateLimitingPeriod

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

W

write(IApimanBuffer) - Method in class io.apiman.gateway.engine.policies.connectors.CachedResponseConnection

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