org.glassfish.web.ha.authenticator

Class HASingleSignOn

java.lang.Object

org.apache.catalina.valves.ValveBase

org.apache.catalina.authenticator.SingleSignOn

com.sun.enterprise.security.web.GlassFishSingleSignOn

org.glassfish.web.ha.authenticator.HASingleSignOn

All Implemented Interfaces:

SingleSignOnMBean, Runnable, Contained, Lifecycle, SessionListener, Valve, GlassFishValve

public class HASingleSignOn
extends GlassFishSingleSignOn

Author:

Shing Wai Chan

Field Summary

Fields inherited from class org.apache.catalina.authenticator.SingleSignOn

cache, info

Fields inherited from class org.apache.catalina.valves.ValveBase

container, controller, debug, domain, lifecycle, next, oname, started

Fields inherited from interface org.apache.catalina.Lifecycle

AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, INIT_EVENT, START_EVENT, STOP_EVENT

Fields inherited from interface org.glassfish.web.valve.GlassFishValve

END_PIPELINE, INVOKE_NEXT

Constructor Summary

Constructors

Constructor and Description
HASingleSignOn(JavaEEIOUtils ioUtils, org.glassfish.ha.store.api.BackingStore<String,HASingleSignOnEntryMetadata> ssoEntryMetadataBackingStore)

Method Summary

Modifier and Type	Method and Description
void	associate(String ssoId, long ssoVersion, Session session) Associate the specified single sign on identifier with the specified Session.
protected void	deregister(String ssoId) Deregister the specified single sign on identifier, and invalidate any associated sessions.
boolean	isVersioningSupported() Return a boolean to indicate whether the sso id version is supported or not.
protected SingleSignOnEntry	lookup(String ssoId, long ssoVersion) Look up and return the cached SingleSignOn entry associated with this sso id value, if there is one; otherwise return null.
protected void	register(String ssoId, Principal principal, String authType, String username, char[] password, String realmName) Register the specified Principal as being associated with the specified value for the single sign on identifier.
protected void	removeSession(String ssoId, Session session) Remove a single Session from a SingleSignOn.

Methods inherited from class com.sun.enterprise.security.web.GlassFishSingleSignOn

getActiveSessionCount, getHitCount, getMaxInactive, getMissCount, getReapInterval, invoke, run, sessionEvent, setMaxInactive, setReapInterval, start, stop

Methods inherited from class org.apache.catalina.authenticator.SingleSignOn

deregister, getDebug, getInfo, log, log, lookup, setDebug, toString

Methods inherited from class org.apache.catalina.valves.ValveBase

addLifecycleListener, backgroundProcess, createObjectName, event, findLifecycleListeners, getContainer, getController, getDomain, getNext, getObjectName, getParentName, invoke, isStarted, postInvoke, removeLifecycleListener, setContainer, setController, setNext, setObjectName

Methods inherited from class java.lang.Object

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

Constructor Detail

HASingleSignOn

public HASingleSignOn(JavaEEIOUtils ioUtils,
                      org.glassfish.ha.store.api.BackingStore<String,HASingleSignOnEntryMetadata> ssoEntryMetadataBackingStore)

Method Detail

deregister

protected void deregister(String ssoId)

Description copied from class: GlassFishSingleSignOn

Deregister the specified single sign on identifier, and invalidate any associated sessions.

Overrides:

deregister in class GlassFishSingleSignOn

Parameters:

ssoId - Single sign on identifier to deregister

register

protected void register(String ssoId,
                        Principal principal,
                        String authType,
                        String username,
                        char[] password,
                        String realmName)

Description copied from class: SingleSignOn

Register the specified Principal as being associated with the specified value for the single sign on identifier.

Overrides:

register in class SingleSignOn

Parameters:

ssoId - Single sign on identifier to register

principal - Associated user principal that is identified

authType - Authentication type used to authenticate this user principal

username - Username used to authenticate this user

password - Password used to authenticate this user

associate

public void associate(String ssoId,
                      long ssoVersion,
                      Session session)

Description copied from class: SingleSignOn

Associate the specified single sign on identifier with the specified Session.

Overrides:

associate in class SingleSignOn

Parameters:

ssoId - Single sign on identifier

ssoVersion - Single sign on version

session - Session to be associated

lookup

protected SingleSignOnEntry lookup(String ssoId,
                                   long ssoVersion)

Description copied from class: SingleSignOn

Look up and return the cached SingleSignOn entry associated with this sso id value, if there is one; otherwise return null.

Overrides:

lookup in class SingleSignOn

Parameters:

ssoId - Single sign on identifier to look up

ssoVersion - Single sign on version to look up

removeSession

protected void removeSession(String ssoId,
                             Session session)

Description copied from class: GlassFishSingleSignOn

Remove a single Session from a SingleSignOn. Called when a session is timed out and no longer active.

Overrides:

removeSession in class GlassFishSingleSignOn

Parameters:

ssoId - Single sign on identifier from which to remove the session.

session - the session to be removed.

isVersioningSupported

public boolean isVersioningSupported()

Description copied from class: SingleSignOn

Return a boolean to indicate whether the sso id version is supported or not.

Overrides:

isVersioningSupported in class SingleSignOn