org.apache.brooklyn.camp.server.rest.resource

Class ApiListingResource

java.lang.Object

org.apache.brooklyn.camp.server.rest.resource.ApiListingResource

Direct Known Subclasses:

ApidocRestResource

public class ApiListingResource
extends Object

ApiListingResource usable within a jersey servlet filter. Taken from io.swagger:swagger-jaxrs, class io.swagger.jaxrs.listing.ApiListingResource, which can only be used within a servlet context. We are here using a filter, but jersey has a WebConfig class that can substitute ServletConfig and FilterConfig.

To-do:

Remove when the rest-server is no longer running within a filter (e.g. as a standalone OSGi http service)

Constructor Summary

Constructors

Constructor and Description
ApiListingResource()

Method Summary

Methods

Modifier and Type	Method and Description
protected Map<String,String>	getCookies(HttpHeaders headers)
protected Map<String,List<String>>	getHeaders(HttpHeaders headers)
Response	getListing(Application app, com.sun.jersey.spi.container.servlet.WebConfig sc, HttpHeaders headers, UriInfo uriInfo, String type)
Response	getListingJson(Application app, com.sun.jersey.spi.container.servlet.WebConfig sc, HttpHeaders headers, UriInfo uriInfo)
Response	getListingYaml(Application app, com.sun.jersey.spi.container.servlet.WebConfig sc, HttpHeaders headers, UriInfo uriInfo)
protected Map<String,List<String>>	getQueryParams(MultivaluedMap<String,String> params)
protected io.swagger.models.Swagger	scan(Application app, com.sun.jersey.spi.container.servlet.WebConfig sc)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ApiListingResource

public ApiListingResource()

Method Detail

scan

protected io.swagger.models.Swagger scan(Application app,
                             com.sun.jersey.spi.container.servlet.WebConfig sc)

getListing

public Response getListing(@Context
                  Application app,
                  @Context
                  com.sun.jersey.spi.container.servlet.WebConfig sc,
                  @Context
                  HttpHeaders headers,
                  @Context
                  UriInfo uriInfo,
                  String type)

getListingJson

public Response getListingJson(@Context
                      Application app,
                      @Context
                      com.sun.jersey.spi.container.servlet.WebConfig sc,
                      @Context
                      HttpHeaders headers,
                      @Context
                      UriInfo uriInfo)

getListingYaml

public Response getListingYaml(@Context
                      Application app,
                      @Context
                      com.sun.jersey.spi.container.servlet.WebConfig sc,
                      @Context
                      HttpHeaders headers,
                      @Context
                      UriInfo uriInfo)

getQueryParams

protected Map<String,List<String>> getQueryParams(MultivaluedMap<String,String> params)

getCookies

protected Map<String,String> getCookies(HttpHeaders headers)

getHeaders

protected Map<String,List<String>> getHeaders(HttpHeaders headers)