View Javadoc

1   /* 
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *     http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.jetspeed.security;
18  
19  import java.io.Serializable;
20  
21  import java.security.Principal;
22  
23  /***
24  * <p>The base principal.</p>
25  * @author <a href="mailto:taylor@apache.org">David Taylor</a>, <a href="mailto:dlestrat@apache.org">David Le Strat</a>
26  */
27  public interface BasePrincipal extends Principal, Serializable
28  {
29      /*** <p>The Preferences user root node</p> */
30      final static String  PREFS_USER_ROOT = "/user/";
31      
32      /*** <p>The Preferences group root node</p> */
33      final static String PREFS_GROUP_ROOT = "/group/";
34      
35      /*** <p>The Preferences role root node</p> */
36      final static String  PREFS_ROLE_ROOT = "/role/";
37      
38      /***
39       * <p>Provides the principal full path prepending PREFS_{PRINCPAL}_ROOT if not prepended.</p>
40       * @return The principal full path.
41       */
42      String getFullPath();
43  
44      /***
45       * <p>Getter for the enabled state</p>
46       * @return true if enabled
47       */
48      boolean isEnabled();
49      
50      /***
51       * Setter for the enabled state</p>
52       * @param enabled The enabled state
53       */
54      void setEnabled(boolean enabled);
55      
56      /***
57       * <p>is this principal a security principal mapping or a real principal</p>
58       * @return true if is a mapping
59       */
60      boolean isMapping();
61      
62  }