weblogic.security.utils

Class ResourceUtils

java.lang.Object

weblogic.security.utils.ResourceUtils

public final class ResourceUtils
extends java.lang.Object

Excluded in public API Reference.

This class provides utility routines for working with weblogic.security.spi.Resource objects and the resource ids created by the Resource objects.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	ResourceUtils.InvocationHandlerImpl
static interface	ResourceUtils.SearchHelper

Constructor Summary

Constructors

Constructor and Description
ResourceUtils()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	escapeSearchChars(java.lang.String searchData) Escape special characters for search so they can be used in the data.
static ResourceUtils.SearchHelper	getApplicationSearchHelper(java.lang.String appName) Obtain search information for search by application name.
static ResourceUtils.SearchHelper	getChildSearchHelper(java.lang.String resourceId) Obtain search helper for finding child resources.
static ResourceUtils.SearchHelper	getComponentSearchHelper(java.lang.String compName, java.lang.String compType, java.lang.String appName) Obtain search information for search by application component.
static java.util.Map	getMapFromResourceId(java.lang.String resourceId) Get a Map of keys and key values based on a security resource identifier.
static java.lang.String[]	getParentResourceIds(java.lang.String resourceId) Get an ordered list of the parent security resource identifiers based on the supplied resource identifier.
static ResourceUtils.SearchHelper	getRepeatingActionsSearchHelper(java.lang.String resourceId) Obtain search information to find child resources with repeating actions.
static java.lang.String	getResourceIdFromMap(java.util.Map resourceData) Get a security resource identifier based on resource type and resource key values present in a Map.
static ResourceIdInfo	getResourceIdInfo(java.lang.String resType)
static java.lang.String	getResourceIdNameFilter(java.lang.String resourceId) Validate and get a searchable resource identifier.
static java.lang.String[]	getResourceKeyNames(java.lang.String resourceType) Get an ordered list of all key names for a resource type.
static java.lang.String	getResourceTypeNameFilter(java.lang.String resType) Obtain resource name filter for search by resource type.
static Resource	getScopedResource(java.lang.String resourceId) Validate and get a resource object to be used for scoped role search.
static boolean	isResourceTypeRegistered(weblogic.security.acl.internal.AuthenticatedSubject subject, ResourceIdInfo info) Check if the resource type is registered.
static java.lang.String[]	listRegisteredResourceTypes() Obtain the currently registered resource types.
static void	registerResourceType(weblogic.security.acl.internal.AuthenticatedSubject subject, ResourceIdInfo info) Register the resource type information.
static java.lang.String	unescapeChars(java.lang.String data) Unescape any special characters in the data.

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceUtils

public ResourceUtils()

Method Detail

listRegisteredResourceTypes

public static java.lang.String[] listRegisteredResourceTypes()

Obtain the currently registered resource types.

isResourceTypeRegistered

public static boolean isResourceTypeRegistered(weblogic.security.acl.internal.AuthenticatedSubject subject,
                                               ResourceIdInfo info)
                                        throws java.lang.IllegalArgumentException

Check if the resource type is registered.

Throws:

java.lang.IllegalArgumentException

registerResourceType

public static void registerResourceType(weblogic.security.acl.internal.AuthenticatedSubject subject,
                                        ResourceIdInfo info)
                                 throws java.lang.IllegalArgumentException

Register the resource type information.

Throws:

java.lang.IllegalArgumentException

getResourceIdFromMap

public static java.lang.String getResourceIdFromMap(java.util.Map resourceData)
                                             throws java.lang.IllegalArgumentException

Get a security resource identifier based on resource type and resource key values present in a Map.

Parameters:

resourceData - a Map representing security resource data.

Returns:

a String representing Resource.toString().

Throws:

java.lang.IllegalArgumentException - when unable to create a resource id because of an unknown resource type or invalid resource key.

See Also:

Resource

getMapFromResourceId

public static java.util.Map getMapFromResourceId(java.lang.String resourceId)
                                          throws java.lang.IllegalArgumentException

Get a Map of keys and key values based on a security resource identifier.

Parameters:

resourceId - a security resource identifier.

Returns:

a Map representing key values from the resource id.

Throws:

java.lang.IllegalArgumentException - for an invalid resource id.

See Also:

Resource

getResourceKeyNames

public static java.lang.String[] getResourceKeyNames(java.lang.String resourceType)
                                              throws java.lang.IllegalArgumentException

Get an ordered list of all key names for a resource type. The keys can be used to obtain values from a Map.

Parameters:

resourceType - a security resource type.

Returns:

a String[] representing the ordered list of all key names.

Throws:

java.lang.IllegalArgumentException - for an invalid resource type.

See Also:

Resource

getParentResourceIds

public static java.lang.String[] getParentResourceIds(java.lang.String resourceId)
                                               throws java.lang.IllegalArgumentException

Get an ordered list of the parent security resource identifiers based on the supplied resource identifier.

The immediate parent is located at the starting array element and an empty (zero length) array indicates no parents.

Parameters:

resourceId - a security resource identifier

Returns:

a String[] representing the parent resource identifiers

Throws:

java.lang.IllegalArgumentException - for an invalid resource id

See Also:

Resource

getResourceTypeNameFilter

public static java.lang.String getResourceTypeNameFilter(java.lang.String resType)
                                                  throws java.lang.IllegalArgumentException

Obtain resource name filter for search by resource type.

Parameters:

resType - a resource object type string

Returns:

a name filter String for searching resources of resType

Throws:

java.lang.IllegalArgumentException

getApplicationSearchHelper

public static ResourceUtils.SearchHelper getApplicationSearchHelper(java.lang.String appName)
                                                             throws java.lang.IllegalArgumentException

Obtain search information for search by application name.

Parameters:

appName - a wildcardable application name string

Returns:

a SearchHelper with the required data

Throws:

java.lang.IllegalArgumentException

getComponentSearchHelper

public static ResourceUtils.SearchHelper getComponentSearchHelper(java.lang.String compName,
                                                                  java.lang.String compType,
                                                                  java.lang.String appName)
                                                           throws java.lang.IllegalArgumentException

Obtain search information for search by application component.

Parameters:

compName - a wildcardable component name string

compType - a Java EE component type string

appName - an application name string

Returns:

a SearchHelper with the required data

Throws:

java.lang.IllegalArgumentException

getChildSearchHelper

public static ResourceUtils.SearchHelper getChildSearchHelper(java.lang.String resourceId)
                                                       throws java.lang.IllegalArgumentException

Obtain search helper for finding child resources.

Parameters:

resourceId - a security resource identifier

Returns:

a SearchHelper with the required data

Throws:

java.lang.IllegalArgumentException

getResourceIdInfo

public static ResourceIdInfo getResourceIdInfo(java.lang.String resType)

getRepeatingActionsSearchHelper

public static ResourceUtils.SearchHelper getRepeatingActionsSearchHelper(java.lang.String resourceId)
                                                                  throws java.lang.IllegalArgumentException

Obtain search information to find child resources with repeating actions.

Parameters:

resourceId - a security resource identifier

Returns:

a SearchHelper with the required data or NULL when there is nothing to search for...

Throws:

java.lang.IllegalArgumentException

getResourceIdNameFilter

public static java.lang.String getResourceIdNameFilter(java.lang.String resourceId)
                                                throws java.lang.IllegalArgumentException

Validate and get a searchable resource identifier.

Parameters:

resourceId - a security resource identifier

Returns:

a name filter String for searching resources with specified id

Throws:

java.lang.IllegalArgumentException

getScopedResource

public static Resource getScopedResource(java.lang.String resourceId)
                                  throws java.lang.IllegalArgumentException

Validate and get a resource object to be used for scoped role search.

Parameters:

resourceId - a security resource identifier

Returns:

a Resource for the resource id where null indicates search for global roles

Throws:

java.lang.IllegalArgumentException

escapeSearchChars

public static java.lang.String escapeSearchChars(java.lang.String searchData)

Escape special characters for search so they can be used in the data.

Parameters:

searchData - a string of actual search data

Returns:

a String with search chars escaped

unescapeChars

public static java.lang.String unescapeChars(java.lang.String data)

Unescape any special characters in the data.

Parameters:

data - a string of data that requires unescaping

Returns:

a String with characters unescaped