View Javadoc

1   /*
2    * <cvs:source>$Source: /devel/astrogrid/filemanager/client/src/java/org/astrogrid/filemanager/client/FileManagerClient.java,v $</cvs:source>
3    * <cvs:author>$Author: clq2 $</cvs:author>
4    * <cvs:date>$Date: 2005/01/28 10:43:57 $</cvs:date>
5    * <cvs:version>$Revision: 1.2 $</cvs:version>
6    * <cvs:log>
7    *   $Log: FileManagerClient.java,v $
8    *   Revision 1.2  2005/01/28 10:43:57  clq2
9    *   dave_dev_200501141257 (filemanager)
10   *
11   *   Revision 1.1.2.3  2005/01/25 08:01:15  dave
12   *   Added tests for FileManagerClientFactory ....
13   *
14   *   Revision 1.1.2.2  2005/01/23 06:16:09  dave
15   *   Changed tabs to spaces ...
16   *
17   *   Revision 1.1.2.1  2005/01/23 05:39:44  dave
18   *   Added initial implementation of FileManagerClient ...
19   *
20   * </cvs:log>
21   *
22   */
23  package org.astrogrid.filemanager.client ;
24  
25  import org.astrogrid.store.Ivorn;
26  
27  import org.astrogrid.filemanager.resolver.FileManagerResolverException ;
28  import org.astrogrid.filemanager.common.exception.NodeNotFoundException ;
29  import org.astrogrid.filemanager.common.exception.FileManagerIdentifierException;
30  import org.astrogrid.filemanager.common.exception.FileManagerServiceException;
31  
32  /***
33   * Public interface for the FileManager client.
34   * The this interface hides all of the implementation details required to connect to the Registry, Community and FileManager services.
35   *
36   */
37  public interface FileManagerClient
38      {
39      /***
40       * Access to the root node for the registered account space.
41       * @return The root node of the account space.
42       * @throws NodeNotFoundException If the node does not exist.
43       * @throws FileManagerIdentifierException If unable to parse the Ivorn.
44       * @throws FileManagerResolverException If unable to resolve the ivorn into a manager delegate.
45       * @throws FileManagerServiceException If a problem occurs when handling the request.
46       *
47       *
48       */
49      public FileManagerNode home()
50          throws
51              FileManagerResolverException,
52              FileManagerServiceException,
53              FileManagerIdentifierException,
54              NodeNotFoundException;
55  
56      /***
57       * Access to a node in a file manager service.
58       * @param ivorn The identifier for the node.
59       * @return The FileManagerNode for the Ivorn.
60       * @throws NodeNotFoundException If the node does not exist.
61       * @throws FileManagerIdentifierException If unable to parse the Ivorn.
62       * @throws FileManagerResolverException If unable to resolve the ivorn into a manager delegate.
63       * @throws FileManagerServiceException If a problem occurs when handling the request.
64       *
65       */
66      public FileManagerNode node(Ivorn ivorn)
67          throws
68              FileManagerResolverException,
69              FileManagerServiceException,
70              FileManagerIdentifierException,
71              NodeNotFoundException;
72  
73  
74      }
75  
76