sun.security.action

Class GetPropertyAction

java.lang.Object

sun.security.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.

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

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

Since:

1.2

See Also:

PrivilegedAction, AccessController

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
static Properties	privilegedGetProperties() Convenience method to call System.getProperties without having to go through doPrivileged if no security manager is present.
static String	privilegedGetProperty(String theProp) Convenience method to get a property without going through doPrivileged if no security manager is present.
static String	privilegedGetProperty(String theProp, String defaultVal) Convenience method to get a property without going through doPrivileged if no security manager is present.
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

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.

Specified by:

run in interface PrivilegedAction<String>

Returns:

the string value of the system property, or the default value if there is no property with that key.

privilegedGetProperty

public static String privilegedGetProperty(String theProp)

Convenience method to get a property without going through doPrivileged if no security manager is present. This is unsafe for inclusion in a public API but allowable here since this class is now encapsulated. Note that this method performs a privileged action using caller-provided inputs. The caller of this method should take care to ensure that the inputs are not tainted and the returned property is not made accessible to untrusted code if it contains sensitive information.

Parameters:

theProp - the name of the system property.

privilegedGetProperty

public static String privilegedGetProperty(String theProp,
                                           String defaultVal)

Convenience method to get a property without going through doPrivileged if no security manager is present. This is unsafe for inclusion in a public API but allowable here since this class is now encapsulated. Note that this method performs a privileged action using caller-provided inputs. The caller of this method should take care to ensure that the inputs are not tainted and the returned property is not made accessible to untrusted code if it contains sensitive information.

Parameters:

theProp - the name of the system property.

defaultVal - the default value.

privilegedGetProperties

public static Properties privilegedGetProperties()

Convenience method to call System.getProperties without having to go through doPrivileged if no security manager is present. This is unsafe for inclusion in a public API but allowable here since this class is now encapsulated. Note that this method performs a privileged action, and callers of this method should take care to ensure that the returned properties are not made accessible to untrusted code since it may contain sensitive information.