io.apiman.manager.api.core

Interface IStorageQuery

public interface IStorageQuery

Specific querying of the storage layer.

Author:

eric.wittmann@redhat.com

Method Summary

Methods

Modifier and Type	Method and Description
<T> io.apiman.manager.api.beans.search.SearchResultsBean<io.apiman.manager.api.beans.audit.AuditEntryBean>	auditEntity(String organizationId, String entityId, String entityVersion, Class<T> type, io.apiman.manager.api.beans.search.PagingBean paging) Gets the audit log for an entity.
<T> io.apiman.manager.api.beans.search.SearchResultsBean<io.apiman.manager.api.beans.audit.AuditEntryBean>	auditUser(String userId, io.apiman.manager.api.beans.search.PagingBean paging) Gets the audit log for a user.
io.apiman.manager.api.beans.search.SearchResultsBean<io.apiman.manager.api.beans.summary.ApplicationSummaryBean>	findApplications(io.apiman.manager.api.beans.search.SearchCriteriaBean criteria) Finds applications by the provided criteria.
io.apiman.manager.api.beans.search.SearchResultsBean<io.apiman.manager.api.beans.summary.OrganizationSummaryBean>	findOrganizations(io.apiman.manager.api.beans.search.SearchCriteriaBean criteria) Finds organizations by the provided criteria.
io.apiman.manager.api.beans.search.SearchResultsBean<io.apiman.manager.api.beans.summary.PlanSummaryBean>	findPlans(String organizationId, io.apiman.manager.api.beans.search.SearchCriteriaBean criteria) Finds plans (within an organization) with the given criteria.
io.apiman.manager.api.beans.search.SearchResultsBean<io.apiman.manager.api.beans.summary.ServiceSummaryBean>	findServices(io.apiman.manager.api.beans.search.SearchCriteriaBean criteria) Finds services by the provided criteria.
io.apiman.manager.api.beans.summary.ApiRegistryBean	getApiRegistry(String organizationId, String applicationId, String version) Returns the api registry for the given application.
List<io.apiman.manager.api.beans.summary.ContractSummaryBean>	getApplicationContracts(String organizationId, String applicationId, String version) Returns all Contracts for the application.
List<io.apiman.manager.api.beans.summary.ApplicationSummaryBean>	getApplicationsInOrg(String organizationId) Returns summary info for all applications in the given organization.
List<io.apiman.manager.api.beans.summary.ApplicationSummaryBean>	getApplicationsInOrgs(Set<String> organizationIds) Returns summary info for all applications in all organizations in the given set.
List<io.apiman.manager.api.beans.summary.ApplicationVersionSummaryBean>	getApplicationVersions(String organizationId, String applicationId) Returns all application versions for a given app.
int	getMaxPolicyOrderIndex(String organizationId, String entityId, String entityVersion, io.apiman.manager.api.beans.policies.PolicyType type) Returns the largest order index value for the policies assigned to the given entity.
List<io.apiman.manager.api.beans.summary.OrganizationSummaryBean>	getOrgs(Set<String> organizationIds) Returns summary info for all organizations in the given set.
List<io.apiman.manager.api.beans.summary.PlanSummaryBean>	getPlansInOrg(String organizationId) Returns summary info for all plans in the given organization.
List<io.apiman.manager.api.beans.summary.PlanSummaryBean>	getPlansInOrgs(Set<String> organizationIds) Returns summary info for all plans in all organizations in the given set.
List<io.apiman.manager.api.beans.summary.PlanVersionSummaryBean>	getPlanVersions(String organizationId, String planId) Returns all plan versions for a given plan.
List<io.apiman.manager.api.beans.summary.PolicySummaryBean>	getPolicies(String organizationId, String entityId, String version, io.apiman.manager.api.beans.policies.PolicyType type) Returns all policies of the given type for the given entity/version.
List<io.apiman.manager.api.beans.summary.ContractSummaryBean>	getServiceContracts(String organizationId, String serviceId, String version, int page, int pageSize) Gets a list of contracts for the given service.
List<io.apiman.manager.api.beans.summary.ServiceSummaryBean>	getServicesInOrg(String organizationId) Returns summary info for all services in the given organization.
List<io.apiman.manager.api.beans.summary.ServiceSummaryBean>	getServicesInOrgs(Set<String> organizationIds) Returns summary info for all services in all organizations in the given set.
List<io.apiman.manager.api.beans.summary.ServicePlanSummaryBean>	getServiceVersionPlans(String organizationId, String serviceId, String version) Returns the service plans configured for the given service version.
List<io.apiman.manager.api.beans.summary.ServiceVersionSummaryBean>	getServiceVersions(String organizationId, String serviceId) Returns all service versions for a given service.
List<io.apiman.manager.api.beans.summary.GatewaySummaryBean>	listGateways() Lists all of the Gateways.
List<io.apiman.manager.api.beans.summary.PolicyDefinitionSummaryBean>	listPluginPolicyDefs(Long pluginId) Lists all of the policy definitions contributed via a particular plugin.
List<io.apiman.manager.api.beans.summary.PluginSummaryBean>	listPlugins() Lists all of the Plugins.
List<io.apiman.manager.api.beans.summary.PolicyDefinitionSummaryBean>	listPolicyDefinitions() Lists the policy definitions in the system.

Method Detail

listPlugins

List<io.apiman.manager.api.beans.summary.PluginSummaryBean> listPlugins()
                                                                        throws StorageException

Lists all of the Plugins.

Returns:

list of plugins

Throws:

StorageException - if a storage problem occurs while storing a bean.

listGateways

List<io.apiman.manager.api.beans.summary.GatewaySummaryBean> listGateways()
                                                                          throws StorageException

Lists all of the Gateways.

Returns:

list of gateways

Throws:

StorageException - if a storage problem occurs while storing a bean.

findOrganizations

io.apiman.manager.api.beans.search.SearchResultsBean<io.apiman.manager.api.beans.summary.OrganizationSummaryBean> findOrganizations(io.apiman.manager.api.beans.search.SearchCriteriaBean criteria)
                                                                                                                                    throws StorageException

Finds organizations by the provided criteria.

Parameters:

criteria - search criteria search criteria

Returns:

found orgs

Throws:

StorageException - if a storage problem occurs while storing a bean.

findApplications

io.apiman.manager.api.beans.search.SearchResultsBean<io.apiman.manager.api.beans.summary.ApplicationSummaryBean> findApplications(io.apiman.manager.api.beans.search.SearchCriteriaBean criteria)
                                                                                                                                  throws StorageException

Finds applications by the provided criteria.

Parameters:

criteria - search criteria

Returns:

found applications

Throws:

StorageException - if a storage problem occurs while storing a bean.

findServices

io.apiman.manager.api.beans.search.SearchResultsBean<io.apiman.manager.api.beans.summary.ServiceSummaryBean> findServices(io.apiman.manager.api.beans.search.SearchCriteriaBean criteria)
                                                                                                                          throws StorageException

Finds services by the provided criteria.

Parameters:

criteria - search criteria

Returns:

found services

Throws:

StorageException - if a storage problem occurs while storing a bean.

findPlans

io.apiman.manager.api.beans.search.SearchResultsBean<io.apiman.manager.api.beans.summary.PlanSummaryBean> findPlans(String organizationId,
                                                                                                                  io.apiman.manager.api.beans.search.SearchCriteriaBean criteria)
                                                                                                                    throws StorageException

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

Parameters:

organizationId - the organization id

criteria - search criteria

Returns:

found plans

Throws:

StorageException - if a storage problem occurs while storing a bean.

auditEntity

<T> io.apiman.manager.api.beans.search.SearchResultsBean<io.apiman.manager.api.beans.audit.AuditEntryBean> auditEntity(String organizationId,
                                                                                                                     String entityId,
                                                                                                                     String entityVersion,
                                                                                                                     Class<T> type,
                                                                                                                     io.apiman.manager.api.beans.search.PagingBean paging)
                                                                                                                   throws StorageException

Gets the audit log for an entity.

Parameters:

organizationId - the organization id

entityId - the entity id

entityVersion - the entity version

type - the type

paging - the paging specification

Returns:

audit entity

Throws:

StorageException - if a storage problem occurs while storing a bean.

auditUser

<T> io.apiman.manager.api.beans.search.SearchResultsBean<io.apiman.manager.api.beans.audit.AuditEntryBean> auditUser(String userId,
                                                                                                                   io.apiman.manager.api.beans.search.PagingBean paging)
                                                                                                                 throws StorageException

Gets the audit log for a user.

Parameters:

userId - the user id

paging - the paging specification

Returns:

audit user

Throws:

StorageException - if a storage problem occurs while storing a bean.

getOrgs

List<io.apiman.manager.api.beans.summary.OrganizationSummaryBean> getOrgs(Set<String> organizationIds)
                                                                          throws StorageException

Returns summary info for all organizations in the given set.

Parameters:

organizationIds - the organization ids

Returns:

list of orgs

Throws:

StorageException - if a storage problem occurs while storing a bean.

getApplicationsInOrgs

List<io.apiman.manager.api.beans.summary.ApplicationSummaryBean> getApplicationsInOrgs(Set<String> organizationIds)
                                                                                       throws StorageException

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

Parameters:

organizationIds - the organization ids

Returns:

list of applications in orgs

Throws:

StorageException - if a storage problem occurs while storing a bean.

getApplicationsInOrg

List<io.apiman.manager.api.beans.summary.ApplicationSummaryBean> getApplicationsInOrg(String organizationId)
                                                                                      throws StorageException

Returns summary info for all applications in the given organization.

Parameters:

organizationId - the organization id

Returns:

list of applications

Throws:

StorageException - if a storage problem occurs while storing a bean.

getApplicationVersions

List<io.apiman.manager.api.beans.summary.ApplicationVersionSummaryBean> getApplicationVersions(String organizationId,
                                                                                             String applicationId)
                                                                                               throws StorageException

Returns all application versions for a given app.

Parameters:

organizationId - the organization id

applicationId - the application id

Returns:

list of application versions

Throws:

StorageException - if a storage problem occurs while storing a bean.

getApplicationContracts

List<io.apiman.manager.api.beans.summary.ContractSummaryBean> getApplicationContracts(String organizationId,
                                                                                    String applicationId,
                                                                                    String version)
                                                                                      throws StorageException

Returns all Contracts for the application.

Parameters:

organizationId - the organization id

applicationId - the application id

version - the version

Returns:

list of application contracts

Throws:

StorageException - if a storage problem occurs while storing a bean.

getApiRegistry

io.apiman.manager.api.beans.summary.ApiRegistryBean getApiRegistry(String organizationId,
                                                                 String applicationId,
                                                                 String version)
                                                                   throws StorageException

Returns the api registry for the given application.

Parameters:

organizationId - the organization id

applicationId - the application id

version - the version

Returns:

the registry bean

Throws:

StorageException - if a storage problem occurs while storing a bean.

getServicesInOrgs

List<io.apiman.manager.api.beans.summary.ServiceSummaryBean> getServicesInOrgs(Set<String> organizationIds)
                                                                               throws StorageException

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

Parameters:

organizationIds - the organization ids

Returns:

services in orgs

Throws:

StorageException - if a storage problem occurs while storing a bean.

getServicesInOrg

List<io.apiman.manager.api.beans.summary.ServiceSummaryBean> getServicesInOrg(String organizationId)
                                                                              throws StorageException

Returns summary info for all services in the given organization.

Parameters:

organizationId - the organization id

Returns:

list of services in org

Throws:

StorageException - if a storage problem occurs while storing a bean.

getServiceVersions

List<io.apiman.manager.api.beans.summary.ServiceVersionSummaryBean> getServiceVersions(String organizationId,
                                                                                     String serviceId)
                                                                                       throws StorageException

Returns all service versions for a given service.

Parameters:

organizationId - the organization id

serviceId - the service id

Returns:

list of service versions

Throws:

StorageException - if a storage problem occurs while storing a bean.

getServiceVersionPlans

List<io.apiman.manager.api.beans.summary.ServicePlanSummaryBean> getServiceVersionPlans(String organizationId,
                                                                                      String serviceId,
                                                                                      String version)
                                                                                        throws StorageException

Returns the service plans configured for the given service version.

Parameters:

organizationId - the organization id

serviceId - the service id

version - the version

Returns:

list of service plans

Throws:

StorageException - if a storage problem occurs while storing a bean.

getPlansInOrgs

List<io.apiman.manager.api.beans.summary.PlanSummaryBean> getPlansInOrgs(Set<String> organizationIds)
                                                                         throws StorageException

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

Parameters:

organizationIds - the organization ids

Returns:

list of plans in orgs

Throws:

StorageException - if a storage problem occurs while storing a bean.

getPlansInOrg

List<io.apiman.manager.api.beans.summary.PlanSummaryBean> getPlansInOrg(String organizationId)
                                                                        throws StorageException

Returns summary info for all plans in the given organization.

Parameters:

organizationId - the organization id

Returns:

list of plans in org

Throws:

StorageException - if a storage problem occurs while storing a bean.

getPlanVersions

List<io.apiman.manager.api.beans.summary.PlanVersionSummaryBean> getPlanVersions(String organizationId,
                                                                               String planId)
                                                                                 throws StorageException

Returns all plan versions for a given plan.

Parameters:

organizationId - the organization id

planId - the plan id

Returns:

list of plan versions

Throws:

StorageException - if a storage problem occurs while storing a bean.

getPolicies

List<io.apiman.manager.api.beans.summary.PolicySummaryBean> getPolicies(String organizationId,
                                                                      String entityId,
                                                                      String version,
                                                                      io.apiman.manager.api.beans.policies.PolicyType type)
                                                                        throws StorageException

Returns all policies of the given type for the given entity/version. This could be any of Application, Plan, Service.

Parameters:

organizationId - the organization id

entityId - the entity id

version - the version

type - the type

Returns:

list of policies

Throws:

StorageException - if a storage problem occurs while storing a bean.

listPolicyDefinitions

List<io.apiman.manager.api.beans.summary.PolicyDefinitionSummaryBean> listPolicyDefinitions()
                                                                                            throws StorageException

Lists the policy definitions in the system.

Returns:

list of policy definitions

Throws:

StorageException - if a storage problem occurs while storing a bean.

getServiceContracts

List<io.apiman.manager.api.beans.summary.ContractSummaryBean> getServiceContracts(String organizationId,
                                                                                String serviceId,
                                                                                String version,
                                                                                int page,
                                                                                int pageSize)
                                                                                  throws StorageException

Gets a list of contracts for the given service. This is paged.

Parameters:

organizationId - the organization id

serviceId - the service id

version - the version

page - the page

pageSize - the paging size

Returns:

list of service contracts

Throws:

StorageException - if a storage problem occurs while storing a bean.

getMaxPolicyOrderIndex

int getMaxPolicyOrderIndex(String organizationId,
                         String entityId,
                         String entityVersion,
                         io.apiman.manager.api.beans.policies.PolicyType type)
                           throws StorageException

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

Parameters:

organizationId - the organization id

entityId - the entity id

entityVersion - the entity version

type - the type

Returns:

largest order index

Throws:

StorageException - if a storage problem occurs while storing a bean.

listPluginPolicyDefs

List<io.apiman.manager.api.beans.summary.PolicyDefinitionSummaryBean> listPluginPolicyDefs(Long pluginId)
                                                                                           throws StorageException

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

Parameters:

pluginId - the plugin id

Returns:

list of plugin policy defs

Throws:

StorageException - if a storage problem occurs while storing a bean.