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.GatewayBean bean)
void	delete(String gatewayId)
io.apiman.manager.api.beans.gateways.GatewayBean	get(String gatewayId)
List<io.apiman.manager.api.beans.summary.GatewaySummaryBean>	list()
void	update(String gatewayId, io.apiman.manager.api.beans.gateways.GatewayBean bean)

Method Detail

list

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

Throws:

NotAuthorizedException

create

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

Throws:

GatewayAlreadyExistsException

NotAuthorizedException

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

Throws:

GatewayNotFoundException

NotAuthorizedException

update

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

Throws:

GatewayNotFoundException

NotAuthorizedException

delete

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

Throws:

GatewayNotFoundException

NotAuthorizedException