com.sun.enterprise.security.provider

Class PolicyParser

java.lang.Object

com.sun.enterprise.security.provider.PolicyParser

public class PolicyParser
extends Object

The policy for a Java runtime (specifying which permissions are available for code from various principals) is represented as a separate persistent configuration. The configuration may be stored as a flat ASCII file, as a serialized binary file of the Policy class, or as a database.

The Java runtime creates one global Policy object, which is used to represent the static policy configuration file. It is consulted by a ProtectionDomain when the protection domain initializes its set of permissions.

The Policy init method parses the policy configuration file, and then populates the Policy object. The Policy object is agnostic in that it is not involved in making policy decisions. It is merely the Java runtime representation of the persistent policy configuration file.

When a protection domain needs to initialize its set of permissions, it executes code such as the following to ask the global Policy object to populate a Permissions object with the appropriate permissions:

  policy = Policy.getPolicy();
  Permissions perms = policy.getPermissions(protectiondomain)
 

The protection domain contains CodeSource object, which encapsulates its codebase (URL) and public key attributes. It also contains the principals associated with the domain. The Policy object evaluates the global policy in light of who the principal is and what the code source is and returns an appropriate Permissions object.

Since:

1.2

Version:

1.28, 01/14/00

Author:

Roland Schemers, Ram Marti

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PolicyParser.GrantEntry Each grant entry in the policy configuration file is represented by a GrantEntry object.
static class	PolicyParser.ParsingException
static class	PolicyParser.PermissionEntry Each permission entry in the policy configuration file is represented by a PermissionEntry object.
static class	PolicyParser.PrincipalEntry Principal info (class and name) in a grant entry

Field Summary

Fields

Modifier and Type	Field and Description
static String	REPLACE_NAME

Constructor Summary

Constructors

Constructor and Description
PolicyParser() Creates a PolicyParser object.
PolicyParser(boolean expandProp)

Method Summary

Modifier and Type	Method and Description
void	add(PolicyParser.GrantEntry ge)
String	getKeyStoreProvider()
String	getKeyStoreType()
String	getKeyStoreUrl() Returns the (possibly expanded) keystore location, or null if the expansion fails.
String	getStorePassURL()
Enumeration	grantElements() Enumerate all the entries in the global policy object.
static void	main(String[] arg)
void	read(Reader policy) Reads a policy configuration into the Policy object using a Reader object.
boolean	remove(PolicyParser.GrantEntry ge)
void	replace(PolicyParser.GrantEntry origGe, PolicyParser.GrantEntry newGe)
void	setKeyStoreProvider(String provider)
void	setKeyStoreType(String type)
void	setKeyStoreUrl(String url)
void	setStorePassURL(String storePassURL)
void	write(Writer policy) write out the policy

Methods inherited from class java.lang.Object

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

Field Detail

REPLACE_NAME

public static final String REPLACE_NAME

See Also:

Constant Field Values

Constructor Detail

PolicyParser

public PolicyParser()

Creates a PolicyParser object.

PolicyParser

public PolicyParser(boolean expandProp)

Method Detail

read

public void read(Reader policy)
          throws PolicyParser.ParsingException,
                 IOException

Reads a policy configuration into the Policy object using a Reader object.

Parameters:

policy - the policy Reader object.

Throws:

PolicyParser.ParsingException - if the policy configuration contains a syntax error.

IOException - if an error occurs while reading the policy configuration.

add

public void add(PolicyParser.GrantEntry ge)

replace

public void replace(PolicyParser.GrantEntry origGe,
                    PolicyParser.GrantEntry newGe)

remove

public boolean remove(PolicyParser.GrantEntry ge)

getKeyStoreUrl

public String getKeyStoreUrl()

Returns the (possibly expanded) keystore location, or null if the expansion fails.

setKeyStoreUrl

public void setKeyStoreUrl(String url)

getKeyStoreType

public String getKeyStoreType()

setKeyStoreType

public void setKeyStoreType(String type)

getKeyStoreProvider

public String getKeyStoreProvider()

setKeyStoreProvider

public void setKeyStoreProvider(String provider)

getStorePassURL

public String getStorePassURL()

setStorePassURL

public void setStorePassURL(String storePassURL)

grantElements

public Enumeration grantElements()

Enumerate all the entries in the global policy object. This method is used by policy admin tools. The tools should use the Enumeration methods on the returned object to fetch the elements sequentially.

write

public void write(Writer policy)

write out the policy

main

public static void main(String[] arg)
                 throws Exception

Throws:

Exception