com.sun.identity.policy.interfaces
Interface ResourceName


public interface ResourceName

The interface ResourceManipulator provides methods to determine the hierarchy of resource names. Also it provides an interface to determine the service type to which it be used. Service developers could provide an implementation of this interface that will determine its hierarchy during policy evaluation and also its display in the GUI. A class that implements this interface must have a empty constructor.


Method Summary
 java.lang.String append(java.lang.String superResource, java.lang.String subResource)
          Appends sub-resource to super-resource.
 java.lang.String canonicalize(java.lang.String res)
          Gets the canonicalized form of a resource string
 ResourceMatch compare(java.lang.String origRes, java.lang.String compRes, boolean wildcardCompare)
          Compares two resources.
 java.util.Set getServiceTypeNames()
          Gets the service type names for which the resoure name object can be used.
 java.lang.String getSubResource(java.lang.String res, java.lang.String superRes)
          Gets sub-resource from an original resource minus a super resource.
 void initialize(java.util.Map configParams)
          Initializes the resource name with configuration information, usally set by the administrators
 java.lang.String[] split(java.lang.String res)
          Method to split a resource into the smallest necessary subresource units
 

Method Detail

getServiceTypeNames

public java.util.Set getServiceTypeNames()
Gets the service type names for which the resoure name object can be used.
Returns:
service type names for which the resource comparator can be used

initialize

public void initialize(java.util.Map configParams)
Initializes the resource name with configuration information, usally set by the administrators
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.

compare

public ResourceMatch compare(java.lang.String origRes,
                             java.lang.String compRes,
                             boolean wildcardCompare)
Compares two resources.
Parameters:
origRes - name of the resource which will be compared
compRes - name of the resource which will be compared with
wildcardCompare - flag for wildcard comparison
Returns:
returns ResourceMatch that specifies if the resources are exact match, or otherwise. ResourceMatch.NO_MATCH means two resources don't match ResourceMatch.EXACT_MATCH means two resources match ResourceMatch.SUB_RESOURCE_MATCH means compRes is the sub resource of the origRes ResourceMatch.SUPER_RESOURCE_MATCH means compRes is the super resource of the origRes ResourceMatch.WILDCARD_MATCH means two resources match with respect to the wildcard

append

public java.lang.String append(java.lang.String superResource,
                               java.lang.String subResource)
Appends sub-resource to super-resource.
Parameters:
superRes - name of the super-resource to be appended to
subRes - name of the sub-resource to be appended
Returns:
returns the combination resource.

getSubResource

public java.lang.String getSubResource(java.lang.String res,
                                       java.lang.String superRes)
Gets sub-resource from an original resource minus a super resource. This is the complementary method of append().
Parameters:
res - name of the original resource consisting of the second parameter superRes and the returned value
subRes - name of the super-resource which the first parameter begins with.
Returns:
returns the sub-resource which the first paramter ends with. If the first parameter doesn't begin with the the first parameter, then the return value is null.

canonicalize

public java.lang.String canonicalize(java.lang.String res)
                              throws PolicyException
Gets the canonicalized form of a resource string
Parameters:
res - the resource string to be canonicalized
Returns:
the resource string in its canonicalized form.
Throws:
PolicyException - if resource string is invalid

split

public java.lang.String[] split(java.lang.String res)
Method to split a resource into the smallest necessary subresource units
Parameters:
res - name of the resource to be split
Returns:
returns the array of sub-resources, with the first element being what the original resource begins with, and the last one being what it ends with