cvs commit: incubator-geronimo/modules/core/src/java/org/apache/geronimo/security RealmPrincipal.java

[ad...@apache.org]

adc         2003/11/07 21:25:45

  Added:       modules/core/src/java/org/apache/geronimo/security
                        RealmPrincipal.java
  Log:
  An authenticated principal from a particular security realm.
  
  Revision  Changes    Path
  1.1                  incubator-geronimo/modules/core/src/java/org/apache/geronimo/security/RealmPrincipal.java
  
  Index: RealmPrincipal.java
  ===================================================================
  /* ====================================================================
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 2003 The Apache Software Foundation.  All rights
   * reserved.
   *
   * Redistribution and use in source and binary forms, with or without
   * modification, are permitted provided that the following conditions
   * are met:
   *
   * 1. Redistributions of source code must retain the above copyright
   *    notice, this list of conditions and the following disclaimer.
   *
   * 2. Redistributions in binary form must reproduce the above copyright
   *    notice, this list of conditions and the following disclaimer in
   *    the documentation and/or other materials provided with the
   *    distribution.
   *
   * 3. The end-user documentation included with the redistribution,
   *    if any, must include the following acknowledgment:
   *       "This product includes software developed by the
   *        Apache Software Foundation (http://www.apache.org/)."
   *    Alternately, this acknowledgment may appear in the software itself,
   *    if and wherever such third-party acknowledgments normally appear.
   *
   * 4. The names "Apache" and "Apache Software Foundation" and
   *    "Apache Geronimo" must not be used to endorse or promote products
   *    derived from this software without prior written permission. For
   *    written permission, please contact apache@apache.org.
   *
   * 5. Products derived from this software may not be called "Apache",
   *    "Apache Geronimo", nor may "Apache" appear in their name, without
   *    prior written permission of the Apache Software Foundation.
   *
   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   * SUCH DAMAGE.
   * ====================================================================
   *
   * This software consists of voluntary contributions made by many
   * individuals on behalf of the Apache Software Foundation.  For more
   * information on the Apache Software Foundation, please see
   * <http://www.apache.org/>.
   *
   * ====================================================================
   */
  package org.apache.geronimo.security;
  
  import java.security.Principal;
  
  
  /**
   * Represents a principal in an realm.
   *
   * @version $Revision: 1.1 $ $Date: 2003/11/08 05:25:45 $
   */
  public class RealmPrincipal implements Principal {
      private final String realm;
      private final Principal principal;
      private transient String name = null;
  
      public RealmPrincipal(String realm, Principal principal) {
          if (realm == null) throw new IllegalArgumentException("realm == null");
          if (principal == null) throw new IllegalArgumentException("principal == null");
  
          this.realm = realm;
          this.principal = principal;
      }
  
      /**
       * Compares this principal to the specified object.  Returns true
       * if the object passed in matches the principal represented by
       * the implementation of this interface.
       *
       * @param another principal to compare with.
       *
       * @return true if the principal passed in is the same as that
       * encapsulated by this principal, and false otherwise.
  
       */
      public boolean equals(Object another) {
          if (!(another instanceof RealmPrincipal)) return false;
  
          RealmPrincipal realmPrincipal = (RealmPrincipal) another;
  
          return realm.equals(realmPrincipal.realm) && principal.equals(realmPrincipal.principal);
      }
  
      /**
       * Returns a string representation of this principal.
       *
       * @return a string representation of this principal.
       */
      public String toString() {
          return getName();
      }
  
      /**
       * Returns a hashcode for this principal.
       *
       * @return a hashcode for this principal.
       */
      public int hashCode() {
          return getName().hashCode();
      }
  
      /**
       * Returns the name of this principal.
       *
       * @return the name of this principal.
       */
      public String getName() {
          if (name == null) {
  
              StringBuffer buffer = new StringBuffer("");
              buffer.append(realm);
              buffer.append(":[");
              buffer.append(principal.getClass().getName());
              buffer.append(':');
              buffer.append(principal.getName());
              buffer.append("]");
  
              name = buffer.toString();
          }
          return name;
      }
  
      /**
       * Returns the principal that is associated with the realm.
       * @return the principal that is associated with the realm.
       */
      public Principal getPrincipal() {
          return principal;
      }
  
      /**
       * Returns the realm that is associated with the principal.
       * @return the realm that is associated with the principal.
       */
      public String getRealm() {
          return realm;
      }
  }