org.apache.river.action

Class GetPropertyAction

java.lang.Object

org.apache.river.action.GetPropertyAction

All Implemented Interfaces:

PrivilegedAction<String>

public class GetPropertyAction
extends Object
implements PrivilegedAction<String>

A convenience class for retrieving the string value of a system property as a privileged action.

An instance of this class can be used as the argument of AccessController.doPrivileged or Security.doPrivileged.

The following code retrieves the value of the system property named "prop" as a privileged action:

 String s = (String) String.doPrivileged(
                 new GetPropertyAction("prop"));
 

If the protection domain of the immediate caller of doPrivileged or the protection domain of this class does not imply the permissions necessary for the operation, the behavior is as if the system property is not defined.

Since:

2.0

Author:

Sun Microsystems, Inc.

See Also:

PrivilegedAction, AccessController, Security

Field Summary

Fields

Modifier and Type	Field and Description
private String	defaultVal
private static Logger	logger
private String	theProp

Constructor Summary

Constructors

Constructor and Description
GetPropertyAction(String theProp) Constructor that takes the name of the system property whose string value needs to be determined.
GetPropertyAction(String theProp, String defaultVal) Constructor that takes the name of the system property and the default value of that property.

Method Summary

Modifier and Type	Method and Description
String	run() Determines the string value of the system property whose name was specified in the constructor.

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final Logger logger

theProp

private final String theProp

defaultVal

private final String defaultVal

Constructor Detail

GetPropertyAction

public GetPropertyAction(String theProp)

Constructor that takes the name of the system property whose string value needs to be determined.

Parameters:

theProp - the name of the system property

GetPropertyAction

public GetPropertyAction(String theProp,
                         String defaultVal)

Constructor that takes the name of the system property and the default value of that property.

Parameters:

theProp - the name of the system property

defaultVal - the default value

Method Detail

run

public String run()

Determines the string value of the system property whose name was specified in the constructor.

If the system property is defined, then this method returns its value. Otherwise, if a default value was supplied to this object's constructor, then this method returns that default value, or else null is returned.

Specified by:

run in interface PrivilegedAction<String>

Returns:

the string value of the system property or the default value, or null