Package com.inet.authentication

Class RemoteLoginProcessor

java.lang.Object

com.inet.authentication.LoginProcessor

com.inet.authentication.RemoteLoginProcessor

public abstract class RemoteLoginProcessor
extends LoginProcessor

A WebUserInfo which requests authorization data from an external source (outside of the Java VM).

Since:

inetcore 1.1

Field Summary

Fields inherited from class com.inet.authentication.LoginProcessor

GUEST_LOGIN_SOURCE, LOGGER, MASTER_LOGIN_HIDDEN, MASTER_LOGIN_ID, MASTER_LOGIN_SOURCE, SYSTEM_LOGIN_SOURCE, TEMP_LOGIN_SOURCE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RemoteLoginProcessor(AuthenticationDescription description)	Create a new LoginProcessor

Method Summary

Modifier and Type	Method	Description
boolean	isMasterPassword()	Whether this is a master password check or not
abstract void	requestLoginData(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)	Request the data for a login of a client - the data sent to the response object can be form data or an HTTP status 401, depending on the scenario.
boolean	supportsFormLogin()	If the authentication provider supports form authentication.
abstract boolean	transferClientLoginData(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)	Send the login answer of the client (browser) to a login script or external library.
boolean	transferFormLoginData(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)	Set the answer of a form authorization.

Methods inherited from class com.inet.authentication.LoginProcessor

createLoginSettings, createNewUserData, destroyCurrent, getAuthenticationDescription, getCurrent, getLoginID, getLoginSource, getOrCreateUserAccount, getUserAccountID, getUserAccountType, isCreateUserAccountSupported, isCreationBlocked, isNewUser, isSameAccount, isWebUserInRole, setCurrent, setCurrent, setCurrentForAllThreads, supportsRoles, unwrap

Methods inherited from class java.lang.Object

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

Constructor Details

RemoteLoginProcessor

protected RemoteLoginProcessor(AuthenticationDescription description)

Create a new LoginProcessor

Parameters:

description - the AuthenticationDescription for creating this login processor

Since:

inetcore 4.0

Method Details

requestLoginData

public abstract void requestLoginData(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)

Request the data for a login of a client - the data sent to the response object can be form data or an HTTP status 401, depending on the scenario.

Parameters:

request - the current HTTP request object to read from

response - the current HTTP response object to write to

Since:

inetcore 1.1

transferClientLoginData

public abstract boolean transferClientLoginData(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)

Send the login answer of the client (browser) to a login script or external library. This is only called if an Authorization HTTP header exists. If possible this should not request a 401.

Parameters:

request - the current HTTP request object to read from

response - the current HTTP response object to write to

Returns:

true, if everything checks out and the caller can continue. false if an answer was sent to the client (browser) and the stream was closed.

Since:

inetcore 1.1

transferFormLoginData

public boolean transferFormLoginData(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)

Set the answer of a form authorization.

Parameters:

request - the current HTTP request object to read from

response - the current HTTP response object to write to

Returns:

true, if everything checks out and the caller can continue (redirect to the original page). false if an answer was already sent to the client (browser) and the stream was closed.

Throws:

IllegalStateException - if not override

Since:

inetcore 1.1

supportsFormLogin

public boolean supportsFormLogin()

If the authentication provider supports form authentication.

Returns:

true, if transferFormLoginData is implemented

Since:

inetcore 2.3

isMasterPassword

public boolean isMasterPassword()

Whether this is a master password check or not

Returns:

true if master password

Since:

inetcore 1.1