io.apiman.gateway.api.rest.contract

Interface IServiceResource

@Path(value="services")
public interface IServiceResource

The Service API.

Author:

eric.wittmann@redhat.com

Method Summary

Methods

Modifier and Type	Method and Description
io.apiman.gateway.engine.beans.ServiceEndpoint	getServiceEndpoint(String organizationId, String serviceId, String version)
void	publish(io.apiman.gateway.engine.beans.Service service)
void	retire(String organizationId, String serviceId, String version)

Method Detail

publish

@PUT
@Consumes(value="application/json")
void publish(io.apiman.gateway.engine.beans.Service service)
             throws io.apiman.gateway.engine.beans.exceptions.PublishingException,
                    NotAuthorizedException

Throws:

io.apiman.gateway.engine.beans.exceptions.PublishingException

NotAuthorizedException

retire

@DELETE
@Path(value="{organizationId}/{serviceId}/{version}")
void retire(@PathParam(value="organizationId")
                      String organizationId,
                      @PathParam(value="serviceId")
                      String serviceId,
                      @PathParam(value="version")
                      String version)
            throws io.apiman.gateway.engine.beans.exceptions.RegistrationException,
                   NotAuthorizedException

Throws:

io.apiman.gateway.engine.beans.exceptions.RegistrationException

NotAuthorizedException

getServiceEndpoint

@GET
@Path(value="{organizationId}/{serviceId}/{version}/endpoint")
@Produces(value="application/json")
io.apiman.gateway.engine.beans.ServiceEndpoint getServiceEndpoint(@PathParam(value="organizationId")
                                                                                  String organizationId,
                                                                                  @PathParam(value="serviceId")
                                                                                  String serviceId,
                                                                                  @PathParam(value="version")
                                                                                  String version)
                                                                  throws NotAuthorizedException

Throws:

NotAuthorizedException