io.apiman.manager.api.core

Interface IStorage

public interface IStorage

Represents the persistent storage interface for Apiman DT.

Author:

eric.wittmann@redhat.com

Method Summary

Modifier and Type	Method and Description
void	beginTx()
void	commitTx()
void	createApplication(io.apiman.manager.api.beans.apps.ApplicationBean application)
void	createApplicationVersion(io.apiman.manager.api.beans.apps.ApplicationVersionBean version)
void	createAuditEntry(io.apiman.manager.api.beans.audit.AuditEntryBean entry)
void	createContract(io.apiman.manager.api.beans.contracts.ContractBean contract)
void	createDownload(io.apiman.manager.api.beans.download.DownloadBean download)
void	createGateway(io.apiman.manager.api.beans.gateways.GatewayBean gateway)
void	createMembership(io.apiman.manager.api.beans.idm.RoleMembershipBean membership)
void	createOrganization(io.apiman.manager.api.beans.orgs.OrganizationBean organization)
void	createPlan(io.apiman.manager.api.beans.plans.PlanBean plan)
void	createPlanVersion(io.apiman.manager.api.beans.plans.PlanVersionBean version)
void	createPlugin(io.apiman.manager.api.beans.plugins.PluginBean plugin)
void	createPolicy(io.apiman.manager.api.beans.policies.PolicyBean policy)
void	createPolicyDefinition(io.apiman.manager.api.beans.policies.PolicyDefinitionBean policyDef)
void	createRole(io.apiman.manager.api.beans.idm.RoleBean role)
void	createService(io.apiman.manager.api.beans.services.ServiceBean service)
void	createServiceVersion(io.apiman.manager.api.beans.services.ServiceVersionBean version)
void	createUser(io.apiman.manager.api.beans.idm.UserBean user)
void	deleteApplication(io.apiman.manager.api.beans.apps.ApplicationBean application)
void	deleteApplicationVersion(io.apiman.manager.api.beans.apps.ApplicationVersionBean version)
void	deleteContract(io.apiman.manager.api.beans.contracts.ContractBean contract)
void	deleteDownload(io.apiman.manager.api.beans.download.DownloadBean download)
void	deleteGateway(io.apiman.manager.api.beans.gateways.GatewayBean gateway)
void	deleteMembership(String userId, String roleId, String organizationId)
void	deleteMemberships(String userId, String organizationId)
void	deleteOrganization(io.apiman.manager.api.beans.orgs.OrganizationBean organization)
void	deletePlan(io.apiman.manager.api.beans.plans.PlanBean plan)
void	deletePlanVersion(io.apiman.manager.api.beans.plans.PlanVersionBean version)
void	deletePlugin(io.apiman.manager.api.beans.plugins.PluginBean plugin)
void	deletePolicy(io.apiman.manager.api.beans.policies.PolicyBean policy)
void	deletePolicyDefinition(io.apiman.manager.api.beans.policies.PolicyDefinitionBean policyDef)
void	deleteRole(io.apiman.manager.api.beans.idm.RoleBean role)
void	deleteService(io.apiman.manager.api.beans.services.ServiceBean service)
void	deleteServiceDefinition(io.apiman.manager.api.beans.services.ServiceVersionBean version)
void	deleteServiceVersion(io.apiman.manager.api.beans.services.ServiceVersionBean version)
Iterator<io.apiman.manager.api.beans.apps.ApplicationBean>	getAllApplications(String organizationId)
Iterator<io.apiman.manager.api.beans.apps.ApplicationVersionBean>	getAllApplicationVersions(String organizationId, String applicationId)
Iterator<io.apiman.manager.api.beans.audit.AuditEntryBean>	getAllAuditEntries(String organizationId)
Iterator<io.apiman.manager.api.beans.contracts.ContractBean>	getAllContracts(String organizationId, String applicationId, String version)
Iterator<io.apiman.manager.api.beans.gateways.GatewayBean>	getAllGateways()
Iterator<io.apiman.manager.api.beans.idm.RoleMembershipBean>	getAllMemberships(String organizationId)
Iterator<io.apiman.manager.api.beans.orgs.OrganizationBean>	getAllOrganizations()
Iterator<io.apiman.manager.api.beans.plans.PlanBean>	getAllPlans(String organizationId)
Iterator<io.apiman.manager.api.beans.plans.PlanVersionBean>	getAllPlanVersions(String organizationId, String planId)
Iterator<io.apiman.manager.api.beans.plugins.PluginBean>	getAllPlugins()
Iterator<io.apiman.manager.api.beans.policies.PolicyBean>	getAllPolicies(String organizationId, String entityId, String version, io.apiman.manager.api.beans.policies.PolicyType type)
Iterator<io.apiman.manager.api.beans.policies.PolicyDefinitionBean>	getAllPolicyDefinitions()
Iterator<io.apiman.manager.api.beans.idm.RoleBean>	getAllRoles()
Iterator<io.apiman.manager.api.beans.services.ServiceBean>	getAllServices(String organizationId)
Iterator<io.apiman.manager.api.beans.services.ServiceVersionBean>	getAllServiceVersions(String organizationId, String serviceId)
Iterator<io.apiman.manager.api.beans.idm.UserBean>	getAllUsers()
io.apiman.manager.api.beans.apps.ApplicationBean	getApplication(String organizationId, String id)
io.apiman.manager.api.beans.apps.ApplicationVersionBean	getApplicationVersion(String organizationId, String applicationId, String version)
io.apiman.manager.api.beans.contracts.ContractBean	getContract(Long id)
io.apiman.manager.api.beans.download.DownloadBean	getDownload(String id)
io.apiman.manager.api.beans.gateways.GatewayBean	getGateway(String id)
io.apiman.manager.api.beans.idm.RoleMembershipBean	getMembership(String userId, String roleId, String organizationId)
io.apiman.manager.api.beans.orgs.OrganizationBean	getOrganization(String id)
io.apiman.manager.api.beans.plans.PlanBean	getPlan(String organizationId, String id)
io.apiman.manager.api.beans.plans.PlanVersionBean	getPlanVersion(String organizationId, String planId, String version)
io.apiman.manager.api.beans.plugins.PluginBean	getPlugin(long id)
io.apiman.manager.api.beans.plugins.PluginBean	getPlugin(String groupId, String artifactId)
io.apiman.manager.api.beans.policies.PolicyBean	getPolicy(io.apiman.manager.api.beans.policies.PolicyType type, String organizationId, String entityId, String version, Long id)
io.apiman.manager.api.beans.policies.PolicyDefinitionBean	getPolicyDefinition(String id)
io.apiman.manager.api.beans.idm.RoleBean	getRole(String roleId)
io.apiman.manager.api.beans.services.ServiceBean	getService(String organizationId, String id)
InputStream	getServiceDefinition(io.apiman.manager.api.beans.services.ServiceVersionBean serviceVersion)
io.apiman.manager.api.beans.services.ServiceVersionBean	getServiceVersion(String organizationId, String serviceId, String version)
io.apiman.manager.api.beans.idm.UserBean	getUser(String userId)
void	reorderPolicies(io.apiman.manager.api.beans.policies.PolicyType type, String organizationId, String entityId, String entityVersion, List<Long> newOrder)
void	rollbackTx()
void	updateApplication(io.apiman.manager.api.beans.apps.ApplicationBean application)
void	updateApplicationVersion(io.apiman.manager.api.beans.apps.ApplicationVersionBean version)
void	updateGateway(io.apiman.manager.api.beans.gateways.GatewayBean gateway)
void	updateOrganization(io.apiman.manager.api.beans.orgs.OrganizationBean organization)
void	updatePlan(io.apiman.manager.api.beans.plans.PlanBean plan)
void	updatePlanVersion(io.apiman.manager.api.beans.plans.PlanVersionBean version)
void	updatePlugin(io.apiman.manager.api.beans.plugins.PluginBean pluginBean)
void	updatePolicy(io.apiman.manager.api.beans.policies.PolicyBean policy)
void	updatePolicyDefinition(io.apiman.manager.api.beans.policies.PolicyDefinitionBean policyDef)
void	updateRole(io.apiman.manager.api.beans.idm.RoleBean role)
void	updateService(io.apiman.manager.api.beans.services.ServiceBean service)
void	updateServiceDefinition(io.apiman.manager.api.beans.services.ServiceVersionBean version, InputStream definitionStream)
void	updateServiceVersion(io.apiman.manager.api.beans.services.ServiceVersionBean version)
void	updateUser(io.apiman.manager.api.beans.idm.UserBean user)

Method Detail

beginTx

void beginTx()
      throws StorageException

Throws:

StorageException

commitTx

void commitTx()
       throws StorageException

Throws:

StorageException

rollbackTx

void rollbackTx()

createOrganization

void createOrganization(io.apiman.manager.api.beans.orgs.OrganizationBean organization)
                 throws StorageException

Throws:

StorageException

createApplication

void createApplication(io.apiman.manager.api.beans.apps.ApplicationBean application)
                throws StorageException

Throws:

StorageException

createApplicationVersion

void createApplicationVersion(io.apiman.manager.api.beans.apps.ApplicationVersionBean version)
                       throws StorageException

Throws:

StorageException

createContract

void createContract(io.apiman.manager.api.beans.contracts.ContractBean contract)
             throws StorageException

Throws:

StorageException

createService

void createService(io.apiman.manager.api.beans.services.ServiceBean service)
            throws StorageException

Throws:

StorageException

createServiceVersion

void createServiceVersion(io.apiman.manager.api.beans.services.ServiceVersionBean version)
                   throws StorageException

Throws:

StorageException

createPlan

void createPlan(io.apiman.manager.api.beans.plans.PlanBean plan)
         throws StorageException

Throws:

StorageException

createPlanVersion

void createPlanVersion(io.apiman.manager.api.beans.plans.PlanVersionBean version)
                throws StorageException

Throws:

StorageException

createPolicy

void createPolicy(io.apiman.manager.api.beans.policies.PolicyBean policy)
           throws StorageException

Throws:

StorageException

createGateway

void createGateway(io.apiman.manager.api.beans.gateways.GatewayBean gateway)
            throws StorageException

Throws:

StorageException

createPlugin

void createPlugin(io.apiman.manager.api.beans.plugins.PluginBean plugin)
           throws StorageException

Throws:

StorageException

createPolicyDefinition

void createPolicyDefinition(io.apiman.manager.api.beans.policies.PolicyDefinitionBean policyDef)
                     throws StorageException

Throws:

StorageException

createAuditEntry

void createAuditEntry(io.apiman.manager.api.beans.audit.AuditEntryBean entry)
               throws StorageException

Throws:

StorageException

createDownload

void createDownload(io.apiman.manager.api.beans.download.DownloadBean download)
             throws StorageException

Throws:

StorageException

updateOrganization

void updateOrganization(io.apiman.manager.api.beans.orgs.OrganizationBean organization)
                 throws StorageException

Throws:

StorageException

updateApplication

void updateApplication(io.apiman.manager.api.beans.apps.ApplicationBean application)
                throws StorageException

Throws:

StorageException

updateApplicationVersion

void updateApplicationVersion(io.apiman.manager.api.beans.apps.ApplicationVersionBean version)
                       throws StorageException

Throws:

StorageException

updateService

void updateService(io.apiman.manager.api.beans.services.ServiceBean service)
            throws StorageException

Throws:

StorageException

updateServiceVersion

void updateServiceVersion(io.apiman.manager.api.beans.services.ServiceVersionBean version)
                   throws StorageException

Throws:

StorageException

updateServiceDefinition

void updateServiceDefinition(io.apiman.manager.api.beans.services.ServiceVersionBean version,
                             InputStream definitionStream)
                      throws StorageException

Throws:

StorageException

updatePlan

void updatePlan(io.apiman.manager.api.beans.plans.PlanBean plan)
         throws StorageException

Throws:

StorageException

updatePlanVersion

void updatePlanVersion(io.apiman.manager.api.beans.plans.PlanVersionBean version)
                throws StorageException

Throws:

StorageException

updatePolicy

void updatePolicy(io.apiman.manager.api.beans.policies.PolicyBean policy)
           throws StorageException

Throws:

StorageException

updateGateway

void updateGateway(io.apiman.manager.api.beans.gateways.GatewayBean gateway)
            throws StorageException

Throws:

StorageException

updatePolicyDefinition

void updatePolicyDefinition(io.apiman.manager.api.beans.policies.PolicyDefinitionBean policyDef)
                     throws StorageException

Throws:

StorageException

updatePlugin

void updatePlugin(io.apiman.manager.api.beans.plugins.PluginBean pluginBean)
           throws StorageException

Throws:

StorageException

deleteOrganization

void deleteOrganization(io.apiman.manager.api.beans.orgs.OrganizationBean organization)
                 throws StorageException

Throws:

StorageException

deleteApplication

void deleteApplication(io.apiman.manager.api.beans.apps.ApplicationBean application)
                throws StorageException

Throws:

StorageException

deleteApplicationVersion

void deleteApplicationVersion(io.apiman.manager.api.beans.apps.ApplicationVersionBean version)
                       throws StorageException

Throws:

StorageException

deleteContract

void deleteContract(io.apiman.manager.api.beans.contracts.ContractBean contract)
             throws StorageException

Throws:

StorageException

deleteService

void deleteService(io.apiman.manager.api.beans.services.ServiceBean service)
            throws StorageException

Throws:

StorageException

deleteServiceVersion

void deleteServiceVersion(io.apiman.manager.api.beans.services.ServiceVersionBean version)
                   throws StorageException

Throws:

StorageException

deleteServiceDefinition

void deleteServiceDefinition(io.apiman.manager.api.beans.services.ServiceVersionBean version)
                      throws StorageException

Throws:

StorageException

deletePlan

void deletePlan(io.apiman.manager.api.beans.plans.PlanBean plan)
         throws StorageException

Throws:

StorageException

deletePlanVersion

void deletePlanVersion(io.apiman.manager.api.beans.plans.PlanVersionBean version)
                throws StorageException

Throws:

StorageException

deletePolicy

void deletePolicy(io.apiman.manager.api.beans.policies.PolicyBean policy)
           throws StorageException

Throws:

StorageException

deleteGateway

void deleteGateway(io.apiman.manager.api.beans.gateways.GatewayBean gateway)
            throws StorageException

Throws:

StorageException

deletePlugin

void deletePlugin(io.apiman.manager.api.beans.plugins.PluginBean plugin)
           throws StorageException

Throws:

StorageException

deletePolicyDefinition

void deletePolicyDefinition(io.apiman.manager.api.beans.policies.PolicyDefinitionBean policyDef)
                     throws StorageException

Throws:

StorageException

deleteDownload

void deleteDownload(io.apiman.manager.api.beans.download.DownloadBean download)
             throws StorageException

Throws:

StorageException

getOrganization

io.apiman.manager.api.beans.orgs.OrganizationBean getOrganization(String id)
                                                           throws StorageException

Throws:

StorageException

getApplication

io.apiman.manager.api.beans.apps.ApplicationBean getApplication(String organizationId,
                                                                String id)
                                                         throws StorageException

Throws:

StorageException

getApplicationVersion

io.apiman.manager.api.beans.apps.ApplicationVersionBean getApplicationVersion(String organizationId,
                                                                              String applicationId,
                                                                              String version)
                                                                       throws StorageException

Throws:

StorageException

getContract

io.apiman.manager.api.beans.contracts.ContractBean getContract(Long id)
                                                        throws StorageException

Throws:

StorageException

getService

io.apiman.manager.api.beans.services.ServiceBean getService(String organizationId,
                                                            String id)
                                                     throws StorageException

Throws:

StorageException

getServiceVersion

io.apiman.manager.api.beans.services.ServiceVersionBean getServiceVersion(String organizationId,
                                                                          String serviceId,
                                                                          String version)
                                                                   throws StorageException

Throws:

StorageException

getServiceDefinition

InputStream getServiceDefinition(io.apiman.manager.api.beans.services.ServiceVersionBean serviceVersion)
                          throws StorageException

Throws:

StorageException

getPlan

io.apiman.manager.api.beans.plans.PlanBean getPlan(String organizationId,
                                                   String id)
                                            throws StorageException

Throws:

StorageException

getPlanVersion

io.apiman.manager.api.beans.plans.PlanVersionBean getPlanVersion(String organizationId,
                                                                 String planId,
                                                                 String version)
                                                          throws StorageException

Throws:

StorageException

getPolicy

io.apiman.manager.api.beans.policies.PolicyBean getPolicy(io.apiman.manager.api.beans.policies.PolicyType type,
                                                          String organizationId,
                                                          String entityId,
                                                          String version,
                                                          Long id)
                                                   throws StorageException

Throws:

StorageException

getGateway

io.apiman.manager.api.beans.gateways.GatewayBean getGateway(String id)
                                                     throws StorageException

Throws:

StorageException

getPlugin

io.apiman.manager.api.beans.plugins.PluginBean getPlugin(long id)
                                                  throws StorageException

Throws:

StorageException

getPlugin

io.apiman.manager.api.beans.plugins.PluginBean getPlugin(String groupId,
                                                         String artifactId)
                                                  throws StorageException

Throws:

StorageException

getPolicyDefinition

io.apiman.manager.api.beans.policies.PolicyDefinitionBean getPolicyDefinition(String id)
                                                                       throws StorageException

Throws:

StorageException

getDownload

io.apiman.manager.api.beans.download.DownloadBean getDownload(String id)
                                                       throws StorageException

Throws:

StorageException

reorderPolicies

void reorderPolicies(io.apiman.manager.api.beans.policies.PolicyType type,
                     String organizationId,
                     String entityId,
                     String entityVersion,
                     List<Long> newOrder)
              throws StorageException

Throws:

StorageException

createUser

void createUser(io.apiman.manager.api.beans.idm.UserBean user)
         throws StorageException

Throws:

StorageException

getUser

io.apiman.manager.api.beans.idm.UserBean getUser(String userId)
                                          throws StorageException

Throws:

StorageException

updateUser

void updateUser(io.apiman.manager.api.beans.idm.UserBean user)
         throws StorageException

Throws:

StorageException

createRole

void createRole(io.apiman.manager.api.beans.idm.RoleBean role)
         throws StorageException

Throws:

StorageException

getRole

io.apiman.manager.api.beans.idm.RoleBean getRole(String roleId)
                                          throws StorageException

Throws:

StorageException

updateRole

void updateRole(io.apiman.manager.api.beans.idm.RoleBean role)
         throws StorageException

Throws:

StorageException

deleteRole

void deleteRole(io.apiman.manager.api.beans.idm.RoleBean role)
         throws StorageException

Throws:

StorageException

createMembership

void createMembership(io.apiman.manager.api.beans.idm.RoleMembershipBean membership)
               throws StorageException

Throws:

StorageException

getMembership

io.apiman.manager.api.beans.idm.RoleMembershipBean getMembership(String userId,
                                                                 String roleId,
                                                                 String organizationId)
                                                          throws StorageException

Throws:

StorageException

deleteMembership

void deleteMembership(String userId,
                      String roleId,
                      String organizationId)
               throws StorageException

Throws:

StorageException

deleteMemberships

void deleteMemberships(String userId,
                       String organizationId)
                throws StorageException

Throws:

StorageException

getAllGateways

Iterator<io.apiman.manager.api.beans.gateways.GatewayBean> getAllGateways()
                                                                   throws StorageException

Throws:

StorageException

getAllPlugins

Iterator<io.apiman.manager.api.beans.plugins.PluginBean> getAllPlugins()
                                                                throws StorageException

Throws:

StorageException

getAllPolicyDefinitions

Iterator<io.apiman.manager.api.beans.policies.PolicyDefinitionBean> getAllPolicyDefinitions()
                                                                                     throws StorageException

Throws:

StorageException

getAllOrganizations

Iterator<io.apiman.manager.api.beans.orgs.OrganizationBean> getAllOrganizations()
                                                                         throws StorageException

Throws:

StorageException

getAllMemberships

Iterator<io.apiman.manager.api.beans.idm.RoleMembershipBean> getAllMemberships(String organizationId)
                                                                        throws StorageException

Throws:

StorageException

getAllPlans

Iterator<io.apiman.manager.api.beans.plans.PlanBean> getAllPlans(String organizationId)
                                                          throws StorageException

Throws:

StorageException

getAllPlanVersions

Iterator<io.apiman.manager.api.beans.plans.PlanVersionBean> getAllPlanVersions(String organizationId,
                                                                               String planId)
                                                                        throws StorageException

Throws:

StorageException

getAllServices

Iterator<io.apiman.manager.api.beans.services.ServiceBean> getAllServices(String organizationId)
                                                                   throws StorageException

Throws:

StorageException

getAllServiceVersions

Iterator<io.apiman.manager.api.beans.services.ServiceVersionBean> getAllServiceVersions(String organizationId,
                                                                                        String serviceId)
                                                                                 throws StorageException

Throws:

StorageException

getAllApplications

Iterator<io.apiman.manager.api.beans.apps.ApplicationBean> getAllApplications(String organizationId)
                                                                       throws StorageException

Throws:

StorageException

getAllApplicationVersions

Iterator<io.apiman.manager.api.beans.apps.ApplicationVersionBean> getAllApplicationVersions(String organizationId,
                                                                                            String applicationId)
                                                                                     throws StorageException

Throws:

StorageException

getAllContracts

Iterator<io.apiman.manager.api.beans.contracts.ContractBean> getAllContracts(String organizationId,
                                                                             String applicationId,
                                                                             String version)
                                                                      throws StorageException

Throws:

StorageException

getAllAuditEntries

Iterator<io.apiman.manager.api.beans.audit.AuditEntryBean> getAllAuditEntries(String organizationId)
                                                                       throws StorageException

Throws:

StorageException

getAllPolicies

Iterator<io.apiman.manager.api.beans.policies.PolicyBean> getAllPolicies(String organizationId,
                                                                         String entityId,
                                                                         String version,
                                                                         io.apiman.manager.api.beans.policies.PolicyType type)
                                                                  throws StorageException

Throws:

StorageException

getAllUsers

Iterator<io.apiman.manager.api.beans.idm.UserBean> getAllUsers()
                                                        throws StorageException

Throws:

StorageException

getAllRoles

Iterator<io.apiman.manager.api.beans.idm.RoleBean> getAllRoles()
                                                        throws StorageException

Throws:

StorageException