Class WebScriptOptionsMetaData

  • All Implemented Interfaces:
    ResourceMetaDataWriter, org.springframework.extensions.webscripts.WebScript

    public class WebScriptOptionsMetaData
    extends ApiWebScript
    implements ResourceMetaDataWriter
    Provides general information about an Api call and its methods.
    Author:
    Gethin James
    • Constructor Detail

      • WebScriptOptionsMetaData

        public WebScriptOptionsMetaData()
    • Method Detail

      • execute

        public void execute​(Api api,
                            org.springframework.extensions.webscripts.WebScriptRequest req,
                            org.springframework.extensions.webscripts.WebScriptResponse res)
                     throws java.io.IOException
        Specified by:
        execute in class ApiWebScript
        Throws:
        java.io.IOException
      • chooseWriter

        protected ResourceMetaDataWriter chooseWriter​(org.springframework.extensions.webscripts.WebScriptRequest req)
        Chooses the correct writer to use based on the supplied "format" param
        Parameters:
        req - - the WebScriptRequest
        Returns:
        ResourceMetaDataWriter - a matching writer - DEFAULT is this class.
      • processResult

        public static java.lang.Object processResult​(ResourceWithMetadata resource,
                                                     java.util.Map<java.lang.String,​ResourceWithMetadata> apiResources)
        Processes the resulting resource and returns the data to be displayed
        Parameters:
        resource - ResourceWithMetadata
        Returns:
        Either a ExecutionResult or a CollectionWithPagingInfo
      • writeMetaData

        public void writeMetaData​(java.io.OutputStream out,
                                  ResourceWithMetadata resource,
                                  java.util.Map<java.lang.String,​ResourceWithMetadata> allApiResources)
                           throws java.io.IOException
        Description copied from interface: ResourceMetaDataWriter
        Write the metadata to the OutputStream
        Specified by:
        writeMetaData in interface ResourceMetaDataWriter
        Parameters:
        out - OutputStream
        resource - - the selected resource
        allApiResources - - all resources for the API version
        Throws:
        java.io.IOException