Index (Shibboleth IdP :: Session API 3.4.0 API)

A B C D E G H I K L M N P R S T U V

A

AbstractIdPSession - Class in net.shibboleth.idp.session: Abstract base for implementations of IdPSession, handles basic management of the instance data without addressing persistence.
AbstractIdPSession(String, String, long) - Constructor for class net.shibboleth.idp.session.AbstractIdPSession: Constructor.
AbstractIdPSession.AddressFamily - Enum in net.shibboleth.idp.session: Address syntaxes supported for address binding.
AbstractIdPSession.AddressFamily() - Constructor for enum net.shibboleth.idp.session.AbstractIdPSession.AddressFamily
AbstractSPSessionSerializer - Class in net.shibboleth.idp.session: Base class for SPSession serializers that handles data common to all such objects.
AbstractSPSessionSerializer(long) - Constructor for class net.shibboleth.idp.session.AbstractSPSessionSerializer: Constructor.
addAuthenticationResult(AuthenticationResult) - Method in class net.shibboleth.idp.session.AbstractIdPSession: Add a new AuthenticationResult to this IdP session, replacing any existing result of the same flow ID.
addAuthenticationResult(AuthenticationResult) - Method in interface net.shibboleth.idp.session.IdPSession: Add a new AuthenticationResult to this IdP session, replacing any existing result of the same flow ID.
addSPSession(SPSession) - Method in class net.shibboleth.idp.session.AbstractIdPSession: Add a new SP session to this IdP session, replacing any existing session for the same service.
addSPSession(SPSession) - Method in interface net.shibboleth.idp.session.IdPSession: Add a new SP session to this IdP session, replacing any existing session for the same service.
apply(ProfileRequestContext) - Method in class net.shibboleth.idp.session.context.navigate.CanonicalUsernameLookupStrategy
apply(SessionContext) - Method in class net.shibboleth.idp.session.context.navigate.SessionContextIDLookupFunction
apply(SessionContext) - Method in class net.shibboleth.idp.session.context.navigate.SessionContextPrincipalLookupFunction
apply(SPSession) - Method in class net.shibboleth.idp.session.logic.LogoutPropagationFlowDescriptorSelector
authenticationResults - Variable in class net.shibboleth.idp.session.AbstractIdPSession: Tracks authentication results that have occurred during this session.
availableFlows - Variable in class net.shibboleth.idp.session.logic.LogoutPropagationFlowDescriptorSelector: List of available flows.

B

BasicSPSession - Class in net.shibboleth.idp.session: Implementation support for a concrete SPSession implementation.
BasicSPSession(String, long, long) - Constructor for class net.shibboleth.idp.session.BasicSPSession: Constructor.
bindToAddress(String) - Method in class net.shibboleth.idp.session.AbstractIdPSession: Associate an address with this session.

C

CanonicalUsernameLookupStrategy - Class in net.shibboleth.idp.session.context.navigate: Function that returns a principal name from one of two places: a SubjectCanonicalizationContext child of the root context or a SessionContext.
CanonicalUsernameLookupStrategy() - Constructor for class net.shibboleth.idp.session.context.navigate.CanonicalUsernameLookupStrategy
checkAddress(String) - Method in class net.shibboleth.idp.session.AbstractIdPSession: Test the session's validity based on the supplied client address, possibly binding it to the session if appropriate.
checkAddress(String) - Method in interface net.shibboleth.idp.session.IdPSession: Test the session's validity based on the supplied client address, possibly binding it to the session if appropriate.
checkTimeout() - Method in class net.shibboleth.idp.session.AbstractIdPSession: Test the session's validity based on inactivity, while updating the last activity time.
checkTimeout() - Method in interface net.shibboleth.idp.session.IdPSession: Test the session's validity based on inactivity, while updating the last activity time.
createSession(String) - Method in interface net.shibboleth.idp.session.SessionManager: Create and return a new IdPSession object for a subject.
CREATION_INSTANT_FIELD - Static variable in class net.shibboleth.idp.session.AbstractSPSessionSerializer: Field name of creation instant.
creationInstant - Variable in class net.shibboleth.idp.session.AbstractIdPSession: Time, in milliseconds since the epoch, when this session was created.
creationInstant - Variable in class net.shibboleth.idp.session.BasicSPSession: The time, in milliseconds since the epoch, when this session was created.

D

deserialize(long, String, String, String, Long) - Method in class net.shibboleth.idp.session.AbstractSPSessionSerializer
destroySession(String, boolean) - Method in interface net.shibboleth.idp.session.SessionManager: Invalidates or otherwise removes a session from persistent storage and/or unbinds it from a client.
detail - Variable in class net.shibboleth.idp.session.context.LogoutPropagationContext: Details of result, typically only populated for failures.
doAddAuthenticationResult(AuthenticationResult) - Method in class net.shibboleth.idp.session.AbstractIdPSession: Add a new AuthenticationResult to this IdP session, replacing any existing result of the same flow ID.
doAddSPSession(SPSession) - Method in class net.shibboleth.idp.session.AbstractIdPSession: Add a new SP session to this IdP session, replacing any existing session for the same service.
doBindToAddress(String) - Method in class net.shibboleth.idp.session.AbstractIdPSession: Associate an address with this session.
doDeserialize(JsonObject, String, long, long) - Method in class net.shibboleth.idp.session.AbstractSPSessionSerializer: Implement this method to return the appropriate type of object, populated with the basic information supplied.
doRemoveAuthenticationResult(AuthenticationResult) - Method in class net.shibboleth.idp.session.AbstractIdPSession: Disassociate an AuthenticationResult from this IdP session.
doRemoveSPSession(SPSession) - Method in class net.shibboleth.idp.session.AbstractIdPSession: Disassociate the given SP session from this IdP session.
doSerializeAdditional(SPSession, JsonGenerator) - Method in class net.shibboleth.idp.session.AbstractSPSessionSerializer: Override this method to handle serialization of additional data.
doSetLastActivityInstant(long) - Method in class net.shibboleth.idp.session.AbstractIdPSession: Set the last activity instant, in milliseconds since the epoch, for the session.

E

equals(Object) - Method in class net.shibboleth.idp.session.AbstractIdPSession
equals(Object) - Method in class net.shibboleth.idp.session.BasicSPSession
equals(Object) - Method in class net.shibboleth.idp.session.criterion.SessionIdCriterion
equals(Object) - Method in class net.shibboleth.idp.session.criterion.SPSessionCriterion
equals(Object) - Method in class net.shibboleth.idp.session.LogoutPropagationFlowDescriptor
expirationInstant - Variable in class net.shibboleth.idp.session.BasicSPSession: The time, in milliseconds since the epoch, when this session expires.
expirationOffset - Variable in class net.shibboleth.idp.session.AbstractSPSessionSerializer: Milliseconds to subtract from record expiration to establish session expiration value.

G

getAddress(AbstractIdPSession.AddressFamily) - Method in class net.shibboleth.idp.session.AbstractIdPSession: Get an address to which this session is bound.
getAddressFamily(String) - Static method in class net.shibboleth.idp.session.AbstractIdPSession: Returns the address family for an input address.
getAuthenticationResult(String) - Method in class net.shibboleth.idp.session.AbstractIdPSession: Get an associated AuthenticationResult given its flow ID.
getAuthenticationResult(String) - Method in interface net.shibboleth.idp.session.IdPSession: Get an associated AuthenticationResult given its flow ID.
getAuthenticationResultMap() - Method in class net.shibboleth.idp.session.AbstractIdPSession: Accessor for the underlying AuthenticationResult map maintained with the IdP session.
getAuthenticationResults() - Method in class net.shibboleth.idp.session.AbstractIdPSession: Get the unmodifiable set of AuthenticationResults associated with this session.
getAuthenticationResults() - Method in interface net.shibboleth.idp.session.IdPSession: Get the unmodifiable set of AuthenticationResults associated with this session.
getCreationInstant() - Method in class net.shibboleth.idp.session.AbstractIdPSession: Get the time, in milliseconds since the epoch, when this session was created.
getCreationInstant() - Method in class net.shibboleth.idp.session.BasicSPSession: Get the time, in milliseconds since the epoch, when this session was created.
getCreationInstant() - Method in interface net.shibboleth.idp.session.IdPSession: Get the time, in milliseconds since the epoch, when this session was created.
getCreationInstant() - Method in interface net.shibboleth.idp.session.SPSession: Get the time, in milliseconds since the epoch, when this session was created.
getDetail() - Method in class net.shibboleth.idp.session.context.LogoutPropagationContext: Get detailed message regarding result of logout propagation.
getExpirationInstant() - Method in class net.shibboleth.idp.session.BasicSPSession: Get the time, in milliseconds since the epoch, when this session will expire.
getExpirationInstant() - Method in interface net.shibboleth.idp.session.SPSession: Get the time, in milliseconds since the epoch, when this session will expire.
getId() - Method in class net.shibboleth.idp.session.AbstractIdPSession
getId() - Method in class net.shibboleth.idp.session.BasicSPSession
getIdPSession() - Method in class net.shibboleth.idp.session.context.SessionContext: Get the IdP session.
getKeyedSessionMap() - Method in class net.shibboleth.idp.session.context.LogoutContext: Get a live view of the map of sessions keyed by an external value.
getLastActivityInstant() - Method in class net.shibboleth.idp.session.AbstractIdPSession: Get the last activity instant, in milliseconds since the epoch, for the session.
getLastActivityInstant() - Method in interface net.shibboleth.idp.session.IdPSession: Get the last activity instant, in milliseconds since the epoch, for the session.
getPrincipalName() - Method in class net.shibboleth.idp.session.AbstractIdPSession: Get the canonical principal name for the session.
getPrincipalName() - Method in interface net.shibboleth.idp.session.IdPSession: Get the canonical principal name for the session.
getResult() - Method in class net.shibboleth.idp.session.context.LogoutPropagationContext: Get the result of the logout propagation.
getServiceId() - Method in class net.shibboleth.idp.session.criterion.SPSessionCriterion: Get the service ID.
getSession() - Method in class net.shibboleth.idp.session.context.LogoutPropagationContext: Get the SPSession being destroyed by the logout propagation.
getSessionId() - Method in class net.shibboleth.idp.session.criterion.SessionIdCriterion: Get the session ID.
getSessionKey() - Method in class net.shibboleth.idp.session.context.LogoutPropagationContext: Gets the key under which the SPSession was stored in LogoutContext.getKeyedSessionMap().
getSessionMap() - Method in class net.shibboleth.idp.session.context.LogoutContext: Get a live view of the map of service ID/session mappings.
getSessions(String) - Method in class net.shibboleth.idp.session.context.LogoutContext: Get a live collection of sessions associated with a service.
getSessionType() - Method in class net.shibboleth.idp.session.LogoutPropagationFlowDescriptor: Get the type of SPSession supported by this flow descriptor.
getSPSession(String) - Method in class net.shibboleth.idp.session.AbstractIdPSession: Get the SPSession for a given service.
getSPSession(String) - Method in interface net.shibboleth.idp.session.IdPSession: Get the SPSession for a given service.
getSPSessionKey() - Method in class net.shibboleth.idp.session.BasicSPSession: Get a unique key identifying this subject's session with the service.
getSPSessionKey() - Method in class net.shibboleth.idp.session.criterion.SPSessionCriterion: Get the service session key.
getSPSessionKey() - Method in interface net.shibboleth.idp.session.SPSession: Get a unique key identifying this subject's session with the service.
getSPSessionMap() - Method in class net.shibboleth.idp.session.AbstractIdPSession: Accessor for the underlying SPSession map maintained with the IdP session.
getSPSessions() - Method in class net.shibboleth.idp.session.AbstractIdPSession: Gets the unmodifiable collection of service sessions associated with this session.
getSPSessions() - Method in interface net.shibboleth.idp.session.IdPSession: Gets the unmodifiable collection of service sessions associated with this session.

H

hashCode() - Method in class net.shibboleth.idp.session.AbstractIdPSession
hashCode() - Method in class net.shibboleth.idp.session.BasicSPSession
hashCode() - Method in class net.shibboleth.idp.session.criterion.SessionIdCriterion
hashCode() - Method in class net.shibboleth.idp.session.criterion.SPSessionCriterion
hashCode() - Method in class net.shibboleth.idp.session.LogoutPropagationFlowDescriptor
HttpServletRequestCriterion - Class in net.shibboleth.idp.session.criterion: Criterion representing a session bound to a servlet request, which is implicitly the "current" request known to the resolver.
HttpServletRequestCriterion() - Constructor for class net.shibboleth.idp.session.criterion.HttpServletRequestCriterion

I

id - Variable in class net.shibboleth.idp.session.AbstractIdPSession: Unique ID of this session.
id - Variable in class net.shibboleth.idp.session.criterion.SessionIdCriterion: The session ID.
id - Variable in class net.shibboleth.idp.session.criterion.SPSessionCriterion: The service ID.
IdPSession - Interface in net.shibboleth.idp.session: An identity provider session belonging to a particular subject and client device.
ipV4Address - Variable in class net.shibboleth.idp.session.AbstractIdPSession: Addresses to which the session is bound.
ipV6Address - Variable in class net.shibboleth.idp.session.AbstractIdPSession: An IPv6 address to which the session is bound.

K

key - Variable in class net.shibboleth.idp.session.criterion.SPSessionCriterion: Service session key.
keyedSessionMap - Variable in class net.shibboleth.idp.session.context.LogoutContext: An index of the session objects by an externally assigned key.

L

lastActivityInstant - Variable in class net.shibboleth.idp.session.AbstractIdPSession: Last activity instant, in milliseconds since the epoch, for this session.
log - Variable in class net.shibboleth.idp.session.AbstractIdPSession: Class logger.
log - Variable in class net.shibboleth.idp.session.AbstractSPSessionSerializer: Class logger.
log - Variable in class net.shibboleth.idp.session.SPSessionSerializerRegistry: Class logger.
LogoutContext - Class in net.shibboleth.idp.session.context: A BaseContext that holds a multimap of SPSession objects.
LogoutContext() - Constructor for class net.shibboleth.idp.session.context.LogoutContext: Constructor.
LogoutPropagationContext - Class in net.shibboleth.idp.session.context: Context holding information needed to perform logout for a single SP session.
LogoutPropagationContext() - Constructor for class net.shibboleth.idp.session.context.LogoutPropagationContext
LogoutPropagationContext.Result - Enum in net.shibboleth.idp.session.context: Logout propagation result.
LogoutPropagationContext.Result() - Constructor for enum net.shibboleth.idp.session.context.LogoutPropagationContext.Result
LogoutPropagationFlowDescriptor - Class in net.shibboleth.idp.session: A descriptor for a logout propagation flow.
LogoutPropagationFlowDescriptor(Class<? extends SPSession>) - Constructor for class net.shibboleth.idp.session.LogoutPropagationFlowDescriptor: Constructor.
LogoutPropagationFlowDescriptorSelector - Class in net.shibboleth.idp.session.logic: Selection function to retrieve the logout propagation flow descriptor that is suitable for a given SPSession.
LogoutPropagationFlowDescriptorSelector(List<LogoutPropagationFlowDescriptor>) - Constructor for class net.shibboleth.idp.session.logic.LogoutPropagationFlowDescriptorSelector: Constructor.
lookup(Class<? extends SPSession>) - Method in class net.shibboleth.idp.session.SPSessionSerializerRegistry: Get a registered StorageSerializer for a given SPSession type, if any.

M

MDC_ATTRIBUTE - Static variable in interface net.shibboleth.idp.session.IdPSession: Name of MDC attribute that holds the current session ID: idp.session.id.

N

net.shibboleth.idp.session - package net.shibboleth.idp.session: APIs related to the construction and management of sessions.
net.shibboleth.idp.session.context - package net.shibboleth.idp.session.context: Context classes for managing session-related state.
net.shibboleth.idp.session.context.navigate - package net.shibboleth.idp.session.context.navigate: Functions for traversing session-related contexts.
net.shibboleth.idp.session.criterion - package net.shibboleth.idp.session.criterion: Criterion classes for session lookup.
net.shibboleth.idp.session.logic - package net.shibboleth.idp.session.logic: Functions and Predicates related to the use of sessions.

P

principalName - Variable in class net.shibboleth.idp.session.AbstractIdPSession: A canonical name for the subject of the session.

R

registry - Variable in class net.shibboleth.idp.session.SPSessionSerializerRegistry: Storage for the registry mappings.
removeAuthenticationResult(AuthenticationResult) - Method in class net.shibboleth.idp.session.AbstractIdPSession: Disassociate an AuthenticationResult from this IdP session.
removeAuthenticationResult(AuthenticationResult) - Method in interface net.shibboleth.idp.session.IdPSession: Disassociate an AuthenticationResult from this IdP session.
removeSPSession(SPSession) - Method in class net.shibboleth.idp.session.AbstractIdPSession: Disassociate the given SP session from this IdP session.
removeSPSession(SPSession) - Method in interface net.shibboleth.idp.session.IdPSession: Disassociate the given SP session from this IdP session.
result - Variable in class net.shibboleth.idp.session.context.LogoutPropagationContext: Result of logout propagation flow.

S

serialize(SPSession) - Method in class net.shibboleth.idp.session.AbstractSPSessionSerializer
serialVersionUID - Static variable in exception net.shibboleth.idp.session.SessionException: Serial version UID.
SERVICE_ID_FIELD - Static variable in class net.shibboleth.idp.session.AbstractSPSessionSerializer: Field name of service ID.
serviceId - Variable in class net.shibboleth.idp.session.BasicSPSession: The unique identifier of the service.
session - Variable in class net.shibboleth.idp.session.context.LogoutPropagationContext: SP session to be destroyed.
session - Variable in class net.shibboleth.idp.session.context.SessionContext: IdP session wrapped by this adapter.
SessionContext - Class in net.shibboleth.idp.session.context: A BaseContext that holds an IdPSession.
SessionContext() - Constructor for class net.shibboleth.idp.session.context.SessionContext: Constructor.
SessionContextIDLookupFunction - Class in net.shibboleth.idp.session.context.navigate: A function that returns the session ID from the session inside a SessionContext.
SessionContextIDLookupFunction() - Constructor for class net.shibboleth.idp.session.context.navigate.SessionContextIDLookupFunction
SessionContextPrincipalLookupFunction - Class in net.shibboleth.idp.session.context.navigate: A function that returns the principal name from the session inside a SessionContext.
SessionContextPrincipalLookupFunction() - Constructor for class net.shibboleth.idp.session.context.navigate.SessionContextPrincipalLookupFunction
SessionException - Exception in net.shibboleth.idp.session: Exception indicating a problem authenticating a user.
SessionException() - Constructor for exception net.shibboleth.idp.session.SessionException: Constructor.
SessionException(String) - Constructor for exception net.shibboleth.idp.session.SessionException: Constructor.
SessionException(Exception) - Constructor for exception net.shibboleth.idp.session.SessionException: Constructor.
SessionException(String, Exception) - Constructor for exception net.shibboleth.idp.session.SessionException: Constructor.
SessionIdCriterion - Class in net.shibboleth.idp.session.criterion: Criterion representing a session ID.
SessionIdCriterion(String) - Constructor for class net.shibboleth.idp.session.criterion.SessionIdCriterion: Constructor.
sessionKey - Variable in class net.shibboleth.idp.session.context.LogoutPropagationContext: Session key.
SessionManager - Interface in net.shibboleth.idp.session: Component that manages sessions between the IdP and client devices.
sessionMap - Variable in class net.shibboleth.idp.session.context.LogoutContext: SP sessions needing logout.
SessionResolver - Interface in net.shibboleth.idp.session: A resolver that is capable of finding IdPSession objects that meet certain criteria.
sessionType - Variable in class net.shibboleth.idp.session.LogoutPropagationFlowDescriptor: Type of session handled by this flow.
setDetail(String) - Method in class net.shibboleth.idp.session.context.LogoutPropagationContext: Set the logout propagation result detail message.
setIdPSession(IdPSession) - Method in class net.shibboleth.idp.session.context.SessionContext: Set the IdP session.
setLastActivityInstant(long) - Method in class net.shibboleth.idp.session.AbstractIdPSession: Set the last activity instant, in milliseconds since the epoch, for the session.
setMappings(Map<Class<? extends SPSession>, StorageSerializer<? extends SPSession>>) - Method in class net.shibboleth.idp.session.SPSessionSerializerRegistry: Set the mappings to use.
setResult(LogoutPropagationContext.Result) - Method in class net.shibboleth.idp.session.context.LogoutPropagationContext: Set the logout propagation result.
setResultString(String) - Method in class net.shibboleth.idp.session.context.LogoutPropagationContext: Set the logout propagation result from a string representation of LogoutPropagationContext.Result.
setSession(SPSession) - Method in class net.shibboleth.idp.session.context.LogoutPropagationContext: Set the SPSession to be destroyed.
setSessionKey(String) - Method in class net.shibboleth.idp.session.context.LogoutPropagationContext: Sets the key under which the SPSession was stored in LogoutContext.getKeyedSessionMap().
SPSession - Interface in net.shibboleth.idp.session: Describes a session with a service in turn associated with an IdPSession.
SPSessionCriterion - Class in net.shibboleth.idp.session.criterion: Criterion representing a service ID and an implementation-specific service session key.
SPSessionCriterion(String, String) - Constructor for class net.shibboleth.idp.session.criterion.SPSessionCriterion: Constructor.
spSessions - Variable in class net.shibboleth.idp.session.AbstractIdPSession: Tracks services which have been issued authentication tokens during this session.
SPSessionSerializerRegistry - Class in net.shibboleth.idp.session: A registry of mappings between a SPSession class and a corresponding StorageSerializer for that type.
SPSessionSerializerRegistry() - Constructor for class net.shibboleth.idp.session.SPSessionSerializerRegistry: Constructor.

T

toString() - Method in class net.shibboleth.idp.session.AbstractIdPSession
toString() - Method in class net.shibboleth.idp.session.BasicSPSession
toString() - Method in class net.shibboleth.idp.session.criterion.SessionIdCriterion
toString() - Method in class net.shibboleth.idp.session.criterion.SPSessionCriterion
toString() - Method in class net.shibboleth.idp.session.LogoutPropagationFlowDescriptor

U

updateAuthenticationResultActivity(AuthenticationResult) - Method in interface net.shibboleth.idp.session.IdPSession: Update the recorded activity timestamp for an AuthenticationResult associated with this session.

V

valueOf(String) - Static method in enum net.shibboleth.idp.session.AbstractIdPSession.AddressFamily: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum net.shibboleth.idp.session.context.LogoutPropagationContext.Result: Returns the enum constant of this type with the specified name.
values() - Static method in enum net.shibboleth.idp.session.AbstractIdPSession.AddressFamily: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum net.shibboleth.idp.session.context.LogoutPropagationContext.Result: Returns an array containing the constants of this enum type, in the order they are declared.

A B C D E G H I K L M N P R S T U V