org.springframework.extensions.webscripts
Interface Registry

All Known Implementing Classes:
DeclarativeRegistry

public interface Registry

Web Scripts Registry

Author:
davidc

Method Summary
 Match findWebScript(String method, String uri)
          Gets a Web Script given an HTTP Method and URI
 Map<String,String> getFailures()
          Gets all Web Script definitions that failed to register
 Path getFamily(String familyPath)
          Gets a Web Script Family NOTE: - To get all families, pass / - To get a specific family, pass /{familyName}
 Path getLifecycle(String lifecyclePath)
          Gets a Lifecycle Family, for example, all deprecated web scripts NOTE: - To get all lifecycles, pass / - To get a specific lifecycle, pass /{lifecycleName}
 Path getPackage(String packagePath)
          Gets a Web Script Package
 Path getUri(String uriPath)
          Gets a Web Script URL
 WebScript getWebScript(String id)
          Gets a Web Script by Id
 Collection<WebScript> getWebScripts()
          Gets all Web Scripts
 void reset()
          Resets the Web Script Registry
 

Method Detail

getPackage

Path getPackage(String packagePath)
Gets a Web Script Package

Parameters:
packagePath -
Returns:
web script path representing package

getUri

Path getUri(String uriPath)
Gets a Web Script URL

Parameters:
uriPath -
Returns:
web script path representing uri

getFamily

Path getFamily(String familyPath)
Gets a Web Script Family NOTE: - To get all families, pass / - To get a specific family, pass /{familyName}

Parameters:
familyPath -
Returns:
web script path representing family

getLifecycle

Path getLifecycle(String lifecyclePath)
Gets a Lifecycle Family, for example, all deprecated web scripts NOTE: - To get all lifecycles, pass / - To get a specific lifecycle, pass /{lifecycleName}

Parameters:
lifecyclePath -
Returns:
web script path representing family

getWebScripts

Collection<WebScript> getWebScripts()
Gets all Web Scripts

Returns:
web scripts

getFailures

Map<String,String> getFailures()
Gets all Web Script definitions that failed to register

Returns:
map of error by web script definition file path

getWebScript

WebScript getWebScript(String id)
Gets a Web Script by Id

Parameters:
id - web script id
Returns:
web script

findWebScript

Match findWebScript(String method,
                    String uri)
Gets a Web Script given an HTTP Method and URI

Parameters:
method - http method
uri - uri
Returns:
script match (pair of script and uri that matched)

reset

void reset()
Resets the Web Script Registry



Copyright © 2009 SpringSource, Inc. All Rights Reserved.