Field Detail

• messageNumber

  protected int messageNumber

Constructor Detail

• ClusterSingleSignOn

  public ClusterSingleSignOn()

Method Detail

• getCluster

  public CatalinaCluster getCluster()

• setCluster

  public void setCluster(CatalinaCluster cluster)

• startInternal

  protected void startInternal()
                        throws LifecycleException

  Start this component and implement the requirements of LifecycleBase.startInternal().

  Overrides:

  startInternal in class ValveBase

  Throws:

  LifecycleException - if this component detects a fatal error that prevents this component from being used

• stopInternal

  protected void stopInternal()
                       throws LifecycleException

  Stop this component and implement the requirements of LifecycleBase.stopInternal().

  Overrides:

  stopInternal in class ValveBase

  Throws:

  LifecycleException - if this component detects a fatal error that prevents this component from being used

• associate

  protected void associate(String ssoId,
               Session session)

  Notify the cluster of the addition of a Session to an SSO session and associate the specified single sign on identifier with the specified Session on the local node.

  Overrides:

  associate in class SingleSignOn

  Parameters:

  ssoId - Single sign on identifier

  session - Session to be associated

• associateLocal

  protected void associateLocal(String ssoId,
                    Session session)

• deregister

  protected void deregister(String ssoId,
                Session session)

  Notify the cluster of the removal of a Session from an SSO session and deregister the specified session. If it is the last session, then also get rid of the single sign on identifier on the local node.

  Overrides:

  deregister in class SingleSignOn

  Parameters:

  ssoId - Single sign on identifier

  session - Session to be deregistered

• deregisterLocal

  protected void deregisterLocal(String ssoId,
                     Session session)

• deregister

  protected void deregister(String ssoId)

  Notifies the cluster that a single sign on session has been terminated due to a user logout, deregister the specified single sign on identifier, and invalidate any associated sessions on the local node.

  Overrides:

  deregister in class SingleSignOn

  Parameters:

  ssoId - Single sign on identifier to deregister

• deregisterLocal

  protected void deregisterLocal(String ssoId)

• register

  protected void register(String ssoId,
              Principal principal,
              String authType,
              String username,
              String password)

  Notifies the cluster of the creation of a new SSO entry and 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

• registerLocal

  protected void registerLocal(String ssoId,
                   Principal principal,
                   String authType,
                   String username,
                   String password)

• update

  protected void update(String ssoId,
            Principal principal,
            String authType,
            String username,
            String password)

  Notifies the cluster of an update of the security credentials associated with an SSO session. Updates any SingleSignOnEntry found under key ssoId with the given authentication data.

  The purpose of this method is to allow an SSO entry that was established without a username/password combination (i.e. established following DIGEST or CLIENT-CERT authentication) to be updated with a username and password if one becomes available through a subsequent BASIC or FORM authentication. The SSO entry will then be usable for reauthentication.

  NOTE: Only updates the SSO entry if a call to SingleSignOnEntry.getCanReauthenticate() returns false; otherwise, it is assumed that the SSO entry already has sufficient information to allow reauthentication and that no update is needed.

  Overrides:

  update in class SingleSignOn

  Parameters:

  ssoId - identifier of Single sign to be updated

  principal - the Principal returned by the latest call to Realm.authenticate.

  authType - the type of authenticator used (BASIC, CLIENT-CERT, DIGEST or FORM)

  username - the username (if any) used for the authentication

  password - the password (if any) used for the authentication

• updateLocal

  protected void updateLocal(String ssoId,
                 Principal principal,
                 String authType,
                 String username,
                 String password)

• removeSession

  protected void removeSession(String ssoId,
                   Session session)

  Remove a single Session from a SingleSignOn and notify the cluster of the removal. Called when a session is timed out and no longer active.

  Overrides:

  removeSession in class SingleSignOn

  Parameters:

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

  session - the session to be removed.

• removeSessionLocal

  protected void removeSessionLocal(String ssoId,
                        Session session)