GroupPrincipalImpl 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.GroupPrincipal;
20  
21  /***
22   * <p>{@link GroupPrincipal} interface implementation.</p>
23   * @author <a href="mailto:taylor@apache.org">David Sean Taylor</a>
24   * @version $Id: GroupPrincipalImpl.java 592149 2007-11-05 21:05:25Z taylor $
25   */
26  public class GroupPrincipalImpl extends BasePrincipalImpl implements GroupPrincipal
27  {
28  
29      /*** The serial version uid. */
30      private static final long serialVersionUID = 6061115481776568899L;
31  
32      private static boolean hiearchicalNames = true;
33  
34      public static final Object useHierarchicalNames(boolean hierarchicalNames)
35      {
36          GroupPrincipalImpl.hiearchicalNames = hierarchicalNames;
37          return null;
38      }
39      
40      /***
41       * <p>The group principal constructor.</p>
42       * @param groupName The group principal name.
43       */
44      public GroupPrincipalImpl(String groupName)
45      {
46          super(groupName, PREFS_GROUP_ROOT, hiearchicalNames);
47      }
48  
49      public GroupPrincipalImpl(String groupName, boolean isEnabled, boolean isMapping)
50      {
51          super(groupName, PREFS_GROUP_ROOT, hiearchicalNames, isEnabled, 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       */
63      public boolean equals(Object another)
64      {
65          if (!(another instanceof GroupPrincipalImpl))
66              return false;
67          GroupPrincipalImpl principal = (GroupPrincipalImpl)another;
68          return this.getName().equals(principal.getName());
69      }
70  
71      /***
72       * <p>Gets the principal implementation full path from the principal name.</p>
73       * <p>Prepends PREFS_GROUP_ROOT if not prepended.</p>        
74       * @param name The principal name.
75       * @return The preferences full path / principal name.
76       */
77      public static String getFullPathFromPrincipalName(String name)
78      {
79          return BasePrincipalImpl.getFullPathFromPrincipalName(name, PREFS_GROUP_ROOT, hiearchicalNames);
80      }
81  
82      /***
83       * <p>Gets the principal name from the principal implementation full path.</p>
84       * <p>Remove prepended PREFS_GROUP_ROOT if present.</p>        
85       * @param fullPath The principal full path.
86       * @return The principal name.
87       */
88      public static String getPrincipalNameFromFullPath(String fullPath)
89      {
90          return BasePrincipalImpl.getPrincipalNameFromFullPath(fullPath, PREFS_GROUP_ROOT, hiearchicalNames);
91      }
92  
93      public static String getFullPathFromPrincipalName(String name, String prefsRoot)    
94      {
95          return BasePrincipalImpl.getFullPathFromPrincipalName(name, prefsRoot, hiearchicalNames);
96      }
97      
98  }