/* 
    * Licensed to the Apache Software Foundation (ASF) under one or more
    * contributor license agreements.  See the NOTICE file distributed with
    * this work for additional information regarding copyright ownership.
    * The ASF licenses this file to You under the Apache License, Version 2.0
    * (the "License"); you may not use this file except in compliance with
    * the License.  You may obtain a copy of the License at
    *
    *     http://www.apache.org/licenses/LICENSE-2.0
   *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  package org.apache.jetspeed.security.impl;
  
  import org.apache.jetspeed.security.BasePrincipal;
  
  /***
   * <p>
   * {@link BasePrincipal} interface implementation.
   * </p>
   * 
   * @author <a href="mailto:dlestrat@apache.org">David Le Strat</a>
   */
  public abstract class BasePrincipalImpl implements BasePrincipal
  {
      
      /*** The version uid. */
      private static final long serialVersionUID = 5687385387290144541L;
  
      /*** The principal name. */
      private final String name;
  
      /*** The full path. */
      private final String fullPath;
  
      /*** is this principal enabled **/
      private boolean enabled = true;
      
      /*** is this principal a mapping **/
      private boolean isMapping = false;
      
      /***
       * <p>
       * Principal constructor given a name and preferences root.
       * </p>
       * 
       * @param name The principal name.
       * @param prefsRoot The preferences root node.
       */
      public BasePrincipalImpl(String name, String prefsRoot, boolean hiearchicalNames)
      {
          this(name, prefsRoot, hiearchicalNames, true, false);
      }
      
      public BasePrincipalImpl(String name, String prefsRoot, boolean hiearchicalNames, boolean isEnabled, boolean isMapping)
      {
          this.name = name;
          this.fullPath = getFullPathFromPrincipalName(name, prefsRoot, hiearchicalNames);
          this.enabled = isEnabled;
          this.isMapping = isMapping;
      }
  
      /***
       * @see org.apache.jetspeed.security.BasePrincipal#getFullPath()
       */
      public String getFullPath()
      {
          return this.fullPath;
      }
  
      /***
       * @see java.security.Principal#getName()
       */
      public String getName()
      {
          return this.name;
      }
  
      /***
       * @see java.lang.Object#hashCode()
       */
      public int hashCode()
      {
          return this.name.hashCode();
      }
  
      /***
       * <p>
       * Returns a string representation of this principal.
       * </p>
       * 
       * @return A string representation of this principal.
       */
      public String toString()
      {
         return this.name;
     }
 
     /***
      * <p>
      * Gets the principal implementation full path from the principal name.
      * </p>
      * <p>
      * Hierarchical principal names should follow: {principal}.{subprincipal}. "." is used as the
      * separator for hierarchical elements.
      * </p>
      * <p>
      * The implementation path follow /PREFS_{PRINCIPAL}_ROOT/{principal}/{subprincipal}.
      * </p>
      * 
      * @param name The principal name.
      * @param prefsRoot The preferences root node.
      * @param hiearchicalNames indicator if hierarchy encoding (replacing '.' with '/') should be done
      * @return The preferences full path / principal name.
      */
     public static String getFullPathFromPrincipalName(String name, String prefsRoot, boolean hiearchicalNames)
     {
         String fullPath = name;
         if (null != name )
         {
             fullPath = prefsRoot + (hiearchicalNames ? name.replace('.','/') : name );
         }
         return fullPath;
     }
 
     /***
      * <p>
      * Gets the principal implementation full path from the principal name.
      * </p>
      * <p>
      * Hierarchical principal names should follow: {principal}.{subprincipal}. "." is used as the
      * separator for hierarchical elements.
      * </p>
      * <p>
      * The implementation path follow /PREFS_{PRINCIPAL}_ROOT/{principal}/{subprincipal}.
      * </p>
      * 
      * @param name The principal name.
      * @param prefsRoot The preferences root node.
      * @return The preferences full path / principal name.
      */        
 
     /***
      * <p>
      * Gets the principal name from the principal implementation full path.
      * </p>
      * <p>
      * Hierarchical principal names should follow: {principal}.{subprincipal}. "." is used as the
      * separator for hierarchical elements.
      * </p>
      * <p>
      * The implementation path follow /PREFS_{PRINCIPAL}_ROOT/{principal}/{subprincipal}.
      * </p>
      * 
      * @param fullPath The principal full path.
      * @param prefsRoot The preferences root node.
      * @param hiearchicalNames indicator if hierarchical decoding (replacing '/' with '.') should be done
      * @return The principal name.
      */
     public static String getPrincipalNameFromFullPath(String fullPath, String prefsRoot, boolean hiearchicalNames)
     {
         String name = fullPath;
         if (null != name)
         {
             name = name.substring(prefsRoot.length(), name.length());
             if ( hiearchicalNames )
             {
                 name = name.replace('/', '.');
             }
         }
         return name;
     }
 
     /***
      * <p>
      * Gets the principal name from the principal implementation full path.
      * </p>
      * <p>
      * Hierarchical principal names should follow: {principal}.{subprincipal}. "." is used as the
      * separator for hierarchical elements.
      * </p>
      * <p>
      * The implementation path follow /PREFS_{PRINCIPAL}_ROOT/{principal}/{subprincipal}.
      * </p>
      * 
      * @param fullPath The principal full path.
      * @param prefsRoot The preferences root node.
      * @return The principal name.
      */
 // MOVED TO DERVICED CLASSES    
 //    public static String getPrincipalNameFromFullPath(String fullPath, String prefsRoot)
 //    {
 //        return getPrincipalNameFromFullPath(fullPath, prefsRoot, true);
 //    }
 
     /***
      * @see org.apache.jetspeed.security.BasePrincipal#isEnabled()
      */
     public boolean isEnabled()
     {
         return enabled;
     }
 
     /***
      * @see org.apache.jetspeed.security.BasePrincipal#setEnabled(boolean)
      */
     public void setEnabled(boolean enabled)
     {
         this.enabled = enabled;
     }
    
     public boolean isMapping()
     {
         return isMapping;
     }
     
 }