Package com.sun.identity.authentication.internal

Class AuthSSOProvider

java.lang.Object

com.sun.identity.authentication.internal.AuthSSOProvider

All Implemented Interfaces:

SSOProvider

public class AuthSSOProvider
extends Object
implements SSOProvider

Constructor Summary

Constructors

Constructor	Description
AuthSSOProvider()

Method Summary

Modifier and Type	Method	Description
SSOToken	createSSOToken(jakarta.servlet.http.HttpServletRequest request)	Creates an SSOToken.
SSOToken	createSSOToken(String tokenID)	Creates an SSOToken.
SSOToken	createSSOToken(String tokenId, boolean invokedByAuth, boolean possiblyResetIdleTime)	Creates an SSOToken.
SSOToken	createSSOToken(String tokenID, String clientIP)	Creates an SSOToken.
SSOToken	createSSOToken(Principal user, String password)	Creates an SSOToken.
void	destroyToken(SSOToken token)	Destroys an SSOToken.
void	destroyToken(SSOToken destroyer, SSOToken destroyed)	Destroys an SSOToken.
Set<SSOToken>	getValidSessions(SSOToken requester, String server)	Returns valid Sessions.
boolean	isValidToken(SSOToken token)	Checks if an SSOToken is valid or not.
boolean	isValidToken(SSOToken token, boolean ignored)	This class ignores the "refresh" parameter, which is just not needed here.
void	logout(SSOToken token)	Logs out of the session underlying this SSOToken.
void	refreshSession(SSOToken token)	Refresh the Session corresponding to the SSOToken from the Session Server, always resetting the idle time.
void	refreshSession(SSOToken token, boolean resetIdleTime)	Refresh the Session corresponding to the SSOToken from the Session Server, but only optionally resetting the idle time.
void	validateToken(SSOToken token)	Checks if the SSOToken is valid.

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthSSOProvider

public AuthSSOProvider()

Method Detail

createSSOToken

public SSOToken createSSOToken(jakarta.servlet.http.HttpServletRequest request)
                        throws SSOException,
                               UnsupportedOperationException

Description copied from interface: SSOProvider

Creates an SSOToken.

Specified by:

createSSOToken in interface SSOProvider

Parameters:

request - HttpServletRequest

Returns:

SSOToken

Throws:

SSOException - is thrown if the SSOToken can't be created.

UnsupportedOperationException

createSSOToken

public SSOToken createSSOToken(Principal user,
                               String password)
                        throws SSOException,
                               UnsupportedOperationException

Description copied from interface: SSOProvider

Creates an SSOToken.

Specified by:

createSSOToken in interface SSOProvider

Parameters:

user - Principal representing a user or service

password - LDAP password of the user or service

Returns:

SSOToken

Throws:

SSOException - is thrown if the SSOToken can't be created.

UnsupportedOperationException - is thrown when other errors occur during the token creation.

createSSOToken

public SSOToken createSSOToken(String tokenID)
                        throws SSOException,
                               UnsupportedOperationException

Description copied from interface: SSOProvider

Creates an SSOToken.

Specified by:

createSSOToken in interface SSOProvider

Parameters:

tokenID - String representing the SSOToken Id

Returns:

SSOToken

Throws:

SSOException - is thrown if the SSOToken can't be created.

UnsupportedOperationException - is thrown when other unsupported operation is performed.

createSSOToken

public SSOToken createSSOToken(String tokenId,
                               boolean invokedByAuth,
                               boolean possiblyResetIdleTime)
                        throws SSOException,
                               UnsupportedOperationException

Description copied from interface: SSOProvider

Creates an SSOToken.

Specified by:

createSSOToken in interface SSOProvider

Parameters:

tokenId - String representing the SSOToken Id

invokedByAuth - boolean flag indicating that this method has been invoked by the AuthContext.getSSOToken() API.

possiblyResetIdleTime - If true, the idle time of the token/session may be reset to zero. If false, the idle time will never be reset.

Returns:

SSOToken

Throws:

SSOException - is thrown if the SSOToken can't be created.

UnsupportedOperationException - is thrown when other unsupported operation is performed.

createSSOToken

public SSOToken createSSOToken(String tokenID,
                               String clientIP)
                        throws SSOException,
                               UnsupportedOperationException

Description copied from interface: SSOProvider

Creates an SSOToken.

Specified by:

createSSOToken in interface SSOProvider

Parameters:

tokenID - representing the SSOToken Id

clientIP - representing the IP address of the client

Returns:

SSOToken

Throws:

SSOException - is thrown if the SSOToken can't be created.

UnsupportedOperationException

destroyToken

public void destroyToken(SSOToken token)
                  throws SSOException

Description copied from interface: SSOProvider

Destroys an SSOToken.

Specified by:

destroyToken in interface SSOProvider

Parameters:

token - The SSOToken object to be destroyed

Throws:

SSOException - is thrown if the SSOToken can't be destroyed.

logout

public void logout(SSOToken token)
            throws SSOException

Description copied from interface: SSOProvider

Logs out of the session underlying this SSOToken.

Specified by:

logout in interface SSOProvider

Parameters:

token - the sso token to log out.

Throws:

SSOException - if an error occurs during logout.

isValidToken

public boolean isValidToken(SSOToken token)

Description copied from interface: SSOProvider

Checks if an SSOToken is valid or not. Your token may be refreshed.

Specified by:

isValidToken in interface SSOProvider

Parameters:

token - The SSOToken object to be validated.

Returns:

true or false, true if the token is valid

isValidToken

public boolean isValidToken(SSOToken token,
                            boolean ignored)

This class ignores the "refresh" parameter, which is just not needed here.

Specified by:

isValidToken in interface SSOProvider

Parameters:

token - The SSOToken object to be validated.

ignored - The refresh parameter, which is completely ignored.

Returns:

true if the token is valid, false otherwise.

validateToken

public void validateToken(SSOToken token)
                   throws SSOException

Description copied from interface: SSOProvider

Checks if the SSOToken is valid.

Specified by:

validateToken in interface SSOProvider

Throws:

SSOException - is thrown if the SSOToken is not valid.

refreshSession

public void refreshSession(SSOToken token)
                    throws SSOException,
                           UnsupportedOperationException

Description copied from interface: SSOProvider

Refresh the Session corresponding to the SSOToken from the Session Server, always resetting the idle time.

Specified by:

refreshSession in interface SSOProvider

Parameters:

token - SSOToken

Throws:

SSOException - thrown if the session cannot be refreshed for the token

UnsupportedOperationException

refreshSession

public void refreshSession(SSOToken token,
                           boolean resetIdleTime)
                    throws SSOException,
                           UnsupportedOperationException

Description copied from interface: SSOProvider

Refresh the Session corresponding to the SSOToken from the Session Server, but only optionally resetting the idle time.

Specified by:

refreshSession in interface SSOProvider

Parameters:

token - SSOToken

resetIdleTime - if true, reset the idle time to zero, if false, do not do this.

Throws:

SSOException - thrown if the session cannot be refreshed for the token

UnsupportedOperationException

destroyToken

public void destroyToken(SSOToken destroyer,
                         SSOToken destroyed)
                  throws SSOException

Description copied from interface: SSOProvider

Destroys an SSOToken.

Specified by:

destroyToken in interface SSOProvider

Parameters:

destroyer - The SSOToken object used to authorize the operation

destroyed - The SSOToken object to be destroyed.

Throws:

SSOException - thrown if the there was an error during communication with session service.

getValidSessions

public Set<SSOToken> getValidSessions(SSOToken requester,
                                      String server)
                               throws SSOException

Description copied from interface: SSOProvider

Returns valid Sessions.

Specified by:

getValidSessions in interface SSOProvider

Parameters:

requester - The SSOToken object used to authorize the operation

server - The server for which the valid sessions are to be retrieved

Returns:

Set The set of Valid Sessions

Throws:

SSOException - thrown if the there was an error during communication with session service.