com.epimorphics.lda.specmanager

Interface SpecManager

All Known Implementing Classes:

SpecManagerImpl

public interface SpecManager

Defines the interface for a storage manager that can preserve and retrieve specifications and use them to reconstruct routing table entries. The (singleton) instance of the SpecManager will be associated with a Router and update/delete of specifications will be reflected back to the router.

Version:

$Revision: $

Author:

Dave Reynolds

Method Summary

Methods

Modifier and Type	Method and Description
APISpec	addSpec(String prefixPath, String appName, String context, String uri, String key, com.hp.hpl.jena.rdf.model.Model spec) Load and record the specification for a new API (which might be associated with multiple APIEndpoints).
List<SpecEntry>	allSpecs() Answer a list of all the specs in this manager.
void	deleteSpec(String context, String uri, String key) Remove the specification for an API.
APISpec	getAPISpec(com.hp.hpl.jena.rdf.model.Resource specRoot) Get an APISpec object for the given spec
com.hp.hpl.jena.rdf.model.Model	getSpecForAPI(String api) Return the RDF model which specifies a particular API
com.hp.hpl.jena.rdf.model.Model	getSpecForEndpoint(String url) Return the RDF model which specifies the API corresponding to and endpoint matching the given URL.
void	loadSpecFor(String uriRequest) Request that the specification which includes an APIEndpoint matching the given request URL be located and loaded into the routing table.
APISpec	updateSpec(String prefixPath, String appName, String context, String uri, String key, com.hp.hpl.jena.rdf.model.Model spec) Update the specification for an API.

Method Detail

addSpec

APISpec addSpec(String prefixPath,
              String appName,
              String context,
              String uri,
              String key,
              com.hp.hpl.jena.rdf.model.Model spec)
                throws APISecurityException

Load and record the specification for a new API (which might be associated with multiple APIEndpoints). If the API already exists then it will be updated if the key matches.

Parameters:

uri - The uri for the RDF resource which identifies this API specification.

key - An arbitrary key to identify the provider of the specification.

spec - An RDF model containing the specification of the API and its associate endpoints.

Throws:

APISecurityException - if the key does match the key used to create the matching existing entry

updateSpec

APISpec updateSpec(String prefixPath,
                 String appName,
                 String context,
                 String uri,
                 String key,
                 com.hp.hpl.jena.rdf.model.Model spec)
                   throws APISecurityException

Update the specification for an API.

Parameters:

uri - The uri for the RDF resource which identifies this API specification.

key - An arbitrary key to identify the provider of the specification.

spec - An RDF model containing the specification of the API and its associate endpoints.

Throws:

APISecurityException - if the key does match the key used to create the matching existing entry

deleteSpec

void deleteSpec(String context,
              String uri,
              String key)
                throws APISecurityException

Remove the specification for an API.

Parameters:

uri - The uri for the RDF resource which identifies this API specification.

key - An arbitrary key to identify the provider of the specification.

Throws:

APISecurityException - if the key does match the key used to create the matching existing entry

loadSpecFor

void loadSpecFor(String uriRequest)

Request that the specification which includes an APIEndpoint matching the given request URL be located and loaded into the routing table. This will be called by the router for an unknown incoming request at enables us to support incremental loading of specifications from persistent storage.

Parameters:

uriRequest - the incoming request with the server root removed

getSpecForAPI

com.hp.hpl.jena.rdf.model.Model getSpecForAPI(String api)

Return the RDF model which specifies a particular API

Parameters:

api - the URI of the RDF resource identifying the API

getSpecForEndpoint

com.hp.hpl.jena.rdf.model.Model getSpecForEndpoint(String url)

Return the RDF model which specifies the API corresponding to and endpoint matching the given URL. Or null if there is no match.

allSpecs

List<SpecEntry> allSpecs()

Answer a list of all the specs in this manager.

getAPISpec

APISpec getAPISpec(com.hp.hpl.jena.rdf.model.Resource specRoot)

Get an APISpec object for the given spec