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