org.apache.river.api.security

Class PolicyUtils

java.lang.Object

org.apache.river.api.security.PolicyUtils

class PolicyUtils
extends Object

This class consist of a number of static methods, which provide a common functionality for various policy and configuration providers.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	PolicyUtils.ExpansionFailedException Specific exception to signal that property expansion failed due to unknown key.
(package private) static interface	PolicyUtils.GeneralExpansionHandler Instances of this interface are intended for resolving generalized expansion expressions, of the form ${{protocol:data}}.
(package private) static class	PolicyUtils.SecurityPropertyAccessor Auxiliary action for accessing specific security property.
(package private) static class	PolicyUtils.URLLoader Auxiliary action for opening InputStream from specified location.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static String	FALSE Negative value of switching properties.
private static Class[]	NO_ARGS
private static Class[]	ONE_ARGS
(package private) static String	POLICY_ALLOW_DYNAMIC A key to security properties, deciding whether usage of dynamic policy location via system properties is allowed.
(package private) static String	POLICY_EXPAND A key to security properties, deciding whether expansion of system properties is allowed (in security properties values, policy files, etc).
(package private) static String	TRUE Positive value of switching properties.
private static Class[]	TWO_ARGS

Constructor Summary

Constructors

Modifier	Constructor and Description
private	PolicyUtils()

Method Summary

Modifier and Type	Method and Description
(package private) static boolean	canExpandProperties() Returns false if current security settings disable to perform properties expansion, true otherwise.
static String	expand(String str, Properties properties) Substitutes all entries like ${some.key}, found in specified string, for specified values.
(package private) static String	expandGeneral(String str, PolicyUtils.GeneralExpansionHandler handler) Substitutes all entries like ${{protocol:data}}, found in specified string, for values resolved by passed handler.
(package private) static String	expandURL(String str, Properties properties) Handy shortcut for expand(str, properties).replace(File.separatorChar, '/').
(package private) static URI	filePathToURI(String path) Converts a file path to URI without accessing file system (like {File#toURI()} does).
(package private) static URL[]	getPolicyURLs(Properties system, String systemUrlKey, String securityUrlPrefix) Obtains a list of locations for a policy or configuration provider.
(package private) static Permission	instantiatePermission(Class<?> targetType, String targetName, String targetActions) Tries to find a suitable constructor and instantiate a new Permission with specified parameters.
static boolean	matchSubset(Object[] what, Object[] where) Checks whether the objects from what array are all presented in where array.
(package private) static URI	normalizeURL(URL codebase) Normalizes URLs to standard ones, eliminating pathname symbols.
(package private) static PermissionCollection	toPermissionCollection(Collection<Permission> perms) Converts common-purpose collection of Permissions to PermissionCollection.

Methods inherited from class java.lang.Object

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

Field Detail

POLICY_ALLOW_DYNAMIC

static final String POLICY_ALLOW_DYNAMIC

A key to security properties, deciding whether usage of dynamic policy location via system properties is allowed.

See Also:

getPolicyURLs(Properties, String, String), Constant Field Values

POLICY_EXPAND

static final String POLICY_EXPAND

A key to security properties, deciding whether expansion of system properties is allowed (in security properties values, policy files, etc).

See Also:

expand(String, Properties), Constant Field Values

TRUE

static final String TRUE

Positive value of switching properties.

See Also:

Constant Field Values

FALSE

static final String FALSE

Negative value of switching properties.

See Also:

Constant Field Values

NO_ARGS

private static final Class[] NO_ARGS

ONE_ARGS

private static final Class[] ONE_ARGS

TWO_ARGS

private static final Class[] TWO_ARGS

Constructor Detail

PolicyUtils

private PolicyUtils()

Method Detail

expand

public static String expand(String str,
                            Properties properties)
                     throws PolicyUtils.ExpansionFailedException

Substitutes all entries like ${some.key}, found in specified string, for specified values. If some key is unknown, throws ExpansionFailedException.

Parameters:

str - the string to be expanded

properties - available key-value mappings

Returns:

expanded string

Throws:

PolicyUtils.ExpansionFailedException

expandURL

static String expandURL(String str,
                        Properties properties)
                 throws PolicyUtils.ExpansionFailedException

Handy shortcut for expand(str, properties).replace(File.separatorChar, '/').

Throws:

PolicyUtils.ExpansionFailedException

See Also:

expand(String, Properties)

normalizeURL

static URI normalizeURL(URL codebase)
                 throws URISyntaxException

Normalizes URLs to standard ones, eliminating pathname symbols.

Parameters:

codebase - - the original URL.

Returns:

- the normalized URL.

Throws:

URISyntaxException

filePathToURI

static URI filePathToURI(String path)
                  throws URISyntaxException

Converts a file path to URI without accessing file system (like {File#toURI()} does).

Parameters:

path - - file path.

Returns:

- the resulting URI.

Throws:

URISyntaxException

expandGeneral

static String expandGeneral(String str,
                            PolicyUtils.GeneralExpansionHandler handler)
                     throws PolicyUtils.ExpansionFailedException

Substitutes all entries like ${{protocol:data}}, found in specified string, for values resolved by passed handler. The data part may be empty, and in this case expression may have simplified form, as ${{protocol}}. If some entry cannot be resolved, throws ExpansionFailedException;

Parameters:

str - the string to be expanded

handler - the handler to resolve data denoted by protocol

Returns:

expanded string

Throws:

PolicyUtils.ExpansionFailedException

canExpandProperties

static boolean canExpandProperties()

Returns false if current security settings disable to perform properties expansion, true otherwise.

See Also:

expand(String, Properties)

getPolicyURLs

static URL[] getPolicyURLs(Properties system,
                           String systemUrlKey,
                           String securityUrlPrefix)

Obtains a list of locations for a policy or configuration provider. The search algorithm is as follows:

1. Look in security properties for keys of form prefix + n, where n is an integer and prefix is a passed parameter. Sequence starts with n=1, and keeps incrementing n until next key is not found.
   For each obtained key, try to construct an URL instance. On success, add the URL to the list; otherwise ignore it.
2. If security settings do not prohibit (through the "policy.allowSystemProperty" property) to use additional policy location, read the system property under the passed key parameter. If property exists, it may designate a file or an absolute URL. Thus, first check if there is a file with that name, and if so, convert the pathname to URL. Otherwise, try to instantiate an URL directly. If succeeded, append the URL to the list
3. If the additional location from the step above was specified to the system via "==" (i.e. starts with '='), discard all URLs above and use this only URL.

Note: all property values (both security and system) related to URLs are subject to property expansion, regardless of the "policy.expandProperties" security setting.

Parameters:

system - system properties

systemUrlKey - key to additional policy location

securityUrlPrefix - prefix to numbered locations in security properties

Returns:

array of URLs to provider's configuration files, may be empty.

toPermissionCollection

static PermissionCollection toPermissionCollection(Collection<Permission> perms)

Converts common-purpose collection of Permissions to PermissionCollection.

Parameters:

perms - a collection containing arbitrary permissions, may be null

Returns:

mutable heterogeneous PermissionCollection containing all Permissions from the specified collection

instantiatePermission

static Permission instantiatePermission(Class<?> targetType,
                                        String targetName,
                                        String targetActions)
                                 throws InstantiationException,
                                        IllegalAccessException,
                                        IllegalArgumentException,
                                        InvocationTargetException

Tries to find a suitable constructor and instantiate a new Permission with specified parameters.

Parameters:

targetType - class of expected Permission instance

targetName - name of expected Permission instance

targetActions - actions of expected Permission instance

Returns:

a new Permission instance

Throws:

IllegalArgumentException - if no suitable constructor found

Exception - any exception thrown by Constructor.newInstance()

InstantiationException

IllegalAccessException

InvocationTargetException

matchSubset

public static boolean matchSubset(Object[] what,
                                  Object[] where)

Checks whether the objects from what array are all presented in where array.

Parameters:

what - first array, may be null

where - second array, may be null

Returns:

true if the first array is null or if each and every object (ignoring null values) from the first array has a twin in the second array; false otherwise