net.unicon.persondir

Class JsonBackedComplexStubPersonAttributeDao

java.lang.Object

org.jasig.services.persondir.support.BasePersonAttributeDao

org.jasig.services.persondir.support.AbstractFlatteningPersonAttributeDao

org.jasig.services.persondir.support.AbstractDefaultAttributePersonAttributeDao

org.jasig.services.persondir.support.AbstractQueryPersonAttributeDao<String>

org.jasig.services.persondir.support.ComplexStubPersonAttributeDao

net.unicon.persondir.JsonBackedComplexStubPersonAttributeDao

All Implemented Interfaces:

EventListener, org.jasig.services.persondir.IPersonAttributeDao, org.springframework.context.ApplicationListener<net.unicon.cas.addons.support.ResourceChangeDetectingEventNotifier.ResourceChangedEvent>

public class JsonBackedComplexStubPersonAttributeDao
extends org.jasig.services.persondir.support.ComplexStubPersonAttributeDao
implements org.springframework.context.ApplicationListener<net.unicon.cas.addons.support.ResourceChangeDetectingEventNotifier.ResourceChangedEvent>

A convenient wrapper around ComplexStubPersonAttributeDao that reads the configuration for its backingMap property from an external JSON configuration resource. This class supports periodic reloading of the backingMap from the external JSON resource by listening for ResourceChangedEvents and reacting to them.

The polling of the JSON resource and detecting changes is done outside of this class.

Since:

0.1

Author:

Dmitriy Kopylenko, Unicon, inc.

Field Summary

Fields inherited from interface org.jasig.services.persondir.IPersonAttributeDao

WILDCARD, WILDCARD_PATTERN

Constructor Summary

Constructors

Constructor and Description
JsonBackedComplexStubPersonAttributeDao(org.springframework.core.io.Resource personAttributesConfigFile)

Method Summary

Methods

Modifier and Type	Method and Description
void	init() Init method un-marshals JSON representation of the person attributes.
void	onApplicationEvent(net.unicon.cas.addons.support.ResourceChangeDetectingEventNotifier.ResourceChangedEvent resourceChangedEvent) Reload person attributes when JSON config is changed.

Methods inherited from class org.jasig.services.persondir.support.ComplexStubPersonAttributeDao

appendAttributeToQuery, getAvailableQueryAttributes, getBackingMap, getPeopleForQuery, getPossibleUserAttributeNames, getQueryAttributeName, setBackingMap, setQueryAttributeName

Methods inherited from class org.jasig.services.persondir.support.AbstractQueryPersonAttributeDao

generateQuery, getConfiguredUserNameAttribute, getPeopleWithMultivaluedAttributes, getQueryAttributeMapping, getResultAttributeMapping, getUnmappedUsernameAttribute, isRequireAllQueryAttributes, isUseAllQueryAttributes, mapPersonAttributes, setQueryAttributeMapping, setRequireAllQueryAttributes, setResultAttributeMapping, setUnmappedUsernameAttribute, setUseAllQueryAttributes

Methods inherited from class org.jasig.services.persondir.support.AbstractDefaultAttributePersonAttributeDao

getPerson, getUsernameAttributeProvider, setUsernameAttributeProvider, toSeedMap

Methods inherited from class org.jasig.services.persondir.support.AbstractFlatteningPersonAttributeDao

getPeople, toMultivaluedSeed

Methods inherited from class org.jasig.services.persondir.support.BasePersonAttributeDao

flattenResults, getMultivaluedUserAttributes, getMultivaluedUserAttributes, getUserAttributes, getUserAttributes

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonBackedComplexStubPersonAttributeDao

public JsonBackedComplexStubPersonAttributeDao(org.springframework.core.io.Resource personAttributesConfigFile)

Method Detail

init

public void init()
          throws Exception

Init method un-marshals JSON representation of the person attributes.

Throws:

Exception

onApplicationEvent

public void onApplicationEvent(net.unicon.cas.addons.support.ResourceChangeDetectingEventNotifier.ResourceChangedEvent resourceChangedEvent)

Reload person attributes when JSON config is changed. In case of un-marshaling errors, or any other errors, do not disturb running CAS server by propagating the exceptions, but instead log the error and leave the previously cached person attributes state alone.

Specified by:

onApplicationEvent in interface org.springframework.context.ApplicationListener<net.unicon.cas.addons.support.ResourceChangeDetectingEventNotifier.ResourceChangedEvent>

Parameters:

resourceChangedEvent - event representing the resource change. Might not actually correspond to this JSON config file, so the URI of it needs to be checked first.