com.goldencode.p2j.security

Class SsoAuthenticator.Result

java.lang.Object

com.goldencode.p2j.security.SsoAuthenticator.Result

Enclosing interface:

SsoAuthenticator

public static class SsoAuthenticator.Result
extends java.lang.Object

Wrapper class for all properties needed by the FWD framework to respond to the auth / spawn request

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	authBlob A blob of data used by the converted application for authorization.
private javax.servlet.http.Cookie	cookie The cookie to be returned to the browser and used in the next auth requests.
private WebDriverHandler.SupportedHttpCode	failureHttpCode HTTP code for a failed.
private java.lang.String	fwdUser The name of the FWD account defined in directory that corresponds to the authorization privileges of the authenticated in-app user.
private boolean	isSuccess Flag to indicate if the authentication is successful.
private java.lang.String	persistentUserStorageIdentifier The identifier of the persistent client storage used by the authenticated user.
private java.lang.String	sessionDescription Free form description of the session.
private java.lang.String	translatedErrorMessage Translated error message.

Constructor Summary

Constructors

Constructor and Description
Result(boolean isSuccess, java.lang.String fwdUser, java.lang.String persistentUserStorageIdentifier, java.lang.String authBlob, javax.servlet.http.Cookie cookie) Public constructor to set all fields of this immutable wrapper.
Result(boolean isSuccess, WebDriverHandler.SupportedHttpCode failureHttpCode, java.lang.String translatedErrorMessage) Public constructor to set all fields of this immutable wrapper.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAuthBlob() Getter for authBlob.
javax.servlet.http.Cookie	getCookie() Getter for cookie.
WebDriverHandler.SupportedHttpCode	getFailureHttpCode() Getter for failureHttpCode.
java.lang.String	getFwdUser() Getter for fwdUser.
java.lang.String	getPersistentUserStorageIdentifier() Getter for persistentUserStorageIdentifier.
java.lang.String	getSessionDescription() Getter for sessionDescription.
java.lang.String	getTranslatedErrorMessage() Getter for translatedErrorMessage.
boolean	isSuccess() Getter for isSuccess.
void	setSessionDescription(java.lang.String sessionDescription) Setter for sessionDescription.

Methods inherited from class java.lang.Object

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

Field Detail

isSuccess

private final boolean isSuccess

Flag to indicate if the authentication is successful.

failureHttpCode

private WebDriverHandler.SupportedHttpCode failureHttpCode

HTTP code for a failed.

fwdUser

private java.lang.String fwdUser

The name of the FWD account defined in directory that corresponds to the authorization privileges of the authenticated in-app user.

persistentUserStorageIdentifier

private java.lang.String persistentUserStorageIdentifier

The identifier of the persistent client storage used by the authenticated user. This storage should have a unique identifier to allow multiple end users (or app accounts) authenticated on the same browser to have separate browser configurations and registry values. The identifier can be the in-app username or ID, but it should not change. Otherwise the stored data will be lost. All identifiers will be visible to the users in the browser dev tools.

authBlob

private java.lang.String authBlob

A blob of data used by the converted application for authorization. Will be available for 4GL apps under SESSION:AUTH-BLOB .

cookie

private javax.servlet.http.Cookie cookie

The cookie to be returned to the browser and used in the next auth requests.

translatedErrorMessage

private java.lang.String translatedErrorMessage

Translated error message. Optional. The FWD default is about invalid credentials.

sessionDescription

private java.lang.String sessionDescription

Free form description of the session. Shows up in the Admin Console in 'Current Network Sessions' table. Can be used as a way to correlate sessions to in-app users.

Constructor Detail

Result

public Result(boolean isSuccess,
              WebDriverHandler.SupportedHttpCode failureHttpCode,
              java.lang.String translatedErrorMessage)

Public constructor to set all fields of this immutable wrapper.

Parameters:

isSuccess - Flag to indicate if the authentication is successful.

failureHttpCode - Authentication failure HTTP code.

translatedErrorMessage - The message to be shown on the client UI. If none, the default one associated with the http status is used.

Result

public Result(boolean isSuccess,
              java.lang.String fwdUser,
              java.lang.String persistentUserStorageIdentifier,
              java.lang.String authBlob,
              javax.servlet.http.Cookie cookie)

Public constructor to set all fields of this immutable wrapper.

Parameters:

isSuccess - Flag to indicate if the authentication is successful.

fwdUser - The name of the FWD account defined in directory.

persistentUserStorageIdentifier - The identifier of the persistent client storage used by the authenticated user.

authBlob - All cookies coming with the HTTP request for authentication.

cookie - A blob of data used by the converted application for authorization.

Method Detail

isSuccess

public boolean isSuccess()

Getter for isSuccess.

Returns:

See above.

getFailureHttpCode

public WebDriverHandler.SupportedHttpCode getFailureHttpCode()

Getter for failureHttpCode.

Returns:

See above.

getFwdUser

public java.lang.String getFwdUser()

Getter for fwdUser.

Returns:

See above.

getPersistentUserStorageIdentifier

public java.lang.String getPersistentUserStorageIdentifier()

Getter for persistentUserStorageIdentifier.

Returns:

See above.

getCookie

public javax.servlet.http.Cookie getCookie()

Getter for cookie.

Returns:

See above.

getAuthBlob

public java.lang.String getAuthBlob()

Getter for authBlob.

Returns:

See above.

getTranslatedErrorMessage

public java.lang.String getTranslatedErrorMessage()

Getter for translatedErrorMessage.

Returns:

See above.

getSessionDescription

public java.lang.String getSessionDescription()

Getter for sessionDescription.

Returns:

See above.

setSessionDescription

public void setSessionDescription(java.lang.String sessionDescription)

Setter for sessionDescription.

Parameters:

sessionDescription - See sessionDescription.