Skip to content

Commit d4d93c5

Browse files
committed
Update or add javadoc for new 2.2 classes.
1 parent 2218a6e commit d4d93c5

File tree

8 files changed

+36
-0
lines changed

8 files changed

+36
-0
lines changed

src/main/java/org/owasp/esapi/configuration/AbstractPrioritizedPropertyLoader.java

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,26 @@
44
import java.io.File;
55
import java.util.Properties;
66

7+
/**
8+
* Abstrace class that supports two "levels" of priorities for ESAPI properties.
9+
* The higher level is the property file supported by an "operations" team and
10+
* the lower level is the property file intended to be supported by the
11+
* "development" team. ESAPI properties defined in the lower level properties
12+
* file cannot supersede properties defined in the higher level properties file.
13+
*
14+
* The intent os to place ESAPI properties related to enterprise-wide security
15+
* policy (e.g., the minimum sized encryption key,
16+
* <b>Encryptor.MinEncryptionKeyLength</b> in the higher level so the
17+
* development team cannot dumb down the policy, either accidentally or
18+
* intentionally. (This of course requires that the developers don't provide the
19+
* operations team the properties file for them to use. :) This is also good for
20+
* allowing the productions operations team to select property values for
21+
* properties such as <b>Encryptor.MasterKey</b> and <b>Encryptor.MasterSalt</b>
22+
* so that they are only on a "need-to-know" basis and don't accidentally get
23+
* committed to the development team's SCM repository.
24+
*
25+
* @since 2.2
26+
*
727
public abstract class AbstractPrioritizedPropertyLoader implements EsapiPropertyLoader,
828
Comparable<AbstractPrioritizedPropertyLoader> {
929

src/main/java/org/owasp/esapi/configuration/EsapiPropertyLoader.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
/**
66
* Generic interface for loading security configuration properties.
7+
*
8+
* @since 2.2
79
*/
810
public interface EsapiPropertyLoader {
911

src/main/java/org/owasp/esapi/configuration/EsapiPropertyLoaderFactory.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@
1111
/**
1212
* Factory class that takes care of initialization of proper instance of EsapiPropertyLoader
1313
* based on EsapiPropertiesStore
14+
*
15+
* @since 2.2
1416
*/
1517
public class EsapiPropertyLoaderFactory {
1618

src/main/java/org/owasp/esapi/configuration/EsapiPropertyManager.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,12 @@
1010
/**
1111
* Manager used for loading security configuration properties. Does all the logic to obtain the correct property from
1212
* correct source. Uses following system properties to find configuration files:
13+
* <pre>
1314
* - org.owasp.esapi.devteam - lower priority dev file path
1415
* - org.owasp.esapi.opsteam - higher priority ops file path
16+
* </pre>
17+
*
18+
* @since 2.2
1519
*/
1620
public class EsapiPropertyManager implements EsapiPropertyLoader {
1721

src/main/java/org/owasp/esapi/configuration/StandardEsapiPropertyLoader.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77

88
/**
99
* Loader capable of loading single security configuration property from standard java properties configuration file.
10+
*
11+
* @since 2.2
1012
*/
1113
public class StandardEsapiPropertyLoader extends AbstractPrioritizedPropertyLoader {
1214

src/main/java/org/owasp/esapi/configuration/XmlEsapiPropertyLoader.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@
2121

2222
/**
2323
* Loader capable of loading single security configuration property from xml configuration file.
24+
*
25+
* @since 2.2
2426
*/
2527
public class XmlEsapiPropertyLoader extends AbstractPrioritizedPropertyLoader {
2628

src/main/java/org/owasp/esapi/configuration/consts/EsapiConfiguration.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
/**
44
* Enum used for initialization of esapi configuration files.
5+
*
6+
* @since 2.2
57
*/
68
public enum EsapiConfiguration {
79

src/main/java/org/owasp/esapi/configuration/consts/EsapiConfigurationType.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33

44
/**
55
* Supported esapi configuration file types.
6+
*
7+
* @since 2.2
68
*/
79
public enum EsapiConfigurationType {
810
PROPERTIES("properties"), XML("xml");

0 commit comments

Comments
 (0)