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 orgId) Returns summary info for all applications in the given organization.
List<io.apiman.manager.api.beans.summary.ApplicationSummaryBean>	getApplicationsInOrgs(Set<String> orgIds) 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> orgIds) Returns summary info for all organizations in the given set.
List<io.apiman.manager.api.beans.summary.PlanSummaryBean>	getPlansInOrg(String orgId) Returns summary info for all plans in the given organization.
List<io.apiman.manager.api.beans.summary.PlanSummaryBean>	getPlansInOrgs(Set<String> orgIds) 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 orgId) Returns summary info for all services in the given organization.
List<io.apiman.manager.api.beans.summary.ServiceSummaryBean>	getServicesInOrgs(Set<String> orgIds) 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 orgId, 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>	listPolicyDefinitions() Lists the policy definitions in the system.

Method Detail

listGateways

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

Lists all of the Gateways.

Throws:

StorageException

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 -

Throws:

StorageException

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 -

Throws:

StorageException

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 -

Throws:

StorageException

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 -

criteria -

Throws:

StorageException

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 -

entityId -

entityVersion -

type -

paging -

Throws:

StorageException

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 -

paging -

Throws:

StorageException

getOrgs

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

Returns summary info for all organizations in the given set.

Parameters:

orgIds -

Throws:

StorageException

getApplicationsInOrgs

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

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

Parameters:

orgIds -

Throws:

StorageException

getApplicationsInOrg

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

Returns summary info for all applications in the given organization.

Parameters:

orgId -

Throws:

StorageException

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 -

applicationId -

Throws:

StorageException

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 -

applicationId -

version -

Throws:

StorageException

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 -

applicationId -

version -

Throws:

StorageException

getServicesInOrgs

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

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

Parameters:

orgIds -

Throws:

StorageException

getServicesInOrg

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

Returns summary info for all services in the given organization.

Parameters:

orgId -

Throws:

StorageException

getServiceVersions

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

Returns all service versions for a given service.

Parameters:

orgId -

serviceId -

Throws:

StorageException

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 -

serviceId -

version -

Throws:

StorageException

getPlansInOrgs

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

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

Parameters:

orgIds -

Throws:

StorageException

getPlansInOrg

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

Returns summary info for all plans in the given organization.

Parameters:

orgId -

Throws:

StorageException

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 -

planId -

Throws:

StorageException

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 -

entityId -

version -

type -

Throws:

StorageException

listPolicyDefinitions

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

Lists the policy definitions in the system.

Throws:

StorageException

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 -

serviceId -

version -

page -

pageSize -

Throws:

StorageException

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 -

entityId -

entityVersion -

type -

Throws:

StorageException