Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * 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.catalina.realm;
 
 
 import java.util.List;
 
 
Generic implementation of java.security.Principal that is available for use by Realm implementations.

Author(s):
Craig R. McClanahan
Version:
$Revision: 1237 $ $Date: 2009-11-03 02:55:48 +0100 (Tue, 03 Nov 2009) $
 
 
 public class GenericPrincipal implements Principal {
 
 
     // ----------------------------------------------------------- Constructors
 

    
Construct a new Principal, associated with the specified Realm, for the specified username and password.

Parameters:
realm The Realm that owns this Principal
name The username of the user represented by this Principal
password Credentials used to authenticate this user
 
     public GenericPrincipal(Realm realmString nameString password) {
 
         this(realmnamepasswordnull);
 
     }


    
Construct a new Principal, associated with the specified Realm, for the specified username and password, with the specified role names (as Strings).

Parameters:
realm The Realm that owns this principal
name The username of the user represented by this Principal
password Credentials used to authenticate this user
roles List of roles (must be Strings) possessed by this user
 
     public GenericPrincipal(Realm realmString nameString password,
                             List<Stringroles) {
         this(realmnamepasswordrolesnull);
     }

    
Construct a new Principal, associated with the specified Realm, for the specified username and password, with the specified role names (as Strings).

Parameters:
realm The Realm that owns this principal
name The username of the user represented by this Principal
password Credentials used to authenticate this user
roles List of roles (must be Strings) possessed by this user
userPrincipal - the principal to be returned from the request getUserPrincipal call if not null; if null, this will be returned
 
     public GenericPrincipal(Realm realmString nameString password,
                             List<StringrolesPrincipal userPrincipal) {
         this(realmnamepasswordrolesuserPrincipalnull);
     }
    
    
Construct a new Principal, associated with the specified Realm, for the specified username and password, with the specified role names (as Strings).

Parameters:
realm The Realm that owns this principal
name The username of the user represented by this Principal
password Credentials used to authenticate this user
roles List of roles (must be Strings) possessed by this user
userPrincipal - the principal to be returned from the request getUserPrincipal call if not null; if null, this will be returned
loginContext - If provided, this will be used to log out the user at the appropriate time
    public GenericPrincipal(Realm realmString nameString password,
                            List<StringrolesPrincipal userPrincipal,
                            LoginContext loginContext) {
        super();
        this. = realm;
        this. = name;
        this. = password;
        this. = userPrincipal;
        if (roles != null) {
            this. = new String[roles.size()];
            this. = (String[]) roles.toArray(this.);
            if (this..length > 0)
                Arrays.sort(this.);
        }
        this. = loginContext;
    }
    // ------------------------------------------------------------- Properties


    
The username of the user represented by this Principal.
    protected String name = null;
    public String getName() {
        return (this.);
    }


    
The authentication credentials for the user represented by this Principal.
    protected String password = null;
    public String getPassword() {
        return (this.);
    }


    
The Realm with which this Principal is associated.
    protected Realm realm = null;
    public Realm getRealm() {
        return (this.);
    }
    void setRealmRealm realm ) {
        this.=realm;
    }


    
The set of roles associated with this user.
    protected String roles[] = new String[0];
    public String[] getRoles() {
        return (this.);
    }


    
The authenticated Principal to be exposed to applications.
    protected Principal userPrincipal = null;
    public Principal getUserPrincipal() {
        if ( != null) {
            return ;
        } else {
            return this;
        }
    }


    
The JAAS LoginContext, if any, used to authenticate this Principal. Kept so we can call logout().
    protected LoginContext loginContext = null;
    // --------------------------------------------------------- Public Methods


    
Does the user represented by this Principal possess the specified role?

Parameters:
role Role to be tested
    public boolean hasRole(String role) {
        if("*".equals(role)) // Special 2.4 role meaning everyone
            return true;
        if (role == null)
            return (false);
        return (Arrays.binarySearch(role) >= 0);
    }


    
Calls logout, if necessary, on any associated JAASLoginContext. May in the future be extended to cover other logout requirements.

Throws:
java.lang.Exception If something goes wrong with the logout. Uses Exception to allow for future expansion of this method to cover other logout mechanisms that might throw a different exception to LoginContext
    public void logout() throws Exception {
        if ( != null) {
            .logout();
        }
    }


    
Return a String representation of this object, which exposes only information that should be public.
    public String toString() {
        StringBuilder sb = new StringBuilder("GenericPrincipal[");
        sb.append(this.);
        sb.append("(");
        forint i=0;i<.i++ ) {
            sb.append[i]).append(",");
        }
        sb.append(")]");
        return (sb.toString());
    }
New to GrepCode? Check out our FAQ X