View Javadoc

1   /**
2    * Copyright (C) 2005-2009 Alfresco Software Limited.
3    *
4    * This file is part of the Spring Surf Extension project.
5    *
6    * Licensed under the Apache License, Version 2.0 (the "License");
7    * you may not use this file except in compliance with the License.
8    * You may obtain a copy of the License at
9    *
10   *  http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   */
18  
19  package org.springframework.extensions.webscripts.connector;
20  
21  /**
22   * Describes bound-context for a given user.
23   * <p>
24   * Bound context includes Credentials and Connector session information.
25   * <p>
26   * Credentials may or may not be bound to a CredentialVault.
27   * ConnectorSessions may or may not be bound to an Http Session.
28   * <p>
29   * This class is immutable.
30   * 
31   * @author muzquiano
32   * @author kevinr
33   */
34  public final class UserContext
35  {
36      private final String userId;
37      private final Credentials credentials;
38      private final ConnectorSession connectorSession;
39      
40      public UserContext(String userId, Credentials credentials, ConnectorSession connectorSession)
41      {
42          this.userId = userId;
43          this.credentials = credentials;
44          this.connectorSession = connectorSession;
45      }
46      
47      public String getUserId()
48      {
49          return this.userId;
50      }
51      
52      public Credentials getCredentials()
53      {
54          return this.credentials;
55      }
56      
57      public ConnectorSession getConnectorSession()
58      {
59          return this.connectorSession;
60      }
61  }