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

A

AbstractPluginRegistry - Class in io.apiman.manager.api.core.plugin

Serves as a common base class for concrete implementations of IPluginRegistry.

AbstractPluginRegistry() - Constructor for class io.apiman.manager.api.core.plugin.AbstractPluginRegistry

Constructor.

AbstractPluginRegistry(File) - Constructor for class io.apiman.manager.api.core.plugin.AbstractPluginRegistry

Constructor.

ApimanLogger - Annotation Type in io.apiman.manager.api.core.logging

Allows injection of an IApimanLogger instance, with a class passed as the requester

auditEntity(String, String, String, Class<T>, PagingBean) - Method in interface io.apiman.manager.api.core.IStorageQuery

Gets the audit log for an entity.

auditUser(String, PagingBean) - Method in interface io.apiman.manager.api.core.IStorageQuery

Gets the audit log for a user.

B

beginTx() - Method in interface io.apiman.manager.api.core.IStorage

C

clear() - Method in class io.apiman.manager.api.core.util.PolicyConfigMap

clearCache() - Static method in class io.apiman.manager.api.core.util.PolicyTemplateUtil

Clears out the template cache.

commitTx() - Method in interface io.apiman.manager.api.core.IStorage

containsKey(Object) - Method in class io.apiman.manager.api.core.util.PolicyConfigMap

containsValue(Object) - Method in class io.apiman.manager.api.core.util.PolicyConfigMap

createApplication(ApplicationBean) - Method in interface io.apiman.manager.api.core.IStorage

createApplicationVersion(ApplicationVersionBean) - Method in interface io.apiman.manager.api.core.IStorage

createAuditEntry(AuditEntryBean) - Method in interface io.apiman.manager.api.core.IStorage

createContract(ContractBean) - Method in interface io.apiman.manager.api.core.IStorage

createGateway(GatewayBean) - Method in interface io.apiman.manager.api.core.IStorage

createLogger(String) - Method in interface io.apiman.manager.api.core.logging.IDelegateFactory

Create a logger by name

createLogger(Class<?>) - Method in interface io.apiman.manager.api.core.logging.IDelegateFactory

Create a logger by class

createLogger(Class<?>) - Method in class io.apiman.manager.api.core.logging.JsonLoggerImpl

Instantiate a JsonLogger

createLogger(String) - Method in class io.apiman.manager.api.core.logging.JsonLoggerImpl

Instantiate a JsonLogger

createLogger(String) - Method in class io.apiman.manager.api.core.logging.StandardLoggerImpl

createLogger(Class<?>) - Method in class io.apiman.manager.api.core.logging.StandardLoggerImpl

createMembership(RoleMembershipBean) - Method in interface io.apiman.manager.api.core.IIdmStorage

Grants membership into a role for a user.

createOrganization(OrganizationBean) - Method in interface io.apiman.manager.api.core.IStorage

createPlan(PlanBean) - Method in interface io.apiman.manager.api.core.IStorage

createPlanVersion(PlanVersionBean) - Method in interface io.apiman.manager.api.core.IStorage

createPlugin(PluginBean) - Method in interface io.apiman.manager.api.core.IStorage

createPluginClassLoader(File) - Method in class io.apiman.manager.api.core.plugin.AbstractPluginRegistry

Creates a plugin classloader for the given plugin file.

createPolicy(PolicyBean) - Method in interface io.apiman.manager.api.core.IStorage

createPolicyDefinition(PolicyDefinitionBean) - Method in interface io.apiman.manager.api.core.IStorage

createRole(RoleBean) - Method in interface io.apiman.manager.api.core.IIdmStorage

Creates a new role in the role storage system.

createService(ServiceBean) - Method in interface io.apiman.manager.api.core.IStorage

createServiceVersion(ServiceVersionBean) - Method in interface io.apiman.manager.api.core.IStorage

createUser(UserBean) - Method in interface io.apiman.manager.api.core.IIdmStorage

Creates a user in the IDM system.

currentTimeIso8601() - Method in class io.apiman.manager.api.core.logging.DefaultTimeImpl

currentTimeIso8601() - Method in interface io.apiman.manager.api.core.logging.Time

D

debug(String) - Method in interface io.apiman.manager.api.core.logging.IApimanLogger

Log a debug level message

debug(String) - Method in class io.apiman.manager.api.core.logging.JsonLoggerImpl

debug(String) - Method in class io.apiman.manager.api.core.logging.StandardLoggerImpl

DefaultTimeImpl - Class in io.apiman.manager.api.core.logging

Simple ISO-8601 format using local TZ.

DefaultTimeImpl() - Constructor for class io.apiman.manager.api.core.logging.DefaultTimeImpl

deleteApplication(ApplicationBean) - Method in interface io.apiman.manager.api.core.IStorage

deleteApplicationVersion(ApplicationVersionBean) - Method in interface io.apiman.manager.api.core.IStorage

deleteContract(ContractBean) - Method in interface io.apiman.manager.api.core.IStorage

deleteGateway(GatewayBean) - Method in interface io.apiman.manager.api.core.IStorage

deleteMembership(String, String, String) - Method in interface io.apiman.manager.api.core.IIdmStorage

Deletes a single membership.

deleteMemberships(String, String) - Method in interface io.apiman.manager.api.core.IIdmStorage

Deletes all role memberships for a user in a given organization.

deleteOrganization(OrganizationBean) - Method in interface io.apiman.manager.api.core.IStorage

deletePlan(PlanBean) - Method in interface io.apiman.manager.api.core.IStorage

deletePlanVersion(PlanVersionBean) - Method in interface io.apiman.manager.api.core.IStorage

deletePlugin(PluginBean) - Method in interface io.apiman.manager.api.core.IStorage

deletePolicy(PolicyBean) - Method in interface io.apiman.manager.api.core.IStorage

deletePolicyDefinition(PolicyDefinitionBean) - Method in interface io.apiman.manager.api.core.IStorage

deleteRole(RoleBean) - Method in interface io.apiman.manager.api.core.IIdmStorage

Deletes a role from the system.

deleteService(ServiceBean) - Method in interface io.apiman.manager.api.core.IStorage

deleteServiceDefinition(ServiceVersionBean) - Method in interface io.apiman.manager.api.core.IStorage

deleteServiceVersion(ServiceVersionBean) - Method in interface io.apiman.manager.api.core.IStorage

downloadFromMavenRepo(File, PluginCoordinates, URL) - Method in class io.apiman.manager.api.core.plugin.AbstractPluginRegistry

Tries to download the plugin from the given remote maven repository.

downloadPlugin(File, PluginCoordinates) - Method in class io.apiman.manager.api.core.plugin.AbstractPluginRegistry

Downloads the plugin via its maven GAV information.

E

EntityValidator - Class in io.apiman.manager.api.core.util

Validates the state of various entities, including services and applications.

EntityValidator() - Constructor for class io.apiman.manager.api.core.util.EntityValidator

Constructor.

entrySet() - Method in class io.apiman.manager.api.core.util.PolicyConfigMap

error(Throwable) - Method in interface io.apiman.manager.api.core.logging.IApimanLogger

Log an error level message.

error(String, Throwable) - Method in interface io.apiman.manager.api.core.logging.IApimanLogger

Log an error level message.

error(String, Throwable) - Method in class io.apiman.manager.api.core.logging.JsonLoggerImpl

error(Throwable) - Method in class io.apiman.manager.api.core.logging.JsonLoggerImpl

error(Throwable) - Method in class io.apiman.manager.api.core.logging.StandardLoggerImpl

error(String, Throwable) - Method in class io.apiman.manager.api.core.logging.StandardLoggerImpl

F

findApplications(SearchCriteriaBean) - Method in interface io.apiman.manager.api.core.IStorageQuery

Finds applications by the provided criteria.

findOrganizations(SearchCriteriaBean) - Method in interface io.apiman.manager.api.core.IStorageQuery

Finds organizations by the provided criteria.

findPlans(String, SearchCriteriaBean) - Method in interface io.apiman.manager.api.core.IStorageQuery

Finds plans (within an organization) with the given criteria.

findRoles(SearchCriteriaBean) - Method in interface io.apiman.manager.api.core.IIdmStorage

Returns a list of users that match the given search criteria.

findServices(SearchCriteriaBean) - Method in interface io.apiman.manager.api.core.IStorageQuery

Finds services by the provided criteria.

findUsers(SearchCriteriaBean) - Method in interface io.apiman.manager.api.core.IIdmStorage

Returns a list of users that match the given search criteria.

G

generate() - Method in interface io.apiman.manager.api.core.IApiKeyGenerator

Generates a new API key.

generate() - Method in class io.apiman.manager.api.core.UuidApiKeyGenerator

generatePolicyDescription(PolicyBean) - Static method in class io.apiman.manager.api.core.util.PolicyTemplateUtil

Generates a dynamic description for the given policy and stores the result on the policy bean instance.

get(Object) - Method in class io.apiman.manager.api.core.util.PolicyConfigMap

getApiRegistry(String, String, String) - Method in interface io.apiman.manager.api.core.IStorageQuery

Returns the api registry for the given application.

getApplication(String, String) - Method in interface io.apiman.manager.api.core.IStorage

getApplicationContracts(String, String, String) - Method in interface io.apiman.manager.api.core.IStorageQuery

Returns all Contracts for the application.

getApplicationsInOrg(String) - Method in interface io.apiman.manager.api.core.IStorageQuery

Returns summary info for all applications in the given organization.

getApplicationsInOrgs(Set<String>) - Method in interface io.apiman.manager.api.core.IStorageQuery

Returns summary info for all applications in all organizations in the given set.

getApplicationVersion(String, String, String) - Method in interface io.apiman.manager.api.core.IStorage

getApplicationVersions(String, String) - Method in interface io.apiman.manager.api.core.IStorageQuery

Returns all application versions for a given app.

getContract(Long) - Method in interface io.apiman.manager.api.core.IStorage

getGateway(String) - Method in interface io.apiman.manager.api.core.IStorage

getMavenRepositories() - Method in class io.apiman.manager.api.core.plugin.AbstractPluginRegistry

A valid set of remove maven repository URLs.

getMaxPolicyOrderIndex(String, String, String, PolicyType) - Method in interface io.apiman.manager.api.core.IStorageQuery

Returns the largest order index value for the policies assigned to the given entity.

getMembership(String, String, String) - Method in interface io.apiman.manager.api.core.IIdmStorage

Returns a single membership or null if one does not exist.

getOrganization(String) - Method in interface io.apiman.manager.api.core.IStorage

getOrgMemberships(String) - Method in interface io.apiman.manager.api.core.IIdmStorage

Gets all the memberships configured for a particular organization.

getOrgs(Set<String>) - Method in interface io.apiman.manager.api.core.IStorageQuery

Returns summary info for all organizations in the given set.

getPermissions(String) - Method in interface io.apiman.manager.api.core.IIdmStorage

Returns a set of permissions granted to the user due to their role memberships.

getPlan(String, String) - Method in interface io.apiman.manager.api.core.IStorage

getPlansInOrg(String) - Method in interface io.apiman.manager.api.core.IStorageQuery

Returns summary info for all plans in the given organization.

getPlansInOrgs(Set<String>) - Method in interface io.apiman.manager.api.core.IStorageQuery

Returns summary info for all plans in all organizations in the given set.

getPlanVersion(String, String, String) - Method in interface io.apiman.manager.api.core.IStorage

getPlanVersions(String, String) - Method in interface io.apiman.manager.api.core.IStorageQuery

Returns all plan versions for a given plan.

getPlugin(long) - Method in interface io.apiman.manager.api.core.IStorage

getPlugin(String, String) - Method in interface io.apiman.manager.api.core.IStorage

getPolicies(String, String, String, PolicyType) - Method in interface io.apiman.manager.api.core.IStorageQuery

Returns all policies of the given type for the given entity/version.

getPolicy(PolicyType, String, String, String, Long) - Method in interface io.apiman.manager.api.core.IStorage

getPolicyDefinition(String) - Method in interface io.apiman.manager.api.core.IStorage

getRole(String) - Method in interface io.apiman.manager.api.core.IIdmStorage

Gets a role by id.

getService(String, String) - Method in interface io.apiman.manager.api.core.IStorage

getServiceContracts(String, String, String, int, int) - Method in interface io.apiman.manager.api.core.IStorageQuery

Gets a list of contracts for the given service.

getServiceDefinition(ServiceVersionBean) - Method in interface io.apiman.manager.api.core.IStorage

getServicesInOrg(String) - Method in interface io.apiman.manager.api.core.IStorageQuery

Returns summary info for all services in the given organization.

getServicesInOrgs(Set<String>) - Method in interface io.apiman.manager.api.core.IStorageQuery

Returns summary info for all services in all organizations in the given set.

getServiceVersion(String, String, String) - Method in interface io.apiman.manager.api.core.IStorage

getServiceVersionPlans(String, String, String) - Method in interface io.apiman.manager.api.core.IStorageQuery

Returns the service plans configured for the given service version.

getServiceVersions(String, String) - Method in interface io.apiman.manager.api.core.IStorageQuery

Returns all service versions for a given service.

getStorageQuery() - Method in class io.apiman.manager.api.core.util.EntityValidator

getUser(String) - Method in interface io.apiman.manager.api.core.IIdmStorage

Gets a user by id.

getUserMemberships(String) - Method in interface io.apiman.manager.api.core.IIdmStorage

Gets all the user's memberships.

getUserMemberships(String, String) - Method in interface io.apiman.manager.api.core.IIdmStorage

Gets all the user's memberships for the given organization.

I

i18n - Static variable in class io.apiman.manager.api.core.i18n.Messages

IApiKeyGenerator - Interface in io.apiman.manager.api.core

Service responsible for generating unique API keys whenever a contract is created between an Application and a Service it wishes to invoke via a specific plan.

IApimanDelegateLogger - Interface in io.apiman.manager.api.core.logging

See: IDelegateFactory, IApimanLogger

IApimanLogger - Interface in io.apiman.manager.api.core.logging

Simple logging interfaces.

IApplicationValidator - Interface in io.apiman.manager.api.core

Validates the state of applications and application versions.

IDelegateFactory - Interface in io.apiman.manager.api.core.logging

IIdmStorage - Interface in io.apiman.manager.api.core

Interface to manage roles and users.

info(String) - Method in interface io.apiman.manager.api.core.logging.IApimanLogger

Log an info level message

info(String) - Method in class io.apiman.manager.api.core.logging.JsonLoggerImpl

info(String) - Method in class io.apiman.manager.api.core.logging.StandardLoggerImpl

InvalidPluginException - Exception in io.apiman.manager.api.core.exceptions

Thrown if the plugin is invalid

InvalidPluginException() - Constructor for exception io.apiman.manager.api.core.exceptions.InvalidPluginException

Constructor.

InvalidPluginException(String) - Constructor for exception io.apiman.manager.api.core.exceptions.InvalidPluginException

Constructor.

InvalidPluginException(Throwable) - Constructor for exception io.apiman.manager.api.core.exceptions.InvalidPluginException

Constructor.

InvalidPluginException(String, Throwable) - Constructor for exception io.apiman.manager.api.core.exceptions.InvalidPluginException

Constructor.

io.apiman.manager.api.core - package io.apiman.manager.api.core

io.apiman.manager.api.core.exceptions - package io.apiman.manager.api.core.exceptions

io.apiman.manager.api.core.i18n - package io.apiman.manager.api.core.i18n

io.apiman.manager.api.core.logging - package io.apiman.manager.api.core.logging

io.apiman.manager.api.core.plugin - package io.apiman.manager.api.core.plugin

io.apiman.manager.api.core.util - package io.apiman.manager.api.core.util

IPluginRegistry - Interface in io.apiman.manager.api.core

The plugin registry used by the API Manager.

isEmpty() - Method in class io.apiman.manager.api.core.util.PolicyConfigMap

IServiceValidator - Interface in io.apiman.manager.api.core

Validates the state of services and service versions.

isReady(ApplicationVersionBean) - Method in interface io.apiman.manager.api.core.IApplicationValidator

Is the given application Ready to be registered with the Gateway? This method will return true if all of the criteria for registration is met.

isReady(ApplicationVersionBean, boolean) - Method in interface io.apiman.manager.api.core.IApplicationValidator

Is the given application Ready to be registered with the Gateway? This method will return true if all of the criteria for registration is met.

isReady(ServiceVersionBean) - Method in interface io.apiman.manager.api.core.IServiceValidator

Is the given service Ready to be published to the Gateway? This method will return true if all of the criteria for publishing is met.

isReady(ApplicationVersionBean) - Method in class io.apiman.manager.api.core.util.EntityValidator

isReady(ApplicationVersionBean, boolean) - Method in class io.apiman.manager.api.core.util.EntityValidator

isReady(ServiceVersionBean) - Method in class io.apiman.manager.api.core.util.EntityValidator

IStorage - Interface in io.apiman.manager.api.core

Represents the persistent storage interface for Apiman DT.

IStorageQuery - Interface in io.apiman.manager.api.core

Specific querying of the storage layer.

J

JsonLoggerImpl - Class in io.apiman.manager.api.core.logging

Simple JSON logger, see JsonLoggerImpl.jsonify(String, LogLevel, Throwable).

JsonLoggerImpl() - Constructor for class io.apiman.manager.api.core.logging.JsonLoggerImpl

K

keySet() - Method in class io.apiman.manager.api.core.util.PolicyConfigMap

L

listGateways() - Method in interface io.apiman.manager.api.core.IStorageQuery

Lists all of the Gateways.

listPluginPolicyDefs(Long) - Method in interface io.apiman.manager.api.core.IStorageQuery

Lists all of the policy definitions contributed via a particular plugin.

listPlugins() - Method in interface io.apiman.manager.api.core.IStorageQuery

Lists all of the Plugins.

listPolicyDefinitions() - Method in interface io.apiman.manager.api.core.IStorageQuery

Lists the policy definitions in the system.

loadPlugin(PluginCoordinates) - Method in interface io.apiman.manager.api.core.IPluginRegistry

Loads a plugin with the given coordinates.

loadPlugin(PluginCoordinates) - Method in class io.apiman.manager.api.core.plugin.AbstractPluginRegistry

M

Messages - Class in io.apiman.manager.api.core.i18n

I18N Messages

Messages() - Constructor for class io.apiman.manager.api.core.i18n.Messages

Constructor.

P

PolicyConfigMap - Class in io.apiman.manager.api.core.util

Wrapper around a map so that mvel doesn't fail when a property is missing.

PolicyConfigMap(Map<String, Object>) - Constructor for class io.apiman.manager.api.core.util.PolicyConfigMap

Constructor.

PolicyTemplateUtil - Class in io.apiman.manager.api.core.util

Utility for dealing with policy templates.

PolicyTemplateUtil() - Constructor for class io.apiman.manager.api.core.util.PolicyTemplateUtil

put(String, Object) - Method in class io.apiman.manager.api.core.util.PolicyConfigMap

putAll(Map<? extends String, ? extends Object>) - Method in class io.apiman.manager.api.core.util.PolicyConfigMap

R

remove(Object) - Method in class io.apiman.manager.api.core.util.PolicyConfigMap

reorderPolicies(PolicyType, String, String, String, List<Long>) - Method in interface io.apiman.manager.api.core.IStorage

rollbackTx() - Method in interface io.apiman.manager.api.core.IStorage

S

setPluginsDir(File) - Method in class io.apiman.manager.api.core.plugin.AbstractPluginRegistry

setStorageQuery(IStorageQuery) - Method in class io.apiman.manager.api.core.util.EntityValidator

setTimeImpl(Time) - Static method in class io.apiman.manager.api.core.logging.JsonLoggerImpl

Set the time implementation.

size() - Method in class io.apiman.manager.api.core.util.PolicyConfigMap

StandardLoggerImpl - Class in io.apiman.manager.api.core.logging

Simplest possible logger implementation, just does a straight pass-through.

StandardLoggerImpl() - Constructor for class io.apiman.manager.api.core.logging.StandardLoggerImpl

StorageException - Exception in io.apiman.manager.api.core.exceptions

Thrown if a storage problem occurs while storing a bean.

StorageException() - Constructor for exception io.apiman.manager.api.core.exceptions.StorageException

Constructor.

StorageException(String) - Constructor for exception io.apiman.manager.api.core.exceptions.StorageException

Constructor.

StorageException(Throwable) - Constructor for exception io.apiman.manager.api.core.exceptions.StorageException

Constructor.

T

Time - Interface in io.apiman.manager.api.core.logging

Particularly useful for testing purposes: provides time.

trace(String) - Method in interface io.apiman.manager.api.core.logging.IApimanLogger

Log a trace level message

trace(String) - Method in class io.apiman.manager.api.core.logging.JsonLoggerImpl

trace(String) - Method in class io.apiman.manager.api.core.logging.StandardLoggerImpl

U

updateApplication(ApplicationBean) - Method in interface io.apiman.manager.api.core.IStorage

updateApplicationVersion(ApplicationVersionBean) - Method in interface io.apiman.manager.api.core.IStorage

updateGateway(GatewayBean) - Method in interface io.apiman.manager.api.core.IStorage

updateOrganization(OrganizationBean) - Method in interface io.apiman.manager.api.core.IStorage

updatePlan(PlanBean) - Method in interface io.apiman.manager.api.core.IStorage

updatePlanVersion(PlanVersionBean) - Method in interface io.apiman.manager.api.core.IStorage

updatePolicy(PolicyBean) - Method in interface io.apiman.manager.api.core.IStorage

updatePolicyDefinition(PolicyDefinitionBean) - Method in interface io.apiman.manager.api.core.IStorage

updateRole(RoleBean) - Method in interface io.apiman.manager.api.core.IIdmStorage

Updates a single role (typically with new permissions).

updateService(ServiceBean) - Method in interface io.apiman.manager.api.core.IStorage

updateServiceDefinition(ServiceVersionBean, InputStream) - Method in interface io.apiman.manager.api.core.IStorage

updateServiceVersion(ServiceVersionBean) - Method in interface io.apiman.manager.api.core.IStorage

updateUser(UserBean) - Method in interface io.apiman.manager.api.core.IIdmStorage

Updates the personal information about a user.

UuidApiKeyGenerator - Class in io.apiman.manager.api.core

A simple api key generator using java UUIDs.

UuidApiKeyGenerator() - Constructor for class io.apiman.manager.api.core.UuidApiKeyGenerator

Constructor.

V

values() - Method in class io.apiman.manager.api.core.util.PolicyConfigMap

W

warn(String) - Method in interface io.apiman.manager.api.core.logging.IApimanLogger

Log a warning

warn(String) - Method in class io.apiman.manager.api.core.logging.JsonLoggerImpl

warn(String) - Method in class io.apiman.manager.api.core.logging.StandardLoggerImpl

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