org.jasig.cas.services.support

Class RegisteredServiceRegexAttributeFilter

java.lang.Object

org.jasig.cas.services.support.RegisteredServiceRegexAttributeFilter

All Implemented Interfaces:

RegisteredServiceAttributeFilter

public class RegisteredServiceRegexAttributeFilter
extends Object
implements RegisteredServiceAttributeFilter

The regex filter that is responsible to make sure only attributes that match a certain regex pattern registered service are released.

Since:

4.0.0

Author:

Misagh Moayyed

Constructor Summary

Constructors

Constructor and Description
RegisteredServiceRegexAttributeFilter(String regex)

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,Object>	filter(String principalId, Map<String,Object> givenAttributes, RegisteredService registeredService) Filters the received principal attributes for the given registered service.

Methods inherited from class java.lang.Object

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

Constructor Detail

RegisteredServiceRegexAttributeFilter

public RegisteredServiceRegexAttributeFilter(String regex)

Method Detail

filter

public Map<String,Object> filter(String principalId,
                        Map<String,Object> givenAttributes,
                        RegisteredService registeredService)

Filters the received principal attributes for the given registered service. Given attribute values may be an extension of Collection, Map or an array.

• The filtering operation is non-recursive.
• Multi-valued attributes such as those of type Collection and Map are expected to allow casting to Map<String, String> or Collection<String>. Values that are of type array are expected to allow casting to String[].
• Multi-valued attributes are always put back into the final released collection of attributes as String[].
• If the final filtered collection is empty, it will not be put into the collection of attributes.

Specified by:

filter in interface RegisteredServiceAttributeFilter

Parameters:

principalId - the principal id for whom attributes are to be released

givenAttributes - the map for the original given attributes

registeredService - the registered service for which attributes are to be released

Returns:

a map that contains the filtered attributes.