RolePrincipalImpl xref

This project has retired. For details please refer to its Attic page.

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.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 RolePrincipal
27  {
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(boolean hierarchicalNames)
35      {
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      {
46          this(roleName, true, false);
47      }
48      
49      public RolePrincipalImpl(String roleName, boolean isEnabled, boolean isMapping)
50      {
51          super(roleName, PREFS_ROLE_ROOT, hiearchicalNames, isEnabled, isMapping);
52      }
53      
54  
55      /***
56       * <p>Compares this principal to the specified object.  Returns true
57       * if the object passed in matches the principal represented by
58       * the implementation of this interface.</p>
59       * @param another Principal to compare with.
60       * @return True if the principal passed in is the same as that
61       * encapsulated by this principal, and false otherwise.
62       */
63      public boolean equals(Object another)
64      {
65          if (!(another instanceof RolePrincipalImpl))
66          {
67              return false;
68          }
69          RolePrincipalImpl principal = (RolePrincipalImpl) another;
70          return this.getName().equals(principal.getName());
71      }
72  
73      /***
74       * <p>Gets the principal implementation full path from the principal name.</p>
75       * <p>Prepends PREFS_ROLE_ROOT if not prepended.</p>        
76       * @param name The principal name.
77       * @return The preferences full path / principal name.
78       */
79      public static String getFullPathFromPrincipalName(String name)
80      {
81          return BasePrincipalImpl.getFullPathFromPrincipalName(name, PREFS_ROLE_ROOT, hiearchicalNames);
82      }
83  
84      /***
85       * <p>Gets the principal name from the principal implementation full path.</p>
86       * <p>Remove prepended PREFS_ROLE_ROOT if present.</p>        
87       * @param fullPath The principal full path.
88       * @return The principal name.
89       */
90      public static String getPrincipalNameFromFullPath(String fullPath)
91      {
92          return BasePrincipalImpl.getPrincipalNameFromFullPath(fullPath, PREFS_ROLE_ROOT, hiearchicalNames);
93      }
94      
95      public static String getFullPathFromPrincipalName(String name, String prefsRoot)    
96      {
97          return BasePrincipalImpl.getFullPathFromPrincipalName(name, prefsRoot, hiearchicalNames);
98      }
99      
100 }