View Javadoc

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