View Javadoc

1   package twcsckernel.serverKernel.io;
2   
3   import java.io.IOException;
4   import java.util.Map;
5   
6   import twcsckernel.serverKernel.utils.UserData;
7   
8   /***
9    * Interfejs operacji I/O dla zarejestrowanych użytkowników.
10   * 
11   * @author VMD Group
12   * 
13   */
14  public interface UserIO {
15  
16  	/***
17  	 * Wczytuje zarejestrowanych użytkowników.
18  	 * 
19  	 * @return - mapa zarejestrowanych użytkowników <login,dane>
20  	 * @throws IOException -
21  	 *             wyjątek rzucany w przypadku błędu odczytu
22  	 */
23  	public Map<String, UserData> readUsers() throws IOException;
24  
25  	/***
26  	 * Metoda dodaje dane do zbioru zarejestrowanych użytkowników.
27  	 * 
28  	 * @param userData -
29  	 *            dane do dodania
30  	 * @return - <code>true</code> jeśli operacja się udała (nie było
31  	 *         zarejestrowanego użytkownika o podanym loginie) lub
32  	 *         <code>false</code> w przeciwnym wypadku.
33  	 * @throws IOException -
34  	 *             wyjątek rzucany w przypadku błędu zapisu
35  	 */
36  	public boolean addNewUser(UserData userData) throws IOException;
37  
38  	/***
39  	 * Metoda usuwa dane ze zbioru zarejestrowanych użytkowników.
40  	 * 
41  	 * @param login -
42  	 *            nazwa użytkownika do usunięcia
43  	 * @param users -
44  	 *            aktualna mapa zarejestrowanych użytkowników (z której również
45  	 *            zostanie użytkownik usunięty)
46  	 * @return - <code>true</code> jeśli operacja się udała (był
47  	 *         zarejestrowany użytkownik o podanym loginie) lub
48  	 *         <code>false</code> w przeciwnym wypadku.
49  	 * @throws IOException -
50  	 *             wyjątek rzucany w przypadku błędu zapisu
51  	 */
52  	public boolean removeUser(String login, Map<String, UserData> users)
53  			throws IOException;
54  
55  }