Index (Shibboleth IdP :: Core 3.0.0-alpha1 API)

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

A

AbstractReloadableService<T> - Class in net.shibboleth.idp.service: Base class for ReloadableService.
AbstractReloadableService() - Constructor for class net.shibboleth.idp.service.AbstractReloadableService
AbstractReloadableService.ServiceReloadTask - Class in net.shibboleth.idp.service: A watcher that determines if a service should be reloaded and does so as appropriate.
AbstractReloadableService.ServiceReloadTask() - Constructor for class net.shibboleth.idp.service.AbstractReloadableService.ServiceReloadTask
AbstractServiceableComponent<T> - Class in net.shibboleth.idp.service: Implementation of ServiceableComponent that does most of the work required.
AbstractServiceableComponent() - Constructor for class net.shibboleth.idp.service.AbstractServiceableComponent
applicationContext - Variable in class net.shibboleth.idp.log.LogbackLoggingService: Spring application context.
applicationContext - Variable in class net.shibboleth.idp.service.AbstractServiceableComponent: The context used to load this bean.

B

BASE_LOGGER_NAME - Static variable in class net.shibboleth.idp.log.EventLogger: Base name of the logger to which events are logged.
BaseEvent - Class in net.shibboleth.idp.log: An event to be logged.
BaseEvent() - Constructor for class net.shibboleth.idp.log.BaseEvent
beanName - Variable in class net.shibboleth.idp.service.ReloadableSpringService: The bean name.

C

cachedComponent - Variable in class net.shibboleth.idp.service.ReloadableSpringService: The last known good component.
configurationResource - Variable in class net.shibboleth.idp.log.LogbackLoggingService: Logging configuration resource.
contains(String) - Method in interface net.shibboleth.idp.persistence.PersistenceManager: Determines if an item with the given ID is exists within the persistence store.
contains(ItemType) - Method in interface net.shibboleth.idp.persistence.PersistenceManager: Determines if an item exists within the persistence store.

D

destroy() - Method in class net.shibboleth.idp.log.SLF4JMDCServletFilter
doDestroy() - Method in class net.shibboleth.idp.service.AbstractServiceableComponent: .
doDestroy() - Method in class net.shibboleth.idp.service.ReloadableSpringService
doFilter(ServletRequest, ServletResponse, FilterChain) - Method in class net.shibboleth.idp.log.SLF4JMDCServletFilter
doInitialize() - Method in class net.shibboleth.idp.log.LogbackLoggingService
doInitialize() - Method in class net.shibboleth.idp.service.AbstractReloadableService
doInitialize() - Method in class net.shibboleth.idp.service.AbstractServiceableComponent
doInitialize() - Method in class net.shibboleth.idp.service.ReloadableSpringService
doInitialize() - Method in class net.shibboleth.idp.spring.OpenSAMLConfigBean
doReload() - Method in class net.shibboleth.idp.log.LogbackLoggingService: Performs the actual reload.
doReload() - Method in class net.shibboleth.idp.service.AbstractReloadableService: Performs the actual reload.
doReload() - Method in class net.shibboleth.idp.service.ReloadableSpringService: Performs the actual reload.

E

elapsedTime - Variable in class net.shibboleth.idp.log.PerformanceEvent: Total elapsed time, in milliseconds, of the operation.
EVENT_TYPE - Static variable in class net.shibboleth.idp.log.PerformanceEvent: Type for a performance event.
EventLogger - Class in net.shibboleth.idp.log: Simple logging mechanism used to log events such as performance measurements and audit data.
EventLogger() - Constructor for class net.shibboleth.idp.log.EventLogger: Constructor.

F

failFast - Variable in class net.shibboleth.idp.service.AbstractReloadableService: Do we fail immediately if the config is bogus?
fallbackConfiguration - Variable in class net.shibboleth.idp.log.LogbackLoggingService: URL to the fallback logback configuration found in the IdP jar.
FIELD_SEPERATOR - Static variable in class net.shibboleth.idp.log.PerformanceEvent: Character used to separate the fields of the event.

G

get(String) - Method in interface net.shibboleth.idp.persistence.PersistenceManager: Gets the item associated with the given ID.
getApplicationContext() - Method in class net.shibboleth.idp.service.AbstractServiceableComponent: Get the context used to load this bean.
getComponent() - Method in class net.shibboleth.idp.service.AbstractServiceableComponent: Extract the component that does the actual work.
getComponent() - Method in interface net.shibboleth.idp.service.ServiceableComponent: Extract the component that does the actual work.
getElapsedTime() - Method in class net.shibboleth.idp.log.PerformanceEvent: Gets the total elapsed time, in milliseconds, of the operation.
getLastReloadAttemptInstant() - Method in class net.shibboleth.idp.service.AbstractReloadableService: Gets the time when the service last attempted to reload.
getLastReloadAttemptInstant() - Method in interface net.shibboleth.idp.service.ReloadableService: Gets the time when the service last attempted to reload.
getLastSuccessfulReloadInstant() - Method in class net.shibboleth.idp.service.AbstractReloadableService: Gets the time when the service was last successfully reloaded.
getLastSuccessfulReloadInstant() - Method in interface net.shibboleth.idp.service.ReloadableService: Gets the time when the service was last successfully reloaded.
getLoggingConfiguration() - Method in class net.shibboleth.idp.log.LogbackLoggingService: Gets the logging configuration.
getLogPrefix() - Method in class net.shibboleth.idp.service.AbstractReloadableService: Return a string which is to be prepended to all log messages.
getMajorVersion() - Static method in class net.shibboleth.idp.Version: Gets the major version number of the IdP.
getMessage() - Method in class net.shibboleth.idp.log.BaseEvent: Gets the message associated with the event.
getMicroVersion() - Static method in class net.shibboleth.idp.Version: Gets the micro version number of the IdP.
getMinorVersion() - Static method in class net.shibboleth.idp.Version: Gets the minor version number of the IdP.
getOperation() - Method in class net.shibboleth.idp.log.PerformanceEvent: Gets the operation being timed.
getParentContext() - Method in class net.shibboleth.idp.service.ReloadableSpringService: Gets the application context that is the parent to this service's context.
getParserPool() - Method in class net.shibboleth.idp.spring.OpenSAMLConfigBean: Get the global ParserPool to configure.
getReloadCheckDelay() - Method in class net.shibboleth.idp.service.AbstractReloadableService: Gets the number of milliseconds between one reload check and another.
getReloadFailureCause() - Method in class net.shibboleth.idp.service.AbstractReloadableService: Gets the reason the last reload failed.
getReloadFailureCause() - Method in interface net.shibboleth.idp.service.ReloadableService: Gets the reason the last reload failed.
getReloadTaskTimer() - Method in class net.shibboleth.idp.service.AbstractReloadableService: Gets the timer used to schedule configuration reload tasks.
getSearchLocations() - Method in class net.shibboleth.idp.spring.IdPPropertiesApplicationContextInitializer: Get the well known search locations SEARCH_LOCATIONS.
getSearchTarget() - Method in class net.shibboleth.idp.spring.IdPPropertiesApplicationContextInitializer: Get the target resource to be searched for IDP_PROPERTIES.
getServiceableComponent() - Method in class net.shibboleth.idp.log.LogbackLoggingService: Get the serviceable component that this service supports .
getServiceableComponent() - Method in interface net.shibboleth.idp.service.ReloadableService: Get the serviceable component that this service supports .
getServiceableComponent() - Method in class net.shibboleth.idp.service.ReloadableSpringService: Get the serviceable component.
getServiceConfigurations() - Method in class net.shibboleth.idp.service.ReloadableSpringService: Gets an unmodifiable list of configurations for this service.
getStartTime() - Method in class net.shibboleth.idp.log.PerformanceEvent: Gets the system local time in milliseconds when the performance measurement started.
getStopTime() - Method in class net.shibboleth.idp.log.PerformanceEvent: Gets the System local time in milliseconds when the performance measurement stopped.
getType() - Method in class net.shibboleth.idp.log.BaseEvent: Gets the type of event.
getType() - Method in class net.shibboleth.idp.log.PerformanceEvent: Gets the type of event.
getVersion() - Static method in class net.shibboleth.idp.Version: Gets the version of the IdP.

I

IDP_HOME_PROPERTY - Static variable in class net.shibboleth.idp.spring.IdPPropertiesApplicationContextInitializer: IdP home property.
IDP_PROPERTIES - Static variable in class net.shibboleth.idp.spring.IdPPropertiesApplicationContextInitializer: Target resource to be searched for.
IdPPropertiesApplicationContextInitializer - Class in net.shibboleth.idp.spring: An ApplicationContextInitializer which attempts to add a properties file property source to the application context environment.
IdPPropertiesApplicationContextInitializer() - Constructor for class net.shibboleth.idp.spring.IdPPropertiesApplicationContextInitializer
init(FilterConfig) - Method in class net.shibboleth.idp.log.SLF4JMDCServletFilter
initialize(ConfigurableWebApplicationContext) - Method in class net.shibboleth.idp.spring.IdPPropertiesApplicationContextInitializer
isFailFast() - Method in class net.shibboleth.idp.service.AbstractReloadableService: Do we fail fast?
isOperationSuccessful() - Method in class net.shibboleth.idp.log.PerformanceEvent: Gets whether the operation was successful.
isRunning() - Method in class net.shibboleth.idp.service.AbstractReloadableService: .

L

lastLoadFailed - Variable in class net.shibboleth.idp.service.ReloadableSpringService: Did the last load fail? An optimization only.
lastReloadInstant - Variable in class net.shibboleth.idp.service.AbstractReloadableService: The last time time the service was reloaded, whether successful or not.
lastSuccessfulReleaseIntant - Variable in class net.shibboleth.idp.service.AbstractReloadableService: The last time the service was reloaded successfully.
loadIdPHomeProperty() - Method in class net.shibboleth.idp.log.LogbackLoggingService: Add the IDP_HOME_PROPERTY property from the Spring application context to the logger context.
loadLoggingConfiguration() - Method in class net.shibboleth.idp.log.LogbackLoggingService: Reads and loads in a new logging configuration.
loadLoggingConfiguration(InputStream) - Method in class net.shibboleth.idp.log.LogbackLoggingService: Loads a logging configuration in to the active logger context.
loadProperties(Resource) - Method in class net.shibboleth.idp.spring.IdPPropertiesApplicationContextInitializer: Load properties from the resource and log property names and values at debug level, suppressing properties whose name matches 'password'.
log(BaseEvent) - Static method in class net.shibboleth.idp.log.EventLogger: Logs the event.
log - Variable in class net.shibboleth.idp.service.AbstractReloadableService: Class logger.
log - Variable in class net.shibboleth.idp.service.AbstractServiceableComponent: Class logger.
log - Variable in class net.shibboleth.idp.service.ReloadableSpringService: Class logger.
log - Variable in class net.shibboleth.idp.spring.IdPPropertiesApplicationContextInitializer: Class logger.
log - Variable in class net.shibboleth.idp.spring.OpenSAMLConfigBean: Class logger.
LogbackLoggingService - Class in net.shibboleth.idp.log: Simple logging service that watches for logback configuration file changes and reloads the file when a change occurs.
LogbackLoggingService() - Constructor for class net.shibboleth.idp.log.LogbackLoggingService
loggerContext - Variable in class net.shibboleth.idp.log.LogbackLoggingService: Logback logger context.
logPrefix - Variable in class net.shibboleth.idp.service.AbstractReloadableService: The log prefix.

M

main(String[]) - Static method in class net.shibboleth.idp.Version: Main entry point to program.
MAJOR_VERSION - Static variable in class net.shibboleth.idp.Version: IdP major version number.
MDC_ATTRIBUTE - Static variable in class net.shibboleth.idp.Version: Name of MDC attribute that holds the IdP's version string: idp.version.
message - Variable in class net.shibboleth.idp.log.BaseEvent: A human readable message associated with the event.
MICRO_VERSION - Static variable in class net.shibboleth.idp.Version: IdP micro version number.
MINOR_VERSION - Static variable in class net.shibboleth.idp.Version: IdP minor version number.

N

net.shibboleth.idp - package net.shibboleth.idp: Root package for IdP, contains a couple base/utility classes.
net.shibboleth.idp.log - package net.shibboleth.idp.log: IdP logging setup and management classes.
net.shibboleth.idp.persistence - package net.shibboleth.idp.persistence: Classes and interfaces related to the persistence of IdP data.
net.shibboleth.idp.service - package net.shibboleth.idp.service: Within the IdP a 'service' is a coarse grained component.
net.shibboleth.idp.spring - package net.shibboleth.idp.spring: Classes for extending, or supporting, Spring based configuration and object management.
normalizePath(String) - Method in class net.shibboleth.idp.spring.IdPPropertiesApplicationContextInitializer: Normalize the path by calling StringUtils.cleanPath(String).

O

OpenSAMLConfigBean - Class in net.shibboleth.idp.spring: A simple bean that may be used with Spring to initialize the OpenSAML library.
OpenSAMLConfigBean() - Constructor for class net.shibboleth.idp.spring.OpenSAMLConfigBean
operation - Variable in class net.shibboleth.idp.log.PerformanceEvent: Identifier of the operation being timed.

P

parentContext - Variable in class net.shibboleth.idp.service.ReloadableSpringService: Application context owning this engine.
parserPool - Variable in class net.shibboleth.idp.spring.OpenSAMLConfigBean: Optional ParserPool to configure.
PerformanceEvent - Class in net.shibboleth.idp.log: An event recording the performance of some operation.
PerformanceEvent(String) - Constructor for class net.shibboleth.idp.log.PerformanceEvent: Constructor.
persist(String, ItemType) - Method in interface net.shibboleth.idp.persistence.PersistenceManager: Persists an item to the persistence store.
PersistenceManager<ItemType> - Interface in net.shibboleth.idp.persistence: Interface describing behavior for IdP components that persist and manage a particular type of stored data.
pinComponent() - Method in class net.shibboleth.idp.service.AbstractServiceableComponent: This function takes a lock on the component which guarantees that it will not be disposed until the release call is made.
Every call to ServiceableComponent.pinComponent() must be matched by a call to ServiceableComponent.unpinComponent()
The need to have the type converting return parameter is to get around the java typing restrictions.
pinComponent() - Method in interface net.shibboleth.idp.service.ServiceableComponent: This function takes a lock on the component which guarantees that it will not be disposed until the release call is made.
Every call to ServiceableComponent.pinComponent() must be matched by a call to ServiceableComponent.unpinComponent()
The need to have the type converting return parameter is to get around the java typing restrictions.
postProcessors - Variable in class net.shibboleth.idp.service.ReloadableSpringService: List of bean post processors for this service's content.

R

reload() - Method in class net.shibboleth.idp.service.AbstractReloadableService: Reloads the configuration of the service.
reload() - Method in interface net.shibboleth.idp.service.ReloadableService: Reloads the configuration of the service.
ReloadableService<T> - Interface in net.shibboleth.idp.service: A service that supports reloading its configuration.
ReloadableSpringService<T> - Class in net.shibboleth.idp.service: This class provides a reloading interface to a ServiceableComponent.
ReloadableSpringService(Class<T>) - Constructor for class net.shibboleth.idp.service.ReloadableSpringService: Constructor.
ReloadableSpringService(Class<T>, Class<? extends ServiceableComponent>) - Constructor for class net.shibboleth.idp.service.ReloadableSpringService: Constructor.
reloadCheckDelay - Variable in class net.shibboleth.idp.service.AbstractReloadableService: Number of milliseconds between one reload check and another.
reloadFailureCause - Variable in class net.shibboleth.idp.service.AbstractReloadableService: The cause of the last reload failure, if the last reload failed.
reloadTask - Variable in class net.shibboleth.idp.service.AbstractReloadableService: Watcher that monitors the set of configuration resources for this service for changes.
reloadTaskTimer - Variable in class net.shibboleth.idp.service.AbstractReloadableService: Timer used to schedule configuration reload tasks.
remove(String) - Method in interface net.shibboleth.idp.persistence.PersistenceManager: Removes an item with the given ID from the persistence store.
remove(ItemType) - Method in interface net.shibboleth.idp.persistence.PersistenceManager: Removes an item from the persistence store.
resourceLastModifiedTimes - Variable in class net.shibboleth.idp.service.ReloadableSpringService: Time, in milliseconds, when the service configuration for the given index was last observed to have changed.
run() - Method in class net.shibboleth.idp.service.AbstractReloadableService.ServiceReloadTask

S

SEARCH_LOCATIONS - Static variable in class net.shibboleth.idp.spring.IdPPropertiesApplicationContextInitializer: Well known search locations.
serialVersionUID - Static variable in exception net.shibboleth.idp.service.ServiceException: Serial version UID.
ServiceableComponent<T> - Interface in net.shibboleth.idp.service: Any Component that wants to be reloaded via the Service interface and spring implements this interface.
serviceConfigurations - Variable in class net.shibboleth.idp.service.ReloadableSpringService: List of configuration resources for this service.
ServiceException - Exception in net.shibboleth.idp.service: Base exception for Service related errors.
ServiceException() - Constructor for exception net.shibboleth.idp.service.ServiceException: Constructor.
ServiceException(String) - Constructor for exception net.shibboleth.idp.service.ServiceException: Constructor.
ServiceException(Exception) - Constructor for exception net.shibboleth.idp.service.ServiceException: Constructor.
ServiceException(String, Exception) - Constructor for exception net.shibboleth.idp.service.ServiceException: Constructor.
serviceLock - Variable in class net.shibboleth.idp.service.AbstractServiceableComponent: Lock for this service.
setApplicationContext(ApplicationContext) - Method in class net.shibboleth.idp.log.LogbackLoggingService
setApplicationContext(ApplicationContext) - Method in class net.shibboleth.idp.service.AbstractServiceableComponent
setApplicationContext(ApplicationContext) - Method in class net.shibboleth.idp.service.ReloadableSpringService
setBeanName(String) - Method in class net.shibboleth.idp.service.ReloadableSpringService
setBeanPostProcessors(List<BeanPostProcessor>) - Method in class net.shibboleth.idp.service.ReloadableSpringService: Set the list of bean post processors for this service.
setFailFast(boolean) - Method in class net.shibboleth.idp.service.AbstractReloadableService: Sets whether we fail fast.
setIdPHomeProperty(String, Properties) - Method in class net.shibboleth.idp.spring.IdPPropertiesApplicationContextInitializer: Set the IDP_HOME_PROPERTY property to the given path if not already set and if not set as a system property.
setLoggingConfiguration(Resource) - Method in class net.shibboleth.idp.log.LogbackLoggingService: Sets the logging configuration.
setMessage(String) - Method in class net.shibboleth.idp.log.BaseEvent: Sets the message associated with the event.
setParentContext(ApplicationContext) - Method in class net.shibboleth.idp.service.ReloadableSpringService: Sets the application context that is the parent to this service's context.
setParserPool(ParserPool) - Method in class net.shibboleth.idp.spring.OpenSAMLConfigBean: Set the global ParserPool to configure.
setReloadCheckDelay(long) - Method in class net.shibboleth.idp.service.AbstractReloadableService: Sets the number of milliseconds between one reload check and another.
setReloadTaskTimer(Timer) - Method in class net.shibboleth.idp.service.AbstractReloadableService: Sets the timer used to schedule configuration reload tasks.
setServiceConfigurations(List<Resource>) - Method in class net.shibboleth.idp.service.ReloadableSpringService: Sets the list of configurations for this service.
shouldReload() - Method in class net.shibboleth.idp.log.LogbackLoggingService: Called by the AbstractReloadableService.ServiceReloadTask to determine if the service should be reloaded.
shouldReload() - Method in class net.shibboleth.idp.service.AbstractReloadableService: Called by the AbstractReloadableService.ServiceReloadTask to determine if the service should be reloaded.
shouldReload() - Method in class net.shibboleth.idp.service.ReloadableSpringService: Called by the AbstractReloadableService.ServiceReloadTask to determine if the service should be reloaded.
SLF4JMDCServletFilter - Class in net.shibboleth.idp.log: Servlet filter that sets some interesting MDC attributes as the request comes in and clears the MDC as the response is returned.
SLF4JMDCServletFilter() - Constructor for class net.shibboleth.idp.log.SLF4JMDCServletFilter
start() - Method in class net.shibboleth.idp.service.AbstractReloadableService
startTime - Variable in class net.shibboleth.idp.log.PerformanceEvent: System local time in milliseconds when the performance measurement started.
startTime() - Method in class net.shibboleth.idp.log.PerformanceEvent: Records the timer of the operation.
statusManager - Variable in class net.shibboleth.idp.log.LogbackLoggingService: Logger used to log messages without relying on the logging system to be full initialized.
stop() - Method in class net.shibboleth.idp.service.AbstractReloadableService
stopTime - Variable in class net.shibboleth.idp.log.PerformanceEvent: System local time in milliseconds when the performance measurement stopped.
stopTime(boolean) - Method in class net.shibboleth.idp.log.PerformanceEvent: Records the completion time of the operation and whether the operation was successful.
successfulOperation - Variable in class net.shibboleth.idp.log.PerformanceEvent: Whether the operation completed successfully or failed.

T

theClaz - Variable in class net.shibboleth.idp.service.ReloadableSpringService: The class we are looking for.
theServiceClaz - Variable in class net.shibboleth.idp.service.ReloadableSpringService: The precise class to look for.
toString() - Method in class net.shibboleth.idp.log.PerformanceEvent

U

unloadComponent() - Method in class net.shibboleth.idp.service.AbstractServiceableComponent: This call will wait for all transient operations to complete and then calls dispose on the components.
unloadComponent() - Method in interface net.shibboleth.idp.service.ServiceableComponent: This call will wait for all transient operations to complete and then calls dispose on the components.
unpinComponent() - Method in class net.shibboleth.idp.service.AbstractServiceableComponent: This undoes the work that is done by ServiceableComponent.getComponent().
unpinComponent() - Method in interface net.shibboleth.idp.service.ServiceableComponent: This undoes the work that is done by ServiceableComponent.getComponent().

V

Version - Class in net.shibboleth.idp: Class for getting and printing the version of the IdP.
Version() - Constructor for class net.shibboleth.idp.Version: Constructor.
VERSION - Static variable in class net.shibboleth.idp.Version: IdP version.

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