Package org.alfresco.service.cmr.remote

Interface RepoRemoteTransport

  • All Known Implementing Classes:
    RepoRemoteTransportService
    public interface RepoRemoteTransport
    Over the wire, and authentication safe flavor of RepoRemote interface.
    Author:
    britt

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void closeInputHandle​(java.lang.String ticket, java.lang.String handle)
      Close a remote InputStream.
      void closeOutputHandle​(java.lang.String ticket, java.lang.String handle)
      Close a remote OutputStream.
      org.alfresco.service.cmr.repository.NodeRef createDirectory​(java.lang.String ticket, org.alfresco.service.cmr.repository.NodeRef base, java.lang.String path)
      Create a new directory.
      java.lang.String createFile​(java.lang.String ticket, org.alfresco.service.cmr.repository.NodeRef base, java.lang.String path)
      Create a file relative to a base node.
      java.util.Map<java.lang.String,​org.alfresco.util.Pair<org.alfresco.service.cmr.repository.NodeRef,​java.lang.Boolean>> getListing​(java.lang.String ticket, org.alfresco.service.cmr.repository.NodeRef dir)
      Get a listing of a directory.
      org.alfresco.service.cmr.repository.NodeRef getRoot​(java.lang.String ticket)
      Get the root node of the SpacesStore repo.
      org.alfresco.util.Pair<org.alfresco.service.cmr.repository.NodeRef,​java.lang.Boolean> lookup​(java.lang.String ticket, org.alfresco.service.cmr.repository.NodeRef base, java.lang.String path)
      Lookup a node by path relative to a node.
      java.lang.String readFile​(java.lang.String ticket, org.alfresco.service.cmr.repository.NodeRef fileRef)
      Read a file directly.
      java.lang.String readFile​(java.lang.String ticket, org.alfresco.service.cmr.repository.NodeRef base, java.lang.String path)
      Read a file from a relative path.
      byte[] readInput​(java.lang.String ticket, java.lang.String handle, int count)
      Read a block of bytes over the wire.
      void removeNode​(java.lang.String ticket, org.alfresco.service.cmr.repository.NodeRef toRemove)
      Remove a node directly.
      void removeNode​(java.lang.String ticket, org.alfresco.service.cmr.repository.NodeRef base, java.lang.String path)
      Remove a node via a relative path.
      void rename​(java.lang.String ticket, org.alfresco.service.cmr.repository.NodeRef base, java.lang.String src, java.lang.String dst)
      Rename a node
      java.lang.String writeFile​(java.lang.String ticket, org.alfresco.service.cmr.repository.NodeRef base, java.lang.String path)
      Write to an already existing file.
      void writeOutput​(java.lang.String ticket, java.lang.String handle, byte[] buff, int count)
      Write a portion of a block of bytes over the wire.

    • Method Detail

      • getRoot

        org.alfresco.service.cmr.repository.NodeRef getRoot​(java.lang.String ticket)
        Get the root node of the SpacesStore repo.
        Returns:
        The root node ref.

      • getListing

        java.util.Map<java.lang.String,​org.alfresco.util.Pair<org.alfresco.service.cmr.repository.NodeRef,​java.lang.Boolean>> getListing​(java.lang.String ticket,
                                                                                                                                             org.alfresco.service.cmr.repository.NodeRef dir)
        Get a listing of a directory.
        Parameters:
        dir - The node ref of the directory.
        Returns:
        A Map of names to node refs.

      • lookup

        org.alfresco.util.Pair<org.alfresco.service.cmr.repository.NodeRef,​java.lang.Boolean> lookup​(java.lang.String ticket,
                                                                                                   org.alfresco.service.cmr.repository.NodeRef base,
                                                                                                   java.lang.String path)
        Lookup a node by path relative to a node.
        Parameters:
        base - The base node ref.
        path - The relative path.
        Returns:
        The node ref or null.

      • createFile

        java.lang.String createFile​(java.lang.String ticket,
                            org.alfresco.service.cmr.repository.NodeRef base,
                            java.lang.String path)
        Create a file relative to a base node.
        Parameters:
        base - The base node ref.
        path - The relative path.
        Returns:
        A handle.

      • writeFile

        java.lang.String writeFile​(java.lang.String ticket,
                           org.alfresco.service.cmr.repository.NodeRef base,
                           java.lang.String path)
        Write to an already existing file.
        Parameters:
        base - The base node ref.
        path - The relative path.
        Returns:
        A handle.

      • createDirectory

        org.alfresco.service.cmr.repository.NodeRef createDirectory​(java.lang.String ticket,
                                                            org.alfresco.service.cmr.repository.NodeRef base,
                                                            java.lang.String path)
        Create a new directory.
        Parameters:
        base - The base node ref.
        path - The relative path.
        Returns:
        The node ref to the newly created directory.

      • removeNode

        void removeNode​(java.lang.String ticket,
                org.alfresco.service.cmr.repository.NodeRef toRemove)
        Remove a node directly.
        Parameters:
        toRemove - The node ref to remove.

      • removeNode

        void removeNode​(java.lang.String ticket,
                org.alfresco.service.cmr.repository.NodeRef base,
                java.lang.String path)
        Remove a node via a relative path.
        Parameters:
        base - The base node ref.
        path - The relative path.

      • rename

        void rename​(java.lang.String ticket,
            org.alfresco.service.cmr.repository.NodeRef base,
            java.lang.String src,
            java.lang.String dst)
        Rename a node
        Parameters:
        base - The base node ref.
        src - The relative source path.
        dst - The relative target path.

      • readFile

        java.lang.String readFile​(java.lang.String ticket,
                          org.alfresco.service.cmr.repository.NodeRef fileRef)
        Read a file directly.
        Parameters:
        fileRef - The node ref of the file.
        Returns:
        A handle.

      • readFile

        java.lang.String readFile​(java.lang.String ticket,
                          org.alfresco.service.cmr.repository.NodeRef base,
                          java.lang.String path)
        Read a file from a relative path.
        Parameters:
        base - The base node ref.
        path - The relative path to the file.
        Returns:
        A handle.

      • readInput

        byte[] readInput​(java.lang.String ticket,
                 java.lang.String handle,
                 int count)
        Read a block of bytes over the wire.
        Parameters:
        ticket - The authentication ticket.
        handle - The remote handle.
        count - The number of bytes to try to read.
        Returns:
        A buffer of the bytes read. Length is 0 at EOF.

      • writeOutput

        void writeOutput​(java.lang.String ticket,
                 java.lang.String handle,
                 byte[] buff,
                 int count)
        Write a portion of a block of bytes over the wire.
        Parameters:
        ticket - The authentication ticket.
        handle - The remote handle.
        buff - The buffer with data.
        count - The number of bytes to write.

      • closeInputHandle

        void closeInputHandle​(java.lang.String ticket,
                      java.lang.String handle)
        Close a remote InputStream.
        Parameters:
        ticket - The authentication ticket.
        handle - The handle.

      • closeOutputHandle

        void closeOutputHandle​(java.lang.String ticket,
                       java.lang.String handle)
        Close a remote OutputStream.
        Parameters:
        ticket - The authentication ticket.
        handle - The handle.