| Package | Description |
|---|---|
| io.apiman.manager.api.rest.contract |
| Modifier and Type | Method and Description |
|---|---|
io.apiman.manager.api.beans.search.SearchResultsBean<io.apiman.manager.api.beans.audit.AuditEntryBean> |
IOrganizationResource.activity(String organizationId,
int page,
int pageSize)
Returns audit activity information for a single Organization.
|
io.apiman.manager.api.beans.gateways.GatewayBean |
IGatewayResource.create(io.apiman.manager.api.beans.gateways.NewGatewayBean bean)
This endpoint is called to create a new Gateway.
|
io.apiman.manager.api.beans.orgs.OrganizationBean |
IOrganizationResource.create(io.apiman.manager.api.beans.orgs.NewOrganizationBean bean)
Use this endpoint to create a new Organization.
|
io.apiman.manager.api.beans.plugins.PluginBean |
IPluginResource.create(io.apiman.manager.api.beans.plugins.NewPluginBean bean)
Use this endpoint to add a plugin to apiman.
|
io.apiman.manager.api.beans.idm.RoleBean |
IRoleResource.create(io.apiman.manager.api.beans.idm.NewRoleBean bean)
Use this endpoint to create a new apiman role.
|
io.apiman.manager.api.beans.policies.PolicyDefinitionBean |
IPolicyDefinitionResource.create(io.apiman.manager.api.beans.policies.PolicyDefinitionBean bean)
Use this endpoint to add a policy definition to apiman.
|
io.apiman.manager.api.beans.apps.ApplicationBean |
IOrganizationResource.createApp(String organizationId,
io.apiman.manager.api.beans.apps.NewApplicationBean bean)
Use this endpoint to create a new Application.
|
io.apiman.manager.api.beans.policies.PolicyBean |
IOrganizationResource.createAppPolicy(String organizationId,
String applicationId,
String version,
io.apiman.manager.api.beans.policies.NewPolicyBean bean)
Use this endpoint to add a new Policy to the Application version.
|
io.apiman.manager.api.beans.apps.ApplicationVersionBean |
IOrganizationResource.createAppVersion(String organizationId,
String applicationId,
io.apiman.manager.api.beans.apps.NewApplicationVersionBean bean)
Use this endpoint to create a new version of the Application.
|
io.apiman.manager.api.beans.contracts.ContractBean |
IOrganizationResource.createContract(String organizationId,
String applicationId,
String version,
io.apiman.manager.api.beans.contracts.NewContractBean bean)
Use this endpoint to create a Contract between the Application and a Service.
|
io.apiman.manager.api.beans.plans.PlanBean |
IOrganizationResource.createPlan(String organizationId,
io.apiman.manager.api.beans.plans.NewPlanBean bean)
Use this endpoint to create a new Plan.
|
io.apiman.manager.api.beans.policies.PolicyBean |
IOrganizationResource.createPlanPolicy(String organizationId,
String planId,
String version,
io.apiman.manager.api.beans.policies.NewPolicyBean bean)
Use this endpoint to add a new Policy to the Plan version.
|
io.apiman.manager.api.beans.plans.PlanVersionBean |
IOrganizationResource.createPlanVersion(String organizationId,
String planId,
io.apiman.manager.api.beans.plans.NewPlanVersionBean bean)
Use this endpoint to create a new version of the Plan.
|
io.apiman.manager.api.beans.services.ServiceBean |
IOrganizationResource.createService(String organizationId,
io.apiman.manager.api.beans.services.NewServiceBean bean)
Use this endpoint to create a new Service.
|
io.apiman.manager.api.beans.policies.PolicyBean |
IOrganizationResource.createServicePolicy(String organizationId,
String serviceId,
String version,
io.apiman.manager.api.beans.policies.NewPolicyBean bean)
Use this endpoint to add a new Policy to the Service version.
|
io.apiman.manager.api.beans.services.ServiceVersionBean |
IOrganizationResource.createServiceVersion(String organizationId,
String serviceId,
io.apiman.manager.api.beans.services.NewServiceVersionBean bean)
Use this endpoint to create a new version of the Service.
|
void |
IPluginResource.delete(Long pluginId)
Call this endpoint to delete a plugin.
|
void |
IRoleResource.delete(String roleId)
Use this endpoint to delete a role by its ID.
|
void |
IPolicyDefinitionResource.delete(String policyDefinitionId)
Use this endpoint to delete a policy definition by its ID.
|
void |
IGatewayResource.delete(String gatewayId)
This endpoint deletes a Gateway by its unique ID.
|
void |
IOrganizationResource.deleteAllContracts(String organizationId,
String applicationId,
String version)
Use this endpoint to break all contracts between this application and its services.
|
void |
IOrganizationResource.deleteAppPolicy(String organizationId,
String applicationId,
String version,
long policyId)
Use this endpoint to remove a Policy from the Application.
|
void |
IOrganizationResource.deleteContract(String organizationId,
String applicationId,
String version,
Long contractId)
Use this endpoint to break a Contract with a Service.
|
void |
IOrganizationResource.deletePlanPolicy(String organizationId,
String planId,
String version,
long policyId)
Use this endpoint to remove a Policy from the Plan.
|
void |
IOrganizationResource.deleteServiceDefinition(String organizationId,
String serviceId,
String version)
Use this endpoint to delete a Service's definition document.
|
void |
IOrganizationResource.deleteServicePolicy(String organizationId,
String serviceId,
String version,
long policyId)
Use this endpoint to remove a Policy from the Service.
|
io.apiman.manager.api.beans.plugins.PluginBean |
IPluginResource.get(Long pluginId)
This endpoint can be used to access the full information about an apiman
plugin.
|
io.apiman.manager.api.beans.idm.RoleBean |
IRoleResource.get(String roleId)
Use this endpoint to retrieve information about a single Role by its
ID.
|
io.apiman.manager.api.beans.policies.PolicyDefinitionBean |
IPolicyDefinitionResource.get(String policyDefinitionId)
Use this endpoint to get a single policy definition by its ID.
|
io.apiman.manager.api.beans.orgs.OrganizationBean |
IOrganizationResource.get(String organizationId)
Use this endpoint to get information about a single Organization
by its ID.
|
io.apiman.manager.api.beans.gateways.GatewayBean |
IGatewayResource.get(String gatewayId)
Call this endpoint to get the details of a single configured Gateway.
|
io.apiman.manager.api.beans.summary.ApiRegistryBean |
IOrganizationResource.getApiRegistryJSON(String organizationId,
String applicationId,
String version)
Use this endpoint to get registry style information about all Services that this
Application consumes.
|
io.apiman.manager.api.beans.summary.ApiRegistryBean |
IOrganizationResource.getApiRegistryXML(String organizationId,
String applicationId,
String version)
Use this endpoint to get registry style information about all Services that this
Application consumes.
|
io.apiman.manager.api.beans.apps.ApplicationBean |
IOrganizationResource.getApp(String organizationId,
String applicationId)
Use this endpoint to retrieve information about a single Application by ID.
|
io.apiman.manager.api.beans.search.SearchResultsBean<io.apiman.manager.api.beans.audit.AuditEntryBean> |
IOrganizationResource.getAppActivity(String organizationId,
String applicationId,
int page,
int pageSize)
This endpoint returns audit activity information about the Application.
|
List<io.apiman.manager.api.beans.summary.ContractSummaryBean> |
IOrganizationResource.getApplicationVersionContracts(String organizationId,
String applicationId,
String version)
Use this endpoint to get a list of all Contracts for an Application.
|
io.apiman.manager.api.beans.policies.PolicyBean |
IOrganizationResource.getAppPolicy(String organizationId,
String applicationId,
String version,
long policyId)
Use this endpoint to get information about a single Policy in the Application version.
|
io.apiman.manager.api.beans.apps.ApplicationVersionBean |
IOrganizationResource.getAppVersion(String organizationId,
String applicationId,
String version)
Use this endpoint to get detailed information about a single version of
an Application.
|
io.apiman.manager.api.beans.search.SearchResultsBean<io.apiman.manager.api.beans.audit.AuditEntryBean> |
IOrganizationResource.getAppVersionActivity(String organizationId,
String applicationId,
String version,
int page,
int pageSize)
Use this endpoint to get audit activity information for a single version of the
Application.
|
io.apiman.manager.api.beans.contracts.ContractBean |
IOrganizationResource.getContract(String organizationId,
String applicationId,
String version,
Long contractId)
Use this endpoint to retrieve detailed information about a single Service Contract
for an Application.
|
io.apiman.manager.api.beans.idm.UserPermissionsBean |
IPermissionsResource.getPermissionsForUser(String userId)
This endpoint returns all of the permissions assigned to a specific user.
|
io.apiman.manager.api.beans.plans.PlanBean |
IOrganizationResource.getPlan(String organizationId,
String planId)
Use this endpoint to retrieve information about a single Plan by ID.
|
io.apiman.manager.api.beans.search.SearchResultsBean<io.apiman.manager.api.beans.audit.AuditEntryBean> |
IOrganizationResource.getPlanActivity(String organizationId,
String planId,
int page,
int pageSize)
This endpoint returns audit activity information about the Plan.
|
io.apiman.manager.api.beans.policies.PolicyBean |
IOrganizationResource.getPlanPolicy(String organizationId,
String planId,
String version,
long policyId)
Use this endpoint to get information about a single Policy in the Plan version.
|
io.apiman.manager.api.beans.plans.PlanVersionBean |
IOrganizationResource.getPlanVersion(String organizationId,
String planId,
String version)
Use this endpoint to get detailed information about a single version of
a Plan.
|
io.apiman.manager.api.beans.search.SearchResultsBean<io.apiman.manager.api.beans.audit.AuditEntryBean> |
IOrganizationResource.getPlanVersionActivity(String organizationId,
String planId,
String version,
int page,
int pageSize)
Use this endpoint to get audit activity information for a single version of the
Plan.
|
io.apiman.manager.api.beans.services.ServiceBean |
IOrganizationResource.getService(String organizationId,
String serviceId)
Use this endpoint to retrieve information about a single Service by ID.
|
io.apiman.manager.api.beans.search.SearchResultsBean<io.apiman.manager.api.beans.audit.AuditEntryBean> |
IOrganizationResource.getServiceActivity(String organizationId,
String serviceId,
int page,
int pageSize)
This endpoint returns audit activity information about the Service.
|
javax.ws.rs.core.Response |
IOrganizationResource.getServiceDefinition(String organizationId,
String serviceId,
String version)
Use this endpoint to retrieve the Service's definition document.
|
io.apiman.manager.api.beans.policies.PolicyBean |
IOrganizationResource.getServicePolicy(String organizationId,
String serviceId,
String version,
long policyId)
Use this endpoint to get information about a single Policy in the Service version.
|
io.apiman.manager.api.beans.policies.PolicyChainBean |
IOrganizationResource.getServicePolicyChain(String organizationId,
String serviceId,
String version,
String planId)
Use this endpoint to get a Policy Chain for the specific Service version.
|
io.apiman.manager.api.beans.services.ServiceVersionBean |
IOrganizationResource.getServiceVersion(String organizationId,
String serviceId,
String version)
Use this endpoint to get detailed information about a single version of
a Service.
|
io.apiman.manager.api.beans.search.SearchResultsBean<io.apiman.manager.api.beans.audit.AuditEntryBean> |
IOrganizationResource.getServiceVersionActivity(String organizationId,
String serviceId,
String version,
int page,
int pageSize)
Use this endpoint to get audit activity information for a single version of the
Service.
|
List<io.apiman.manager.api.beans.summary.ContractSummaryBean> |
IOrganizationResource.getServiceVersionContracts(String organizationId,
String serviceId,
String version,
int page,
int pageSize)
Use this endpoint to get a list of all Contracts created with this Service.
|
List<io.apiman.manager.api.beans.summary.ServicePlanSummaryBean> |
IOrganizationResource.getServiceVersionPlans(String organizationId,
String serviceId,
String version)
Use this endpoint to list the Plans configured for the given Service version.
|
void |
IOrganizationResource.grant(String organizationId,
io.apiman.manager.api.beans.idm.GrantRolesBean bean)
Grant membership in a role to a user.
|
List<io.apiman.manager.api.beans.idm.RoleBean> |
IRoleResource.list()
This endpoint lists all of the roles currently defined in apiman.
|
List<io.apiman.manager.api.beans.summary.PolicyDefinitionSummaryBean> |
IPolicyDefinitionResource.list()
This endpoint returns a list of all policy definitions that have been added
to apiman.
|
List<io.apiman.manager.api.beans.summary.PluginSummaryBean> |
IPluginResource.list()
This endpoint returns a list of all plugins that have been added to the
system.
|
List<io.apiman.manager.api.beans.summary.GatewaySummaryBean> |
IGatewayResource.list()
This endpoint returns a list of all the Gateways that have been configured.
|
List<io.apiman.manager.api.beans.summary.PolicySummaryBean> |
IOrganizationResource.listAppPolicies(String organizationId,
String applicationId,
String version)
Use this endpoint to list all of the Policies configured for the Application.
|
List<io.apiman.manager.api.beans.summary.ApplicationSummaryBean> |
IOrganizationResource.listApps(String organizationId)
Use this endpoint to get a list of all Applications in the Organization.
|
List<io.apiman.manager.api.beans.summary.ApplicationVersionSummaryBean> |
IOrganizationResource.listAppVersions(String organizationId,
String applicationId)
Use this endpoint to list all of the versions of an Application.
|
List<io.apiman.manager.api.beans.members.MemberBean> |
IOrganizationResource.listMembers(String organizationId)
Lists all members of the organization.
|
List<io.apiman.manager.api.beans.summary.PolicySummaryBean> |
IOrganizationResource.listPlanPolicies(String organizationId,
String planId,
String version)
Use this endpoint to list all of the Policies configured for the Plan.
|
List<io.apiman.manager.api.beans.summary.PlanSummaryBean> |
IOrganizationResource.listPlans(String organizationId)
Use this endpoint to get a list of all Plans in the Organization.
|
List<io.apiman.manager.api.beans.summary.PlanVersionSummaryBean> |
IOrganizationResource.listPlanVersions(String organizationId,
String planId)
Use this endpoint to list all of the versions of a Plan.
|
List<io.apiman.manager.api.beans.summary.PolicySummaryBean> |
IOrganizationResource.listServicePolicies(String organizationId,
String serviceId,
String version)
Use this endpoint to list all of the Policies configured for the Service.
|
List<io.apiman.manager.api.beans.summary.ServiceSummaryBean> |
IOrganizationResource.listServices(String organizationId)
Use this endpoint to get a list of all Services in the Organization.
|
List<io.apiman.manager.api.beans.summary.ServiceVersionSummaryBean> |
IOrganizationResource.listServiceVersions(String organizationId,
String serviceId)
Use this endpoint to list all of the versions of a Service.
|
void |
IOrganizationResource.reorderApplicationPolicies(String organizationId,
String applicationId,
String version,
io.apiman.manager.api.beans.policies.PolicyChainBean policyChain)
Use this endpoint to change the order of Policies for an Application.
|
void |
IOrganizationResource.reorderPlanPolicies(String organizationId,
String planId,
String version,
io.apiman.manager.api.beans.policies.PolicyChainBean policyChain)
Use this endpoint to change the order of Policies for a Plan.
|
void |
IOrganizationResource.reorderServicePolicies(String organizationId,
String serviceId,
String version,
io.apiman.manager.api.beans.policies.PolicyChainBean policyChain)
Use this endpoint to change the order of Policies for a Service.
|
void |
IOrganizationResource.revoke(String organizationId,
String roleId,
String userId)
Revoke membership in a role.
|
void |
IOrganizationResource.revokeAll(String organizationId,
String userId)
Revoke all of a user's role memberships from the org.
|
io.apiman.manager.api.beans.search.SearchResultsBean<io.apiman.manager.api.beans.idm.RoleBean> |
IRoleResource.search(io.apiman.manager.api.beans.search.SearchCriteriaBean criteria)
This endpoint provides a way to search for roles.
|
io.apiman.manager.api.beans.summary.GatewayTestResultBean |
IGatewayResource.test(io.apiman.manager.api.beans.gateways.NewGatewayBean bean)
This endpoint is used to test the Gateway's settings prior to either creating
or updating it.
|
void |
IGatewayResource.update(String gatewayId,
io.apiman.manager.api.beans.gateways.UpdateGatewayBean bean)
Use this endpoint to update an existing Gateway.
|
void |
IOrganizationResource.update(String organizationId,
io.apiman.manager.api.beans.orgs.UpdateOrganizationBean bean)
Updates meta-information about a single Organization.
|
void |
IPolicyDefinitionResource.update(String policyDefinitionId,
io.apiman.manager.api.beans.policies.UpdatePolicyDefinitionBean bean)
Update the meta information about a policy definition.
|
void |
IRoleResource.update(String roleId,
io.apiman.manager.api.beans.idm.UpdateRoleBean bean)
Use this endpoint to update the information about an existing role.
|
void |
IUserResource.update(String userId,
io.apiman.manager.api.beans.idm.UpdateUserBean user)
Use this endpoint to update the information about a user.
|
void |
IOrganizationResource.updateApp(String organizationId,
String applicationId,
io.apiman.manager.api.beans.apps.UpdateApplicationBean bean)
Use this endpoint to update information about an Application.
|
void |
IOrganizationResource.updateAppPolicy(String organizationId,
String applicationId,
String version,
long policyId,
io.apiman.manager.api.beans.policies.UpdatePolicyBean bean)
Use this endpoint to update the meta-data or configuration of a single Application Policy.
|
void |
IOrganizationResource.updatePlan(String organizationId,
String planId,
io.apiman.manager.api.beans.plans.UpdatePlanBean bean)
Use this endpoint to update information about a Plan.
|
void |
IOrganizationResource.updatePlanPolicy(String organizationId,
String planId,
String version,
long policyId,
io.apiman.manager.api.beans.policies.UpdatePolicyBean bean)
Use this endpoint to update the meta-data or configuration of a single Plan Policy.
|
void |
IOrganizationResource.updateService(String organizationId,
String serviceId,
io.apiman.manager.api.beans.services.UpdateServiceBean bean)
Use this endpoint to update information about a Service.
|
void |
IOrganizationResource.updateServiceDefinition(String organizationId,
String serviceId,
String version)
Use this endpoint to update the Service's definition document.
|
void |
IOrganizationResource.updateServicePolicy(String organizationId,
String serviceId,
String version,
long policyId,
io.apiman.manager.api.beans.policies.UpdatePolicyBean bean)
Use this endpoint to update the meta-data or configuration of a single Service Policy.
|
io.apiman.manager.api.beans.services.ServiceVersionBean |
IOrganizationResource.updateServiceVersion(String organizationId,
String serviceId,
String version,
io.apiman.manager.api.beans.services.UpdateServiceVersionBean bean)
Use this endpoint to update information about a single version of a Service.
|
Copyright © 2015 JBoss, a division of Red Hat. All rights reserved.