Eclipse Platform
Release 3.4

org.eclipse.equinox.security.auth
Class LoginContextFactory

java.lang.Object
  extended byorg.eclipse.equinox.security.auth.LoginContextFactory

public final class LoginContextFactory
extends Object

The LoginContextFactory class is the entry point for the login support for the platform. Use it to create login contexts.

This class is not intended to be instantiated or extended by clients.

Restriction
This class is not intended to be subclassed by clients.
Restriction
This class is not intended to be instantiated by clients.

Constructor Summary
LoginContextFactory()
           
 
Method Summary
static ILoginContext createContext(String configName)
          Creates application-specific security context.
static ILoginContext createContext(String configName, URL configFile)
          Creates application-specific security context.
static ILoginContext createContext(String configName, URL configFile, CallbackHandler handler)
          Creates application-specific security context.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LoginContextFactory

public LoginContextFactory()
Method Detail

createContext

public static ILoginContext createContext(String configName,
                                          URL configFile)
Creates application-specific security context. The security context then can be used to perform login, logout, and obtain Subject information.

Due to the way default Java Configuration is initialized, this context should be created first. If standard JAAS files are used with the standard configuration, the initialization will fail unless this context created first, prior to any calls to createContext(String).

Parameters:
configName - the name of login configuration to use
configFile - points to the standard JASS configuration file
Returns:
new security context

createContext

public static ILoginContext createContext(String configName,
                                          URL configFile,
                                          CallbackHandler handler)
Creates application-specific security context. The security context then can be used to perform login, logout, and obtain Subject information.

Due to the way default Java Configuration is initialized, this context should be created first. If standard JAAS files are used with the standard configuration, the initialization will fail unless this context created first, prior to any calls to createContext(String).

Parameters:
configName - the name of login configuration to use
configFile - points to the standard JASS configuration file
handler - optional callback handler, might be null
Returns:
new security context

createContext

public static ILoginContext createContext(String configName)
Creates application-specific security context. The security context then can be used to perform login, logout, and obtain Subject information.

Parameters:
configName - the name of login configuration to use
Returns:
new security context

Eclipse Platform
Release 3.4

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.