1 /**
2 * Copyright (c) 2014, stateful.co
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met: 1) Redistributions of source code must retain the above
8 * copyright notice, this list of conditions and the following
9 * disclaimer. 2) Redistributions in binary form must reproduce the above
10 * copyright notice, this list of conditions and the following
11 * disclaimer in the documentation and/or other materials provided
12 * with the distribution. 3) Neither the name of the stateful.co nor
13 * the names of its contributors may be used to endorse or promote
14 * products derived from this software without specific prior written
15 * permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
19 * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
20 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
21 * THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
22 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
24 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
26 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
28 * OF THE POSSIBILITY OF SUCH DAMAGE.
29 */
30 package co.stateful.spi;
31
32 import com.jcabi.aspects.Immutable;
33 import java.io.IOException;
34
35 /**
36 * User.
37 *
38 * @author Yegor Bugayenko (yegor@tpc2.com)
39 * @version $Id$
40 */
41 @Immutable
42 public interface User {
43
44 /**
45 * This user exists.
46 * @return TRUE if this user logged in at least once through UI
47 */
48 boolean exists();
49
50 /**
51 * Get his security token.
52 * @return Token
53 * @throws IOException If fails due to IO problem
54 */
55 String token() throws IOException;
56
57 /**
58 * Refresh the token.
59 * @throws IOException If fails due to IO problem
60 */
61 void refresh() throws IOException;
62
63 /**
64 * Get his counters.
65 * @return Counters
66 */
67 Counters counters();
68
69 /**
70 * Get his locks.
71 * @return Locks
72 * @since 1.1
73 */
74 Locks locks();
75
76 }