Package org.springframework.extensions.webscripts

Interface Registry

  • All Known Implementing Classes:
    DeclarativeRegistry
    public interface Registry
    Web Scripts Registry
    Author:
    davidc

    • Method Detail

      • getPackage

        Path getPackage​(java.lang.String packagePath)
        Gets a Web Script Package
        Parameters:
        packagePath - String
        Returns:
        web script path representing package

      • getUri

        Path getUri​(java.lang.String uriPath)
        Gets a Web Script URL
        Parameters:
        uriPath - String
        Returns:
        web script path representing uri

      • getFamily

        Path getFamily​(java.lang.String familyPath)
        Gets a Web Script Family NOTE: - To get all families, pass / - To get a specific family, pass /{familyName}
        Parameters:
        familyPath - String
        Returns:
        web script path representing family

      • getLifecycle

        Path getLifecycle​(java.lang.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 - String
        Returns:
        web script path representing family

      • getWebScripts

        java.util.Collection<WebScript> getWebScripts()
        Gets all Web Scripts
        Returns:
        web scripts

      • getFailures

        java.util.Map<java.lang.String,​java.lang.String> getFailures()
        Gets all Web Script definitions that failed to register
        Returns:
        map of error by web script definition file path

      • getWebScript

        WebScript getWebScript​(java.lang.String id)
        Gets a Web Script by Id
        Parameters:
        id - web script id
        Returns:
        web script

      • findWebScript

        Match findWebScript​(java.lang.String method,
                    java.lang.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

      • getPackageDescriptionDocument

        PackageDescriptionDocument getPackageDescriptionDocument​(java.lang.String scriptPackage)
        Gets a package description document given a webscript package
        Parameters:
        scriptPackage - webscript package
        Returns:
        matched package description document

      • getSchemaDescriptionDocument

        SchemaDescriptionDocument getSchemaDescriptionDocument​(java.lang.String schemaId)
        Gets a schema description document given a schema id
        Parameters:
        schemaId - schema id
        Returns:
        matched schema description document

      • getPackageDescriptionDocuments

        java.util.Collection<PackageDescriptionDocument> getPackageDescriptionDocuments()
        Returns the whole list of package description documents
        Returns:
        list of package description documents

      • getSchemaDescriptionDocuments

        java.util.Collection<SchemaDescriptionDocument> getSchemaDescriptionDocuments()
        Returns the whole list of schema description documents
        Returns:
        list of schema description documents

      • getSchemaTypeDescriptionById

        TypeDescription getSchemaTypeDescriptionById​(java.lang.String typeId)
        Gets a schema type description given a schema type id
        Parameters:
        typeId - schema type id
        Returns:
        matched schema type description

      • getFailedPackageDescriptionsByPath

        java.util.Map<java.lang.String,​java.lang.String> getFailedPackageDescriptionsByPath()
        Gets all package description documents that fail to register
        Returns:
        map of failed package description documents by path

      • getFailedSchemaDescriptionsByPath

        java.util.Map<java.lang.String,​java.lang.String> getFailedSchemaDescriptionsByPath()
        Gets all schema description documents that fail to register
        Returns:
        map of failed schema description documents by path