Welcome to mirror list, hosted at ThFree Co, Russian Federation.

UserSession.java « session « core « omtc « capitati « com « java « main « src - github.com/ianj-als/omtc.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: 6fa549c685e15fdbe2e1cd338e680dc0c138c06c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
/*
 * Copyright Capita Translation and Interpreting 2013
 *
 * This file is part of OMTC.
 *
 * OMTC is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * OMTC is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with OMTC.  If not, see <http://www.gnu.org/licenses/>.
 */
package com.capitati.omtc.core.session;

import java.util.UUID;
import java.util.concurrent.ExecutorService;

import com.capitati.omtc.core.security.IUser;

/**
 * A session that is associated with a user. This session would be used by a
 * service implementation that requires user identity.
 * 
 * @author ianjohnson
 */
public abstract class UserSession extends Session implements IUserSession {
  protected final IUser user;

  /**
   * Construct a user session that does not support downloading or uploading.
   * 
   * @param theIdentifier - the unique identifier for the session.
   * @param theUser - the associated user object.
   */
  protected UserSession(final UUID theIdentifier, final IUser theUser) {
    super(theIdentifier);
    user = theUser;
  }

  /**
   * Construct a user session that supports downloading and uploading.
   * 
   * @param theIdentifier - the unique identifier for the session.
   * @param theUser - the associated user object.
   * @param theDelegateExecutorService - the executor service in which the
   * upload and download delegates shall run.
   */
  protected UserSession(
      final UUID theIdentifier,
      final IUser theUser,
      final ExecutorService theDelegationExecutorService) {
    super(theIdentifier, theDelegationExecutorService);
    user = theUser;
  }

  /**
   * 
   * @param theIdentifier - the unique identifier for the session.
   * @param theUser - the associated user object.
   * @param theDelegationExecutorService -the executor service in which the
   * upload and download delegates shall run.
   * @param theTransferBufferSize - the number of bytes available to the
   * upload and download transfer buffer.
   */
  protected UserSession(
      final UUID theIdentifier,
      final IUser theUser,
      final ExecutorService theDelegationExecutorService,
      final int theTransferBufferSize) {
    super(theIdentifier, theDelegationExecutorService, theTransferBufferSize);
    user = theUser;
  }

  /**
   * Retrieve the associated user object for the session.
   * 
   * @return The session's associated user object.
   */
  public IUser getUser() {
    return user;
  }
}