Package org.wildfly.security.http.util.sso

Interface SingleSignOn

All Superinterfaces:

AutoCloseable, ImmutableSingleSignOn

All Known Implementing Classes:

DefaultSingleSignOn

public interface SingleSignOn
extends ImmutableSingleSignOn, AutoCloseable

A cached single sign-on entry.

Author:

Paul Ferraro

Method Summary

Modifier and Type	Method	Description
boolean	addParticipant(String applicationId, String sessionId, URI participant)	Adds a new participant to this single sign-on entry.
void	close()	Closes any resources associated with this single sign-on entry.
void	invalidate()	Invalidates this single sign-on entry.
Map.Entry<String,URI>	removeParticipant(String applicationId)	Removes the participant for the specified application from this single sign-on entry.
void	setIdentity(SecurityIdentity identity)	Associates a security identity with this single sign-on entry, only if no association exists.

Methods inherited from interface org.wildfly.security.http.util.sso.ImmutableSingleSignOn

getId, getIdentity, getMechanism, getName, getParticipants, isProgrammatic

Method Detail

setIdentity

void setIdentity(SecurityIdentity identity)

Associates a security identity with this single sign-on entry, only if no association exists.

Parameters:

identity - a security identity

addParticipant

boolean addParticipant(String applicationId,
                       String sessionId,
                       URI participant)

Adds a new participant to this single sign-on entry.

Parameters:

applicationId - the unique identifier of the application.

sessionId - the unique identifier of the user session.

participant - the authenticated request URI

Returns:

true, if this participant was added, false if this application is already associated with this single sign-on entry.

removeParticipant

Map.Entry<String,URI> removeParticipant(String applicationId)

Removes the participant for the specified application from this single sign-on entry.

Parameters:

applicationId - a unique application identifier

Returns:

a tuple containing the unique session identifier and authenticated request URI, or null if the specified application was not associated with this single sign-on entry

invalidate

void invalidate()

Invalidates this single sign-on entry.

close

void close()

Closes any resources associated with this single sign-on entry.

Specified by:

close in interface AutoCloseable