Package com.peterphi.std.guice.web.rest.service.servicedescription

Class RestServiceListImpl

java.lang.Object

com.peterphi.std.guice.web.rest.service.servicedescription.RestServiceListImpl

All Implemented Interfaces:

RestServiceList

public class RestServiceListImpl
extends Object
implements RestServiceList

A simple REST resource that lists the services registered with the RestResourceRegistry N.B. by default we do not enforce authorisation on this resource, because it can be very useful for developers (and the knowledge of APIs shouldn't in and of itself introduce a security risk. Access can be restricted by setting framework.webauth.scope.framework-info.force-skip=false

Constructor Summary

Constructors

Constructor	Description
RestServiceListImpl()

Method Summary

Modifier and Type	Method	Description
String	getExampleXML(String className, boolean minimal)
String	getServiceDescription(int serviceId, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo uriInfo)
String	getXSDSchema(String className)
String	index(javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo uriInfo)

Methods inherited from class java.lang.Object

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

Constructor Details

RestServiceListImpl

@Inject
public RestServiceListImpl()

Method Details

index

public String index(javax.ws.rs.core.HttpHeaders headers,
 javax.ws.rs.core.UriInfo uriInfo)
             throws Exception

Specified by:

index in interface RestServiceList

Throws:

Exception

getServiceDescription

public String getServiceDescription(int serviceId,
 javax.ws.rs.core.HttpHeaders headers,
 javax.ws.rs.core.UriInfo uriInfo)
                             throws Exception

Specified by:

getServiceDescription in interface RestServiceList

Throws:

Exception

getXSDSchema

public String getXSDSchema(String className)
                    throws Exception

Specified by:

getXSDSchema in interface RestServiceList

Throws:

Exception

getExampleXML

public String getExampleXML(String className,
 boolean minimal)
                     throws Exception

Specified by:

getExampleXML in interface RestServiceList

Throws:

Exception