com.goldencode.p2j.security

Class SampleSsoAuthenticator

java.lang.Object

com.goldencode.p2j.security.SampleSsoAuthenticator

All Implemented Interfaces:

SsoAuthenticator

public class SampleSsoAuthenticator
extends java.lang.Object
implements SsoAuthenticator

Sample implementation of the standard SSO authenticator hook. Uses mostly hard-coded values.

Nested Class Summary

Nested classes/interfaces inherited from interface com.goldencode.p2j.security.SsoAuthenticator

SsoAuthenticator.LicensingData, SsoAuthenticator.Result

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	defaultFwdUser The FWD user returned by default for all in-app users.
private static java.lang.String	SAMPLE_AUTH_BLOB Example value for SESSION:AUTH-BLOB.
private static java.lang.String	SAMPLE_COOKIE_INVALID_VALUE Cookie invalid value used to invalidate the cookie.
private static java.lang.String	SAMPLE_COOKIE_NAME Cookie name used for auto-login.
private static java.lang.String	SAMPLE_COOKIE_PATH Path for the auth cookie.

Fields inherited from interface com.goldencode.p2j.security.SsoAuthenticator

FWD_SDK_LOGIN_PARAM_PASS, FWD_SDK_LOGIN_PARAM_USER

Constructor Summary

Constructors

Constructor and Description
SampleSsoAuthenticator()

Method Summary

Modifier and Type	Method and Description
SsoAuthenticator.Result	authenticate(javax.servlet.http.Cookie[] cookies, SsoAuthenticator.LicensingData licensingData) Simulates authentication by cookie.
SsoAuthenticator.Result	authenticate(java.util.Map<java.lang.String,java.lang.String[]> paramMap, javax.servlet.http.Cookie[] cookies, SsoAuthenticator.LicensingData licensingData) First attempts aut-login by validating only the cookies.
java.lang.String	getAuthCookieName() Returns the hard-coded cookie name used for authentication.
java.lang.String	getLoginPage(java.lang.String loadedTemplate) Returns null.
javax.servlet.http.Cookie	logout(javax.servlet.http.Cookie[] cookies) Invalidates the web session associated with the authentication cookie by communicating with the auth server or updating the DB and returns a cookie with the same name, but invalid value.
void	setOption(java.lang.String option) Sets the default FWD user.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.goldencode.p2j.security.SsoAuthenticator

initialize, terminate

Field Detail

SAMPLE_COOKIE_NAME

private static final java.lang.String SAMPLE_COOKIE_NAME

Cookie name used for auto-login.

See Also:

Constant Field Values

SAMPLE_COOKIE_INVALID_VALUE

private static final java.lang.String SAMPLE_COOKIE_INVALID_VALUE

Cookie invalid value used to invalidate the cookie.

See Also:

Constant Field Values

SAMPLE_COOKIE_PATH

private static final java.lang.String SAMPLE_COOKIE_PATH

Path for the auth cookie.

See Also:

Constant Field Values

SAMPLE_AUTH_BLOB

private static final java.lang.String SAMPLE_AUTH_BLOB

Example value for SESSION:AUTH-BLOB.

See Also:

Constant Field Values

defaultFwdUser

private java.lang.String defaultFwdUser

The FWD user returned by default for all in-app users.

Constructor Detail

SampleSsoAuthenticator

public SampleSsoAuthenticator()

Method Detail

authenticate

public SsoAuthenticator.Result authenticate(java.util.Map<java.lang.String,java.lang.String[]> paramMap,
                                            javax.servlet.http.Cookie[] cookies,
                                            SsoAuthenticator.LicensingData licensingData)

First attempts aut-login by validating only the cookies. If auth by cookie fails, simulates successful response by setting the hard-coded values in the result.

Specified by:

authenticate in interface SsoAuthenticator

Parameters:

paramMap - A map of all query / form params.

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

licensingData - Data that can be used for enforcing licensing policy.

Returns:

A container with all details needed by the FWD framework to spawn a new client.

logout

public javax.servlet.http.Cookie logout(javax.servlet.http.Cookie[] cookies)

Invalidates the web session associated with the authentication cookie by communicating with the auth server or updating the DB and returns a cookie with the same name, but invalid value.

Specified by:

logout in interface SsoAuthenticator

Parameters:

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

Returns:

null if the web session / cookie invalidation failed, otherwise an authentication Cookie with invalid value.

authenticate

public SsoAuthenticator.Result authenticate(javax.servlet.http.Cookie[] cookies,
                                            SsoAuthenticator.LicensingData licensingData)

Simulates authentication by cookie.

Specified by:

authenticate in interface SsoAuthenticator

Parameters:

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

licensingData - Data that can be used for enforcing licensing policy.

Returns:

A container with all details needed by the FWD framework to spawn a new client.

getAuthCookieName

public java.lang.String getAuthCookieName()

Returns the hard-coded cookie name used for authentication.

Specified by:

getAuthCookieName in interface SsoAuthenticator

Returns:

The name of the cookie used for authentication.

setOption

public void setOption(java.lang.String option)

Sets the default FWD user.

Specified by:

setOption in interface SsoAuthenticator

Parameters:

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

getLoginPage

public java.lang.String getLoginPage(java.lang.String loadedTemplate)

Returns null. The default template will be used.

Specified by:

getLoginPage in interface SsoAuthenticator

Parameters:

loadedTemplate - The html template loaded from the standard location in the custom root package or null.

Returns:

null.