164 lines
6.0 KiB
Java
164 lines
6.0 KiB
Java
/*
|
|
* Copyright (c) 1998, 2021, Oracle and/or its affiliates. All rights reserved.
|
|
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
|
*
|
|
* This code is free software; you can redistribute it and/or modify it
|
|
* under the terms of the GNU General Public License version 2 only, as
|
|
* published by the Free Software Foundation. Oracle designates this
|
|
* particular file as subject to the "Classpath" exception as provided
|
|
* by Oracle in the LICENSE file that accompanied this code.
|
|
*
|
|
* This code is distributed in the hope that it will be useful, but WITHOUT
|
|
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
* version 2 for more details (a copy is included in the LICENSE file that
|
|
* accompanied this code).
|
|
*
|
|
* You should have received a copy of the GNU General Public License version
|
|
* 2 along with this work; if not, write to the Free Software Foundation,
|
|
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
*
|
|
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
|
|
* or visit www.oracle.com if you need additional information or have any
|
|
* questions.
|
|
*/
|
|
|
|
package sun.security.action;
|
|
|
|
import java.security.AccessController;
|
|
|
|
/**
|
|
* A convenience class for retrieving the integer value of a system property
|
|
* as a privileged action.
|
|
*
|
|
* <p>An instance of this class can be used as the argument of
|
|
* <code>AccessController.doPrivileged</code>.
|
|
*
|
|
* <p>The following code retrieves the integer value of the system
|
|
* property named <code>"prop"</code> as a privileged action. Since it does
|
|
* not pass a default value to be used in case the property
|
|
* <code>"prop"</code> is not defined, it has to check the result for
|
|
* <code>null</code>:
|
|
*
|
|
* <pre>
|
|
* Integer tmp = java.security.AccessController.doPrivileged
|
|
* (new sun.security.action.GetIntegerAction("prop"));
|
|
* int i;
|
|
* if (tmp != null) {
|
|
* i = tmp.intValue();
|
|
* }
|
|
* </pre>
|
|
*
|
|
* <p>The following code retrieves the integer value of the system
|
|
* property named <code>"prop"</code> as a privileged action, and also passes
|
|
* a default value to be used in case the property <code>"prop"</code> is not
|
|
* defined:
|
|
*
|
|
* <pre>
|
|
* int i = ((Integer)java.security.AccessController.doPrivileged(
|
|
* new GetIntegerAction("prop", 3))).intValue();
|
|
* </pre>
|
|
*
|
|
* @author Roland Schemers
|
|
* @see java.security.PrivilegedAction
|
|
* @see java.security.AccessController
|
|
* @since 1.2
|
|
*/
|
|
|
|
public class GetIntegerAction
|
|
implements java.security.PrivilegedAction<Integer> {
|
|
private String theProp;
|
|
private int defaultVal;
|
|
private boolean defaultSet;
|
|
|
|
/**
|
|
* Constructor that takes the name of the system property whose integer
|
|
* value needs to be determined.
|
|
*
|
|
* @param theProp the name of the system property.
|
|
*/
|
|
public GetIntegerAction(String theProp) {
|
|
this.theProp = theProp;
|
|
}
|
|
|
|
/**
|
|
* Constructor that takes the name of the system property and the default
|
|
* value of that property.
|
|
*
|
|
* @param theProp the name of the system property.
|
|
* @param defaultVal the default value.
|
|
*/
|
|
public GetIntegerAction(String theProp, int defaultVal) {
|
|
this.theProp = theProp;
|
|
this.defaultVal = defaultVal;
|
|
this.defaultSet = true;
|
|
}
|
|
|
|
/**
|
|
* Determines the integer value of the system property whose name was
|
|
* specified in the constructor.
|
|
*
|
|
* <p>If there is no property of the specified name, or if the property
|
|
* does not have the correct numeric format, then an <code>Integer</code>
|
|
* object representing the default value that was specified in the
|
|
* constructor is returned, or <code>null</code> if no default value was
|
|
* specified.
|
|
*
|
|
* @return the <code>Integer</code> value of the property.
|
|
*/
|
|
public Integer run() {
|
|
Integer value = Integer.getInteger(theProp);
|
|
if ((value == null) && defaultSet)
|
|
return defaultVal;
|
|
return value;
|
|
}
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* @param theProp the name of the system property.
|
|
*/
|
|
@SuppressWarnings("removal")
|
|
public static Integer privilegedGetProperty(String theProp) {
|
|
if (System.getSecurityManager() == null) {
|
|
return Integer.getInteger(theProp);
|
|
} else {
|
|
return AccessController.doPrivileged(
|
|
new GetIntegerAction(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.
|
|
*
|
|
* @param theProp the name of the system property.
|
|
* @param defaultVal the default value.
|
|
*/
|
|
@SuppressWarnings("removal")
|
|
public static Integer privilegedGetProperty(String theProp,
|
|
int defaultVal) {
|
|
Integer value;
|
|
if (System.getSecurityManager() == null) {
|
|
value = Integer.getInteger(theProp);
|
|
} else {
|
|
value = AccessController.doPrivileged(
|
|
new GetIntegerAction(theProp));
|
|
}
|
|
return (value != null) ? value : defaultVal;
|
|
}
|
|
}
|