Package org.nuxeo.runtime.api.login

Class NuxeoLoginContext

java.lang.Object

javax.security.auth.login.LoginContext

org.nuxeo.runtime.api.login.NuxeoLoginContext

All Implemented Interfaces:

AutoCloseable

public class NuxeoLoginContext
extends LoginContext
implements AutoCloseable

An implementation of LoginContext just holding a principal.

Construction is done through the static create(java.security.Principal) method, which takes a Principal. The caller must push the principal on the Nuxeo principal stack using login(), and finally do logout() or close() to remove it.

This is used for compatibility with previous code that expected to receive a LoginContext and then call logout() on it.

Since:

11.1

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	loggedIn
protected Principal	principal
protected Subject	subject

Constructor Summary

Constructors

Constructor	Description
NuxeoLoginContext()	This constructor cannot be used, use the static method create(java.security.Principal) instead.

Method Summary

Modifier and Type	Method	Description
void	close()
static NuxeoLoginContext	create(Principal principal)	Creates a NuxeoLoginContext for the given principal.
Subject	getSubject()
void	login()
void	logout()
protected void	setPrincipal(Principal principal)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

principal

protected Principal principal

subject

protected Subject subject

loggedIn

protected boolean loggedIn

Constructor Details

NuxeoLoginContext

public NuxeoLoginContext()
                  throws LoginException

This constructor cannot be used, use the static method create(java.security.Principal) instead.

Throws:

LoginException

Method Details

create

public static NuxeoLoginContext create(Principal principal)

Creates a NuxeoLoginContext for the given principal.

Parameters:

principal - the principal

Returns:

the login context

setPrincipal

protected void setPrincipal(Principal principal)

getSubject

public Subject getSubject()

Overrides:

getSubject in class LoginContext

login

public void login()

Overrides:

login in class LoginContext

logout

public void logout()

Overrides:

logout in class LoginContext

close

public void close()

Specified by:

close in interface AutoCloseable