Package com.sun.identity.policy.plugins

Class PrefixResourceName

java.lang.Object

org.forgerock.openam.shared.resourcename.BasePrefixResourceName<ResourceMatch,PolicyException>

com.sun.identity.policy.plugins.PrefixResourceName

All Implemented Interfaces:

ResourceName, BaseResourceName<ResourceMatch,PolicyException>

public class PrefixResourceName
extends BasePrefixResourceName<ResourceMatch,PolicyException>
implements ResourceName

This is a plugin impelmentation of the ResourceName interface it provides methods to do resource comparisons and resource handling based on prefix based string match going left to right. This kind of pattern matching would be used by URL kind of resources.

Field Summary

Fields inherited from class org.forgerock.openam.shared.resourcename.BasePrefixResourceName

caseSensitive, debug, delimiter, exactMatch, noMatch, oneLevelWildcard, oneLevelWildcardEmbedded, oneLevelWildcardLength, subResourceMatch, superResourceMatch, wildcard, wildcardEmbedded, wildcardLength, wildcardMatch

Constructor Summary

Constructors

Constructor	Description
PrefixResourceName()	empty no argument constructor.

Method Summary

Modifier and Type	Method	Description
protected PolicyException	constructResourceInvalidException(Object[] args)	Construct the exception that will be thrown if the resource is invalid during canonicalize.
void	initialize(Map configParams)	Initializes the resource name with configuration information, usally set by the administrators.

Methods inherited from class org.forgerock.openam.shared.resourcename.BasePrefixResourceName

append, canonicalize, compare, getServiceTypeNames, getSubResource, normalizeRequestResource, normalizeTargetResource, oneLevelWildcardCompare, split

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.forgerock.openam.shared.resourcename.BaseResourceName

append, canonicalize, compare, getServiceTypeNames, getSubResource, split

Constructor Detail

PrefixResourceName

public PrefixResourceName()

empty no argument constructor.

Method Detail

initialize

public void initialize(Map configParams)

Initializes the resource name with configuration information, usally set by the administrators. The main configration information retrived is mainly like wild card pattern used, one level wild card pattern used, case sensitivity etc.

Specified by:

initialize in interface BaseResourceName<ResourceMatch,PolicyException>

Overrides:

initialize in class BasePrefixResourceName<ResourceMatch,PolicyException>

Parameters:

configParams - configuration parameters as a map. The keys of the map are the configuration paramaters. Each key is corresponding to one String value which specifies the configuration paramater value.

constructResourceInvalidException

protected PolicyException constructResourceInvalidException(Object[] args)

Description copied from class: BasePrefixResourceName

Construct the exception that will be thrown if the resource is invalid during canonicalize.

Specified by:

constructResourceInvalidException in class BasePrefixResourceName<ResourceMatch,PolicyException>

Parameters:

args - The exception arguments.

Returns:

An exception.