Interface Service

  • All Superinterfaces:
    Base, java.lang.Cloneable, Element, ExtensibleElement, java.lang.Iterable<Element>

    public interface Service
    extends ExtensibleElement

    Represents the root of an Atom Publishing Protocol Introspection Document.

    Per APP Draft-08:

      The root of an introspection document is the "app:service" element.
    
      The "app:service" element is the container for introspection
      information associated with one or more workspaces.  An app:service
      element MUST contain one or more app:workspace elements.
      
      appService =
         element app:service {
            appCommonAttributes,
           ( appWorkspace+
              & extensionElement* )
         }
     
    • Method Detail

      • getWorkspaces

        java.util.List<Workspace> getWorkspaces()
        Return the complete set of workspaces
        Returns:
        A listing of app:workspaces elements
      • getWorkspace

        Workspace getWorkspace​(java.lang.String title)
        Return the named workspace
        Parameters:
        title - The workspace title
        Returns:
        A matching app:workspace
      • addWorkspace

        Service addWorkspace​(Workspace workspace)
        Add an individual workspace
        Parameters:
        workspace - a app:workspace element
      • addWorkspace

        Workspace addWorkspace​(java.lang.String title)
        Add an individual workspace
        Parameters:
        title - The workspace title
        Returns:
        The newly created app:workspace
      • getCollection

        Collection getCollection​(java.lang.String workspace,
                                 java.lang.String collection)
        Returns the named collection
        Parameters:
        workspace - The workspace title
        collection - The collection title
        Returns:
        A matching app:collection element
      • getCollectionThatAccepts

        Collection getCollectionThatAccepts​(javax.activation.MimeType... type)
        Returns a collection that accepts the specified media types
        Parameters:
        a - listing of media types the collection must accept
        Returns:
        A matching app:collection element
      • getCollectionThatAccepts

        Collection getCollectionThatAccepts​(java.lang.String... type)
        Returns a collection that accepts the specified media types
        Parameters:
        a - listing of media types the collection must accept
        Returns:
        A matching app:collection element
      • getCollectionsThatAccept

        java.util.List<Collection> getCollectionsThatAccept​(javax.activation.MimeType... type)
        Returns collections that accept the specified media types
        Parameters:
        a - listing of media types the collection must accept
        Returns:
        A listing matching app:collection elements
      • getCollectionsThatAccept

        java.util.List<Collection> getCollectionsThatAccept​(java.lang.String... type)
        Returns collections that accept the specified media types
        Parameters:
        a - listing of media types the collection must accept
        Returns:
        A listing of matching app:collection elements