RK 060712 methods must return interface for RMI
authorrkoenig
Wed, 12 Jul 2006 11:17:26 +0200
changeset 3329bf18ecff1d55
parent 3328 3dd71f917154
child 3330 5c8ef27e2c9e
RK 060712 methods must return interface for RMI
src/java/isac/users/IUserManager.java
src/java/isac/wsdialog/IContextProvider.java
src/java/isac/wsdialog/IWSDialogManager.java
     1.1 --- a/src/java/isac/users/IUserManager.java	Wed Jul 12 11:16:54 2006 +0200
     1.2 +++ b/src/java/isac/users/IUserManager.java	Wed Jul 12 11:17:26 2006 +0200
     1.3 @@ -1,6 +1,17 @@
     1.4 +/*
     1.5 + * @author Robert Koenighofer, member of the ISAC-team, 
     1.6 + * Copyright (c) 2006 by Robert Koenighofer
     1.7 + * created Jul 11, 2006 10:09:13 AM
     1.8 + * Institute for Softwaretechnology, Graz University of Technology, Austria.
     1.9 + * 
    1.10 + * Use is subject to PGPL license terms.
    1.11 + */
    1.12 +
    1.13  package isac.users;
    1.14  
    1.15 -import isac.session.Session;
    1.16 +import java.rmi.RemoteException;
    1.17 +import java.rmi.Remote;
    1.18 +import isac.browserdialog.IBDialogManager;
    1.19  
    1.20  /**
    1.21   * This is an interface for the UserManager. The UserManager is responsible
    1.22 @@ -9,21 +20,22 @@
    1.23   * @author Robert Koenighofer
    1.24   * @see isac.user.UserManager
    1.25   */
    1.26 -public interface IUserManager {
    1.27 +public interface IUserManager extends Remote{
    1.28  
    1.29  	/**
    1.30  	 * Checks by use of {@link isac.users.Accounts} if username and 
    1.31  	 * password is correct. If this is true an new Session is created by 
    1.32 -	 * use of the {@link isac.session.SessionManager}. The
    1.33 +	 * use of the {@link isac.session.SessionManager}. An interface to the
    1.34  	 * created Session object is returned. If the login fails, null
    1.35  	 * is returned.
    1.36  	 * 
    1.37  	 * @param username the name of the user who wants to login
    1.38  	 * @param pass the password the user has entered
    1.39 -	 * @return the Session which was created for the user or null if login fails
    1.40 +	 * @return an interface to the Session which was created for the user or null if login fails
    1.41 +	 * @throws RemoteException if remote object is not available any more
    1.42  	 * @see isac.user.UserManager#login(String, String)
    1.43  	 */
    1.44 -	public Session login(String username, String pass);
    1.45 +	public IBDialogManager login(String username, String pass) throws RemoteException;
    1.46  
    1.47  	/**
    1.48  	 * Returns the User object of the user belonging to the session
    1.49 @@ -32,9 +44,10 @@
    1.50  	 * 
    1.51  	 * @param session_id
    1.52  	 * @return the User who owns the session or null if session_id is unknown
    1.53 +	 * @throws RemoteException if remote object is not available any more
    1.54  	 * @see isac.user.UserManager#getUser(String)
    1.55  	 */
    1.56 -	public User getUser(String session_id);
    1.57 +	public User getUser(String session_id) throws RemoteException;
    1.58  
    1.59  	/**
    1.60  	 * Returns the username of the user belonging to the session
    1.61 @@ -43,8 +56,9 @@
    1.62  	 * 
    1.63  	 * @param session_id
    1.64  	 * @return the username who owns the session or null if session_id is unknown
    1.65 +	 * @throws RemoteException if remote object is not available any more
    1.66  	 * @see isac.user.UserManager#getUsername(String)
    1.67  	 */
    1.68 -	public User getUsername(String session_id);
    1.69 +	public String getUsername(String session_id) throws RemoteException;
    1.70  
    1.71  }
     2.1 --- a/src/java/isac/wsdialog/IContextProvider.java	Wed Jul 12 11:16:54 2006 +0200
     2.2 +++ b/src/java/isac/wsdialog/IContextProvider.java	Wed Jul 12 11:17:26 2006 +0200
     2.3 @@ -1,7 +1,10 @@
     2.4 -/**
     2.5 +/*
     2.6 + * @author Robert Koenighofer, member of the ISAC-team, 
     2.7 + * Copyright (c) 2006 by Robert Koenighofer
     2.8 + * created Jul 11, 2006 10:09:13 AM
     2.9 + * Institute for Softwaretechnology, Graz University of Technology, Austria.
    2.10   * 
    2.11 - * @author Robert Koenighofer
    2.12 - * Created on Jun 10, 2006
    2.13 + * Use is subject to PGPL license terms.
    2.14   */
    2.15  package isac.wsdialog;
    2.16  
     3.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     3.2 +++ b/src/java/isac/wsdialog/IWSDialogManager.java	Wed Jul 12 11:17:26 2006 +0200
     3.3 @@ -0,0 +1,71 @@
     3.4 +/*
     3.5 + * @author Robert Koenighofer, member of the ISAC-team, 
     3.6 + * Copyright (c) 2006 by Robert Koenighofer
     3.7 + * created Jul 11, 2006 10:09:13 AM
     3.8 + * Institute for Softwaretechnology, Graz University of Technology, Austria.
     3.9 + * 
    3.10 + * Use is subject to PGPL license terms.
    3.11 + */
    3.12 +
    3.13 +package isac.wsdialog;
    3.14 +
    3.15 +import java.rmi.Remote;
    3.16 +import java.rmi.RemoteException;
    3.17 +
    3.18 +/**
    3.19 + * This is an interface for the WSDialogManger. It is used by the window
    3.20 + * application to perform actions with the WorksheetDialoges
    3.21 + * 
    3.22 + * @see isac.gui.WindowApplication
    3.23 + * @see isac.wsdialog.WSDialogManager
    3.24 + * @author Robert Koenighofer
    3.25 + */
    3.26 +public interface IWSDialogManager extends Remote{
    3.27 +	
    3.28 +    /**
    3.29 +     * This method creates a new WorksheetDialog and returns
    3.30 +     * the ID of the created Object. The new Dialog is added into
    3.31 +     * the map and is set as active Worksheet dialog.
    3.32 +     * 
    3.33 +     * @return the ID of the created Worksheet dialog.
    3.34 +     * @throws RemoteException if remote object is not available
    3.35 +     * @see isac.wsdialog.WSDialogManager#openWSDialog()
    3.36 +     */
    3.37 +	 public String openWSDialog() throws RemoteException;
    3.38 +	 
    3.39 +    /**
    3.40 +	 * This method returns an interface to the WorksheetDialog with the desired
    3.41 +	 * ID. If the ID is unknown to the WSDialogManager, null is returned.
    3.42 +	 * 
    3.43 +	 * @return an interface to the WorksheetDialog with the desired ID or null
    3.44 +	 *         if it does not exist.
    3.45 +	 * @throws RemoteException
    3.46 +	 *             if remote object is not available
    3.47 +	 * @see isac.wsdialog.WSDialogManager#getWSDialog(String)
    3.48 +	 */
    3.49 +	 public IWorksheetDialog getWSDialog(String wsd_id) throws RemoteException;
    3.50 +	 
    3.51 +    /**
    3.52 +     * This method closes the WorksheetDialog with the specified ID. If
    3.53 +     * the ID is unknown to the WSDialogManager nothing will happen.
    3.54 +     * If the worksheet to close is the active worksheet, the worksheet
    3.55 +     * with the highest ID will become the new active worksheet. If there
    3.56 +     * is no worksheet left, the active worksheet will be set to null.
    3.57 +     * 
    3.58 +     * @param wsd_id the ID of the worksheet to close 
    3.59 +     * @throws RemoteException if remote object is not available
    3.60 +     * @see isac.wsdialog.WSDialogManager#closeWSDialog(String)
    3.61 +     */	 
    3.62 +	 public void closeWSDialog(String wsd_id) throws RemoteException;
    3.63 +	 
    3.64 +    /**
    3.65 +     * This method returns the active WorksheetDialog. If there
    3.66 +     * is no active WorksheetDialog (e.g. if there is no WorksheetDialog
    3.67 +     * at all), null is returned.
    3.68 +     * 
    3.69 +     * @return The active WorksheetDialog or null if there is non.
    3.70 +     * @throws RemoteException if remote object is not available
    3.71 +     * @see isac.wsdialog.WSDialogManager#numberOpenedWSDialoges()
    3.72 +     */	 
    3.73 +	 public int numberOpenedWSDialoges() throws RemoteException;
    3.74 +}