AuthenticationHandler


1   /*
2    * The contents of this file are subject to the terms 
3    * of the Common Development and Distribution License 
4    * (the License).  You may not use this file except in
5    * compliance with the License.
6    * 
7    * You can obtain a copy of the license at 
8    * https://glassfish.dev.java.net/public/CDDLv1.0.html or
9    * glassfish/bootstrap/legal/CDDLv1.0.txt.
10   * See the License for the specific language governing 
11   * permissions and limitations under the License.
12   * 
13   * When distributing Covered Code, include this CDDL 
14   * Header Notice in each file and include the License file 
15   * at glassfish/bootstrap/legal/CDDLv1.0.txt.  
16   * If applicable, add the following below the CDDL Header, 
17   * with the fields enclosed by brackets [] replaced by
18   * you own identifying information: 
19   * "Portions Copyrighted [year] [name of copyright owner]"
20   * 
21   * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
22   */
23  package com.sun.enterprise.security.auth.realm;
24  
25  import java.security.Principal  ;
26  import com.sun.enterprise.security.auth.*;
27  
28  /**
29   * This interface is used by the Authentication Service to have the 
30   * Principal authenticated by the realm. A realm provides an 
31   * implementation of this interface.
32   * @author Harish Prabandham
33   * @author Harpreet Singh
34   */
35  public interface AuthenticationHandler {
36      /**
37       * Returns the Realm that this Authentication Handler is authenticating
38       * in.
39       * @return The Realm object in which this handler is authenticating in.
40       */
41      public Realm getRealm();
42  
43      /**
44       * This method authenticates the given principal using the specified 
45       * authentication data and the Principal's Credentials. The result of
46       * the authentication is returned back.
47       * @param The principal (user) being authenticated.
48       * @param The data needed for authentication.
49       * @return boolean denoting true for success and false for failure
50       * authentication.
51       */
52      public boolean doAuthentication(String   principalName,
53                      byte[] authData);
54  }
55
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags