com.epimorphics.lda.core

Interface APIEndpoint

All Known Implementing Classes:

APIEndpointImpl

public interface APIEndpoint

An particular api endpoint receives "calls" (can be GET or POST) via a Router, extracts the parameters defining the request, combines that with some underlying API specification, retrieves the relevant results page and returns it with the appropriate Mime type.

Version:

$Revision: $

Author:

Dave Reynolds

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	APIEndpoint.Request

Method Summary

Methods

Modifier and Type	Method and Description
ResponseResult	call(APIEndpoint.Request r, NoteBoard nb) Called by the Router to invoke the API and return set of result matches
Bindings	defaults() Return any default bindings that this endpoint has set up (which need not be ones specified by a config).
com.hp.hpl.jena.rdf.model.Resource	getMetadata(Bindings context, URI requestURI, String formatName, com.hp.hpl.jena.rdf.model.Model metadata) Return a metadata description for the query that would be run by this endpoint
String	getPrefixPath() An API spec (and hence an endpoint) may have been defined with a prefix path string, which follows the context path.
Renderer	getRendererByType(MediaType mt) Return the renderer known by the given media type.
Renderer	getRendererNamed(String name) Return the renderer known by the given name.
APIEndpointSpec	getSpec() Return the specification for this endpoint
String	getURITemplate() The URI template at which this APIEndpoint should be attached

Method Detail

getURITemplate

String getURITemplate()

The URI template at which this APIEndpoint should be attached

call

ResponseResult call(APIEndpoint.Request r,
                  NoteBoard nb)

Called by the Router to invoke the API and return set of result matches

Parameters:

r - the request

Returns:

ResponseResult: the ResultSet for rendering and the call context used for the result set.

getMetadata

com.hp.hpl.jena.rdf.model.Resource getMetadata(Bindings context,
                                             URI requestURI,
                                             String formatName,
                                             com.hp.hpl.jena.rdf.model.Model metadata)

Return a metadata description for the query that would be run by this endpoint

getSpec

APIEndpointSpec getSpec()

Return the specification for this endpoint

getRendererNamed

Renderer getRendererNamed(String name)

Return the renderer known by the given name.

getRendererByType

Renderer getRendererByType(MediaType mt)

Return the renderer known by the given media type.

defaults

Bindings defaults()

Return any default bindings that this endpoint has set up (which need not be ones specified by a config).

getPrefixPath

String getPrefixPath()

An API spec (and hence an endpoint) may have been defined with a prefix path string, which follows the context path. Return the prefix path, or the empty string if it was defined with no prefix path.