com.sun.identity.entitlement

Class URLResourceName

java.lang.Object

org.forgerock.openam.shared.resourcename.BasePrefixResourceName<T,E>

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

com.sun.identity.entitlement.URLResourceName

All Implemented Interfaces:

ResourceName, BaseResourceName<ResourceMatch,EntitlementException>

public class URLResourceName
extends BaseURLResourceName<ResourceMatch,EntitlementException>
implements ResourceName

This plugin extends the functionality provided in PrefixResourceName to provide special handling to URL type prefix resource names in canonicalize method like validating port, assigning default port of 80, if port absent etc.

Field Summary

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

comparator

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 and Description
URLResourceName() empty no argument constructor.

Method Summary

Modifier and Type	Method and 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.BaseURLResourceName

canonicalize, compare

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

append, 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

URLResourceName

public URLResourceName()

empty no argument constructor.

Method Detail

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.

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).