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.impl;
18:
19: import org.apache.jetspeed.security.RolePrincipal;
20:
21: /**
22: * <p>{@link RolePrincipal} interface implementation.</p>
23: * @author <a href="mailto:taylor@apache.org">David Sean Taylor</a>
24: * @version $Id: RolePrincipalImpl.java 592149 2007-11-05 21:05:25Z taylor $
25: */
26: public class RolePrincipalImpl extends BasePrincipalImpl implements
27: RolePrincipal {
28:
29: /** The serial version uid. */
30: private static final long serialVersionUID = -3521731040045006314L;
31:
32: private static boolean hiearchicalNames = true;
33:
34: public static final Object useHierarchicalNames(
35: boolean hierarchicalNames) {
36: RolePrincipalImpl.hiearchicalNames = hierarchicalNames;
37: return null;
38: }
39:
40: /**
41: * <p>The role principal constructor.</p>
42: * @param roleName The role principal name.
43: */
44: public RolePrincipalImpl(String roleName) {
45: this (roleName, true, false);
46: }
47:
48: public RolePrincipalImpl(String roleName, boolean isEnabled,
49: boolean isMapping) {
50: super (roleName, PREFS_ROLE_ROOT, hiearchicalNames, isEnabled,
51: isMapping);
52: }
53:
54: /**
55: * <p>Compares this principal to the specified object. Returns true
56: * if the object passed in matches the principal represented by
57: * the implementation of this interface.</p>
58: * @param another Principal to compare with.
59: * @return True if the principal passed in is the same as that
60: * encapsulated by this principal, and false otherwise.
61: */
62: public boolean equals(Object another) {
63: if (!(another instanceof RolePrincipalImpl)) {
64: return false;
65: }
66: RolePrincipalImpl principal = (RolePrincipalImpl) another;
67: return this .getName().equals(principal.getName());
68: }
69:
70: /**
71: * <p>Gets the principal implementation full path from the principal name.</p>
72: * <p>Prepends PREFS_ROLE_ROOT if not prepended.</p>
73: * @param name The principal name.
74: * @return The preferences full path / principal name.
75: */
76: public static String getFullPathFromPrincipalName(String name) {
77: return BasePrincipalImpl.getFullPathFromPrincipalName(name,
78: PREFS_ROLE_ROOT, hiearchicalNames);
79: }
80:
81: /**
82: * <p>Gets the principal name from the principal implementation full path.</p>
83: * <p>Remove prepended PREFS_ROLE_ROOT if present.</p>
84: * @param fullPath The principal full path.
85: * @return The principal name.
86: */
87: public static String getPrincipalNameFromFullPath(String fullPath) {
88: return BasePrincipalImpl.getPrincipalNameFromFullPath(fullPath,
89: PREFS_ROLE_ROOT, hiearchicalNames);
90: }
91:
92: public static String getFullPathFromPrincipalName(String name,
93: String prefsRoot) {
94: return BasePrincipalImpl.getFullPathFromPrincipalName(name,
95: prefsRoot, hiearchicalNames);
96: }
97:
98: }
|