net.shibboleth.idp.cas.service

Class PatternServiceRegistry

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

net.shibboleth.ext.spring.service.AbstractServiceableComponent<ServiceRegistry>

net.shibboleth.idp.cas.service.PatternServiceRegistry

All Implemented Interfaces:

ServiceRegistry, net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.IdentifiableComponent, net.shibboleth.utilities.java.support.component.IdentifiedComponent, net.shibboleth.utilities.java.support.component.InitializableComponent, net.shibboleth.utilities.java.support.service.ServiceableComponent<ServiceRegistry>, Aware, ApplicationContextAware

public class PatternServiceRegistry
extends net.shibboleth.ext.spring.service.AbstractServiceableComponent<ServiceRegistry>
implements net.shibboleth.utilities.java.support.component.IdentifiableComponent, ServiceRegistry

Service registry that evaluates a candidate service URL against one or more defined services, where each definition contains a service URL regular expression pattern.

NOTE: This class will become an implementation component in the next major software version.

Field Summary

Fields

Modifier and Type	Field and Description
private Map<ServiceDefinition,Pattern>	definitions Map of service definitions to compiled patterns.
private Logger	log Class logger.

Constructor Summary

Constructors

Constructor and Description
PatternServiceRegistry()

Method Summary

Methods

Modifier and Type	Method and Description
ServiceRegistry	getComponent()
Service	lookup(String serviceURL) Looks up a service entry from a service URL.
void	setDefinitions(List<ServiceDefinition> definitions) Sets the list of service definitions that back the registry.
void	setId(String componentId)

Methods inherited from class net.shibboleth.ext.spring.service.AbstractServiceableComponent

doDestroy, doInitialize, getApplicationContext, pinComponent, setApplicationContext, unloadComponent, unpinComponent

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

getId

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

destroy, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.shibboleth.utilities.java.support.component.IdentifiedComponent

getId

Field Detail

log

private final Logger log

Class logger.

definitions

@Nonnull
@NonnullElements
private Map<ServiceDefinition,Pattern> definitions

Map of service definitions to compiled patterns.

Constructor Detail

PatternServiceRegistry

public PatternServiceRegistry()

Method Detail

setId

public void setId(@Nonnull
         String componentId)

Specified by:

setId in interface net.shibboleth.utilities.java.support.component.IdentifiableComponent

Overrides:

setId in class net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

setDefinitions

public void setDefinitions(@Nonnull@NonnullElements
                  List<ServiceDefinition> definitions)

Sets the list of service definitions that back the registry.

Parameters:

definitions - List of service definitions, each of which defines a match pattern to evaluate a candidate service URL.

getComponent

@Nonnull
public ServiceRegistry getComponent()

Specified by:

getComponent in interface net.shibboleth.utilities.java.support.service.ServiceableComponent<ServiceRegistry>

Specified by:

getComponent in class net.shibboleth.ext.spring.service.AbstractServiceableComponent<ServiceRegistry>

lookup

@Nullable
public Service lookup(@Nonnull
                      String serviceURL)

Description copied from interface: ServiceRegistry

Looks up a service entry from a service URL.

Specified by:

lookup in interface ServiceRegistry

Parameters:

serviceURL - Non-null CAS service URL.

Returns:

Service found in registry or null if no match found.