org.picketlink.identity.federation.web.core

Interface IdentityParticipantStack

All Known Implementing Classes:

IdentityServer.STACK

public interface IdentityParticipantStack

A stack to register and deregister participants in the identity federation

Since:

Feb 25, 2011

Author:

Anil.Saldhana@redhat.com

Method Summary

Modifier and Type	Method and Description
void	createSession(String id) Create a session
boolean	deRegisterTransitParticipant(String sessionID, String participant) Deregister a participant as in transit in a logout interaction
Boolean	getBinding(String participant) For a particular participant, indicate whether it supports POST or REDIRECT binding.
int	getNumOfParticipantsInTransit(String sessionID) Return the number of participants in transit
int	getParticipants(String sessionID) For a given identity session, return the number of participants
String	peek(String sessionID) Peek at the most recent participant in the session
String	pop(String sessionID) Remove the most recent participant in the session
void	register(String sessionID, String participant, boolean postBinding) Register a participant in a session
boolean	registerTransitParticipant(String sessionID, String participant) Register a participant as in transit in a logout interaction
void	removeSession(String id) Remove a session
int	totalSessions() The total number of sessions active

Method Detail

peek

String peek(String sessionID)

Peek at the most recent participant in the session

Parameters:

sessionID -

Returns:

pop

String pop(String sessionID)

Remove the most recent participant in the session

Parameters:

sessionID -

Returns:

register

void register(String sessionID,
              String participant,
              boolean postBinding)

Register a participant in a session

Parameters:

sessionID -

participant -

getParticipants

int getParticipants(String sessionID)

For a given identity session, return the number of participants

Parameters:

sessionID -

Returns:

registerTransitParticipant

boolean registerTransitParticipant(String sessionID,
                                   String participant)

Register a participant as in transit in a logout interaction

Parameters:

sessionID -

participant -

Returns:

deRegisterTransitParticipant

boolean deRegisterTransitParticipant(String sessionID,
                                     String participant)

Deregister a participant as in transit in a logout interaction

Parameters:

sessionID -

participant -

Returns:

getNumOfParticipantsInTransit

int getNumOfParticipantsInTransit(String sessionID)

Return the number of participants in transit

Parameters:

sessionID -

Returns:

getBinding

Boolean getBinding(String participant)

For a particular participant, indicate whether it supports POST or REDIRECT binding.

NOTE: true: POST, false: REDIRECT, null: does not exist

Parameters:

participant -

Returns:

totalSessions

int totalSessions()

The total number of sessions active

Returns:

createSession

void createSession(String id)

Create a session

Parameters:

id -

removeSession

void removeSession(String id)

Remove a session

Parameters:

id -