io.apiman.manager.api.rest.contract

Interface IGatewayResource

@Path(value="gateways")
public interface IGatewayResource

The Gateway API.

Author:

eric.wittmann@redhat.com

Method Summary

Methods

Modifier and Type	Method and Description
io.apiman.manager.api.beans.gateways.GatewayBean	create(io.apiman.manager.api.beans.gateways.NewGatewayBean bean) This endpoint is called to create a new Gateway.
void	delete(String gatewayId) This endpoint deletes a Gateway by its unique ID.
io.apiman.manager.api.beans.gateways.GatewayBean	get(String gatewayId) Call this endpoint to get the details of a single configured Gateway.
List<io.apiman.manager.api.beans.summary.GatewaySummaryBean>	list() This endpoint returns a list of all the Gateways that have been configured.
io.apiman.manager.api.beans.summary.GatewayTestResultBean	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	update(String gatewayId, io.apiman.manager.api.beans.gateways.UpdateGatewayBean bean) Use this endpoint to update an existing Gateway.

Method Detail

test

@PUT
@Produces(value="application/json")
@Consumes(value="application/json")
io.apiman.manager.api.beans.summary.GatewayTestResultBean test(io.apiman.manager.api.beans.gateways.NewGatewayBean bean)
                                                               throws NotAuthorizedException

This endpoint is used to test the Gateway's settings prior to either creating or updating it. The information will be used to attempt to create a link between the API Manager and the Gateway, by simply trying to ping the Gateway's "status" endpoint.

Parameters:

bean - Details of the Gateway for testing.

Returns:

The result of testing the Gateway settings.

Throws:

NotAuthorizedException - when attempt to do something user is not authorized to do

list

@GET
@Produces(value="application/json")
List<io.apiman.manager.api.beans.summary.GatewaySummaryBean> list()
                                                                  throws NotAuthorizedException

This endpoint returns a list of all the Gateways that have been configured.

Returns:

A list of configured Gateways.

Throws:

NotAuthorizedException - when attempt to do something user is not authorized to do

create

@POST
@Consumes(value="application/json")
@Produces(value="application/json")
io.apiman.manager.api.beans.gateways.GatewayBean create(io.apiman.manager.api.beans.gateways.NewGatewayBean bean)
                                                        throws GatewayAlreadyExistsException,
                                                               NotAuthorizedException

This endpoint is called to create a new Gateway.

Parameters:

bean - The details of the new Gateway.

Returns:

The newly created Gateway.

Throws:

GatewayAlreadyExistsException - when the gateway already exists

NotAuthorizedException - when attempt to do something user is not authorized to do

get

@GET
@Path(value="{gatewayId}")
@Produces(value="application/json")
io.apiman.manager.api.beans.gateways.GatewayBean get(@PathParam(value="gatewayId")
                                                                     String gatewayId)
                                                     throws GatewayNotFoundException,
                                                            NotAuthorizedException

Call this endpoint to get the details of a single configured Gateway.

Parameters:

gatewayId - The ID of the Gateway to get.

Returns:

The Gateway identified by {gatewayId}

Throws:

GatewayNotFoundException - when gateway is not found

NotAuthorizedException - when attempt to do something user is not authorized to do

update

@PUT
@Path(value="{gatewayId}")
@Consumes(value="application/json")
void update(@PathParam(value="gatewayId")
                            String gatewayId,
                            io.apiman.manager.api.beans.gateways.UpdateGatewayBean bean)
            throws GatewayNotFoundException,
                   NotAuthorizedException

Use this endpoint to update an existing Gateway. Note that the name of the Gateway cannot be changed, as the name is tied closely with the Gateway's ID. If you wish to rename the Gateway you must delete it and create a new one.

Parameters:

gatewayId - The ID of the Gateway to update.

bean - The Gateway information to update. All fields are optional.

Throws:

GatewayNotFoundException - when gateway is not found

NotAuthorizedException - when attempt to do something user is not authorized to do

delete

@DELETE
@Path(value="{gatewayId}")
void delete(@PathParam(value="gatewayId")
                      String gatewayId)
            throws GatewayNotFoundException,
                   NotAuthorizedException

This endpoint deletes a Gateway by its unique ID.

Parameters:

gatewayId - The ID of the Gateway to delete.

Throws:

GatewayNotFoundException - when gateway is not found

NotAuthorizedException - when attempt to do something user is not authorized to do