org.apache.river.api.security

Class DefaultPolicyParser

java.lang.Object

org.apache.river.api.security.DefaultPolicyParser

All Implemented Interfaces:

PolicyParser

public class DefaultPolicyParser
extends Object
implements PolicyParser

This is a basic loader of policy files. It delegates lexical analysis to a pluggable scanner and converts received tokens to a set of PermissionGrant's. For details of policy format, which should be identical to Sun's Java Policy files see the default policy description.
For ordinary uses, this class has just one public method parse(), which performs the main task. Extensions of this parser may redefine specific operations separately, by overriding corresponding protected methods.
This implementation is effectively thread-safe, as it has no field references to data being processed (that is, passes all the data as method parameters).

See Also:

ConcurrentPolicyFile, DefaultPolicyScanner, PermissionGrant

Constructor Summary

Constructors

Constructor and Description
DefaultPolicyParser() Default constructor, DefaultPolicyScanner is used.

Method Summary

Modifier and Type	Method and Description
Collection<PermissionGrant>	parse(URL location, Properties system) This is the main business method.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultPolicyParser

public DefaultPolicyParser()

Default constructor, DefaultPolicyScanner is used.

Method Detail

parse

public Collection<PermissionGrant> parse(URL location,
                                         Properties system)
                                  throws Exception

This is the main business method. It manages loading process as follows: the associated scanner is used to parse the stream to a set of composite tokens, then this set is iterated and each token is translated to a PermissionGrant. Semantically invalid tokens are ignored, the same as void PermissionGrant's.
A policy file may refer to some KeyStore(s), and in this case the first valid reference is initialized and used in processing tokens.

Specified by:

parse in interface PolicyParser

Parameters:

location - an URL of a policy file to be loaded

system - system properties, used for property expansion

Returns:

a collection of PermissionGrant objects, may be empty

Throws:

Exception - IO error while reading location or file syntax error