Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

javax.security.auth.login

Class LoginContext

public class LoginContext
extends Object

Constructor Summary

LoginContext(String name)
LoginContext(String name, Subject subject)
LoginContext(String name, Subject subject, CallbackHandler cbHandler)
LoginContext(String name, Subject subject, CallbackHandler cbHandler, Configuration config)
LoginContext(String name, CallbackHandler cbHandler)

Method Summary

Subject
getSubject()
Returns the authenticated subject, or the parameter passed to one of the constructors.
void
login()
Logs a subject in, using all login modules configured for this application.
void
logout()
Logs a subject out, cleaning up any state that may be in memory.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

LoginContext

public LoginContext(String name)
            throws LoginException

LoginContext

public LoginContext(String name,
                    Subject subject)
            throws LoginException

LoginContext

public LoginContext(String name,
                    Subject subject,
                    CallbackHandler cbHandler)
            throws LoginException

LoginContext

public LoginContext(String name,
                    Subject subject,
                    CallbackHandler cbHandler,
                    Configuration config)
            throws LoginException
Since:
1.5

LoginContext

public LoginContext(String name,
                    CallbackHandler cbHandler)
            throws LoginException

Method Details

getSubject

public Subject getSubject()
Returns the authenticated subject, or the parameter passed to one of the constructors. null is returned if the previous login attempt failed and there was no subject provided.
Returns:
The subject, or null.

login

public void login()
            throws LoginException
Logs a subject in, using all login modules configured for this application. This method will call the LoginModule.login() method of each module configured for this application, stopping if a REQUISITE module fails or if a SUFFICIENT module succeeds. If the overall login attempt fails, a LoginException will be thrown.
Throws:
LoginException - If logging in fails.

logout

public void logout()
            throws LoginException
Logs a subject out, cleaning up any state that may be in memory.
Throws:
LoginException - If logging out fails.
LoginContext.java Copyright (C) 2004, 2006 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.

Overview Package Class Use Source Tree Index Deprecated About