View Javadoc

1   /*
2    * <cvs:source>$Source: /devel/astrogrid/mySpace/client/src/java/org/astrogrid/store/adapter/aladin/AladinAdapter.java,v $</cvs:source>
3    * <cvs:author>$Author: clq2 $</cvs:author>
4    * <cvs:date>$Date: 2004/11/17 16:22:53 $</cvs:date>
5    * <cvs:version>$Revision: 1.4 $</cvs:version>
6    * <cvs:log>
7    *   $Log: AladinAdapter.java,v $
8    *   Revision 1.4  2004/11/17 16:22:53  clq2
9    *   nww-itn07-704
10   *
11   *   Revision 1.3.16.2  2004/11/16 17:27:59  nw
12   *   tidied imports
13   *
14   *   Revision 1.3.16.1  2004/11/16 16:47:28  nw
15   *   copied aladinAdapter interfaces into a neutrally-named package.
16   *   deprecated original interfaces.
17   *   javadoc
18   *
19   *   Revision 1.3  2004/10/05 15:39:29  dave
20   *   Merged changes to AladinAdapter ...
21   *
22   *   Revision 1.2.4.1  2004/10/05 15:30:44  dave
23   *   Moved test base from test to src tree ....
24   *   Added MimeTypeUtil
25   *   Added getMimeType to the adapter API
26   *   Added logout to the adapter API
27   *
28   *   Revision 1.2  2004/09/28 10:24:19  dave
29   *   Added AladinAdapter interfaces and mock implementation.
30   *
31   *   Revision 1.1.2.5  2004/09/24 01:36:18  dave
32   *   Refactored File as Node and Container ...
33   *
34   *   Revision 1.1.2.4  2004/09/23 16:32:01  dave
35   *   Added better Exception handling ....
36   *   Added initial mock container ....
37   *   Added initial root container tests ...
38   *
39   *   Revision 1.1.2.3  2004/09/23 12:21:31  dave
40   *   Added mock security service and login test ...
41   *
42   *   Revision 1.1.2.2  2004/09/23 09:18:13  dave
43   *   Renamed AbstractTest to TestBase to exclude it from batch test ....
44   *   Added first test for null account ....
45   *
46   *   Revision 1.1.2.1  2004/09/22 16:47:37  dave
47   *   Added initial classes and tests for AladinAdapter.
48   *
49   * </cvs:log>
50   *
51   */
52  package org.astrogrid.store.adapter.aladin ;
53  
54  import org.astrogrid.community.common.security.data.SecurityToken;
55  import org.astrogrid.store.Ivorn;
56  
57  /***
58   * An adapter to enable Aladin to access files in AstroGrid MySpace.
59   *@deprecated use {@link org.astrogrid.store.tree.TreeClient}
60   */
61  public interface AladinAdapter
62  	{
63  
64  	/***
65  	 * Login to the AstroGrid community.
66  	 * @param ivorn    The 'ivo://...' identifier for the AstroGrid account.
67  	 * @param password The account password.
68       * @throws AladinAdapterLoginException   If the login fails.
69       * @throws AladinAdapterServiceException If unable to handle the request.
70  	 *
71  	 */
72  	public void login(Ivorn ivorn, String password)
73  		throws AladinAdapterLoginException, AladinAdapterServiceException ;
74  
75  	/***
76  	 * Logout from the AstroGrid community.
77       * @throws AladinAdapterServiceException If unable to handle the request.
78  	 *
79  	 */
80  	public void logout()
81  		throws AladinAdapterServiceException ;
82  
83  	/***
84  	 * Access to the current security token.
85  	 * @return The current security token, or null if not logged in.
86  	 *
87  	 */
88  	public SecurityToken getToken() ;
89  
90  	/***
91  	 * Get the root node of the account home space.
92  	 * @return An AladinAdapterContainer representing the root of the account myspace.
93       * @throws AladinAdapterSecurityException If the adapter is not logged in.
94       * @throws AladinAdapterServiceException  If unable to handle the request.
95  	 *
96  	 */
97  	public AladinAdapterContainer getRoot()
98  		throws AladinAdapterSecurityException, AladinAdapterServiceException ;
99  
100 	}