JDBC Registry & Components

These components are presently optimised for Servlet editions of the gateway, whilst they will work with Vert.x the experience will likely be less performant than normal.
We ship a range of sample DDLs to get you started for all major databases. In your distribution look in apiman/ddls directory, or refer to the Apiman Repo.

A gateway registry and components that uses JDBC (i.e. SQL databases, such as PostgreSQL, MySQL, Oracle, etc).

Registry

To set your registry, assign your chosen implementation to:

apiman-gateway.registry=<IMPLEMENTATION>
Table 1. Available implementations:
Implementation Notes

io.apiman.gateway.engine.jdbc.PollCachingJdbcRegistry

Recommended. Works well in multi-node setups.

io.apiman.gateway.engine.jdbc.CachingJdbcRegistry

Works only in single node setups.

io.apiman.gateway.engine.jdbc.JdbcRegistry

Only recommended for very low volume or test setups; causes database calls to be issued on every request.

Required Parameters

Name Type Description

datasource.jndi-location

String

The JNDI location of the datasource you wish to use.

Example:

apiman-gateway.registry=io.apiman.gateway.engine.jdbc.JdbcRegistry
apiman-gateway.registry.datasource.jndi-location=java:jboss/datasources/apiman-gateway

Optional Parameters

Name Type Description

cache-polling-interval

Integer

Polling interval in millis

cache-polling-startup-delay

Integer

How long to wait before starting polling in millis

Database Initializer

Of course, there is a database schema that must be installed in your database, which creates the tables and indexes needed. This schema can be automatically created by apiman the first time it is used. To enable this feature, you must configure the API Gateway JDBC initializer in the apiman.properties file, like so:

Required Parameters

Name Type Description

apiman-gateway.initializers

String

Initializer type (always JDBC for this use-case)

Required Value: jdbc

apiman-gateway.initializers.jdbc=

String

Use JDBC initialiser (always for this use-case)

Required Value: io.apiman.gateway.engine.jdbc.JdbcInitializer

apiman-gateway.initializers.jdbc.datasource.jndi-location

String

JNDI location for your data source

apiman-gateway.initializers.jdbc.datasource.type

String

Datasource type:

Available Values: h2, mysql5, postgresql9, oracle12

Note, your particular DB version may work successfully with one of these variants.

Example:

# Initializer for the Gateway JDBC
# ################################
apiman.jdbc.datasource.jndi-location=java:jboss/datasources/apiman-gateway
apiman-gateway.initializers=jdbc
apiman-gateway.initializers.jdbc=io.apiman.gateway.engine.jdbc.JdbcInitializer
apiman-gateway.initializers.jdbc.datasource.jndi-location=${apiman.jdbc.datasource.jndi-location}
apiman-gateway.initializers.jdbc.datasource.type=mysql5

Metrics

Set the metrics implementation as shown:

apiman-gateway.metrics=io.apiman.gateway.engine.jdbc.JdbcMetrics
apiman-gateway.metrics.queue.size=10000 // Example.

Required Parameters

See Registry Required Parameters.

Must be configured with the JNDI location of the datasource to use.

Optional Parameters

Name Type Description

queue.size

Integer

Metrics maximum queue size