git.aero2k.de Git - tmp/jakarta-migration.git/blob

   1 /**
   2  *  This document is a part of the source code and related artifacts
   3  *  for CollectionSpace, an open source collections management system
   4  *  for museums and related institutions:
   5
   6  *  http://www.collectionspace.org
   7  *  http://wiki.collectionspace.org
   8
   9  *  Copyright 2009 University of California at Berkeley
  10
  11  *  Licensed under the Educational Community License (ECL), Version 2.0.
  12  *  You may not use this file except in compliance with this License.
  13
  14  *  You may obtain a copy of the ECL 2.0 License at
  15
  16  *  https://source.collectionspace.org/collection-space/LICENSE.txt
  17
  18  *  Unless required by applicable law or agreed to in writing, software
  19  *  distributed under the License is distributed on an "AS IS" BASIS,
  20  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  21  *  See the License for the specific language governing permissions and
  22  *  limitations under the License.
  23 .
  24  */
  25 package org.collectionspace.authentication.spi;
  26
  27 import org.collectionspace.authentication.CSpaceTenant;
  28 import org.collectionspace.authentication.CSpaceUser;
  29
  30 /**
  31  * Utilities for accessing the authentication context.
  32  */
  33 public interface AuthNContext {
  34
  35     public static final String ANONYMOUS_USER = "anonymous";
  36     public static final String ANONYMOUS_TENANT_ID = "-1";
  37     public static final String ANONYMOUS_TENANT_NAME = ANONYMOUS_USER;
  38     public static final String SPRING_ADMIN_USER = "SPRING_ADMIN";
  39     public static final String TENANT_ID_QUERY_PARAM = "tid";
  40     public static final String TENANT_ID_PATH_PARAM = "tenantId";
  41
  42     /**
  43      * Returns the username of the authenticated user.
  44      *
  45      * @return the username
  46      */
  47     public String getUserId();
  48
  49     /**
  50      * Returns the authenticated user.
  51      *
  52      * @return the user
  53      */
  54     public CSpaceUser getUser();
  55
  56     /**
  57      * Returns the id of the primary tenant associated with the authenticated user.
  58      *
  59      * @return the tenant id
  60      */
  61     public String getCurrentTenantId();
  62
  63     /**
  64      * Returns the name of the primary tenant associated with the authenticated user.
  65      *
  66      * @return the tenant name
  67      */
  68     public String getCurrentTenantName();
  69
  70     /**
  71      * Returns the primary tenant associated with the authenticated user.
  72      *
  73      * @return the tenant
  74      */
  75     public CSpaceTenant getCurrentTenant();
  76
  77 }