01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * 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: /** <p>The Preferences user root node</p> */
29: final static String PREFS_USER_ROOT = "/user/";
30:
31: /** <p>The Preferences group root node</p> */
32: final static String PREFS_GROUP_ROOT = "/group/";
33:
34: /** <p>The Preferences role root node</p> */
35: final static String PREFS_ROLE_ROOT = "/role/";
36:
37: /**
38: * <p>Provides the principal full path prepending PREFS_{PRINCPAL}_ROOT if not prepended.</p>
39: * @return The principal full path.
40: */
41: String getFullPath();
42:
43: /**
44: * <p>Getter for the enabled state</p>
45: * @return true if enabled
46: */
47: boolean isEnabled();
48:
49: /**
50: * Setter for the enabled state</p>
51: * @param enabled The enabled state
52: */
53: void setEnabled(boolean enabled);
54:
55: /**
56: * <p>is this principal a security principal mapping or a real principal</p>
57: * @return true if is a mapping
58: */
59: boolean isMapping();
60:
61: }
|