Package com.sun.identity.entitlement

Class PrefixResourceName

java.lang.Object

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

com.sun.identity.entitlement.PrefixResourceName

All Implemented Interfaces:

ResourceName, BaseResourceName<ResourceMatch,EntitlementException>

public class PrefixResourceName
extends BasePrefixResourceName<ResourceMatch,EntitlementException>
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 EntitlementException	constructResourceInvalidException(Object[] args)	Construct the exception that will be thrown if the resource is invalid during canonicalize.
protected String	normalizeRequestResource(String requestResource)	If further normalization of requestResource is required during comparison, it can be added here.
protected String	normalizeTargetResource(String targetResource)	If further normalization of targetResource is required during comparison, it can be added here.

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

append, canonicalize, compare, getServiceTypeNames, getSubResource, initialize, 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, initialize, split

Constructor Detail

PrefixResourceName

public PrefixResourceName()

empty no argument constructor.

Method Detail

normalizeRequestResource

protected String normalizeRequestResource(String requestResource)

Description copied from class: BasePrefixResourceName

If further normalization of requestResource is required during comparison, it can be added here.

Overrides:

normalizeRequestResource in class BasePrefixResourceName<ResourceMatch,EntitlementException>

Parameters:

requestResource - The target resource from the compare method.

Returns:

The normalized target resource (unmodified by default).

normalizeTargetResource

protected String normalizeTargetResource(String targetResource)

Description copied from class: BasePrefixResourceName

If further normalization of targetResource is required during comparison, it can be added here.

Overrides:

normalizeTargetResource in class BasePrefixResourceName<ResourceMatch,EntitlementException>

Parameters:

targetResource - The target resource from the compare method.

Returns:

The normalized target resource (unmodified by default).

constructResourceInvalidException

protected EntitlementException 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,EntitlementException>

Parameters:

args - The exception arguments.

Returns:

An exception.