Class StringValidationRule

    • Field Detail

      • whitelistPatterns

        protected java.util.List<java.util.regex.Pattern> whitelistPatterns
      • blacklistPatterns

        protected java.util.List<java.util.regex.Pattern> blacklistPatterns
      • minLength

        protected int minLength
      • maxLength

        protected int maxLength
    • Constructor Detail

      • StringValidationRule

        public StringValidationRule​(java.lang.String typeName)
      • StringValidationRule

        public StringValidationRule​(java.lang.String typeName,
                                    Encoder encoder)
      • StringValidationRule

        public StringValidationRule​(java.lang.String typeName,
                                    Encoder encoder,
                                    java.lang.String whitelistPattern)
    • Method Detail

      • addWhitelistPattern

        public void addWhitelistPattern​(java.lang.String pattern)
        Throws:
        java.lang.IllegalArgumentException - if pattern is null
      • addWhitelistPattern

        public void addWhitelistPattern​(java.util.regex.Pattern p)
        Throws:
        java.lang.IllegalArgumentException - if p is null
      • addBlacklistPattern

        public void addBlacklistPattern​(java.lang.String pattern)
        Throws:
        java.lang.IllegalArgumentException - if pattern is null
      • addBlacklistPattern

        public void addBlacklistPattern​(java.util.regex.Pattern p)
        Throws:
        java.lang.IllegalArgumentException - if p is null
      • setMinimumLength

        public void setMinimumLength​(int length)
      • setMaximumLength

        public void setMaximumLength​(int length)
      • setCanonicalize

        public void setCanonicalize​(boolean canonicalize)
      • getValid

        public java.lang.String getValid​(java.lang.String context,
                                         java.lang.String input)
                                  throws ValidationException
        Parse the input, throw exceptions if validation fails
        Parameters:
        context - for logging
        input - the value to be parsed
        Returns:
        a validated value
        Throws:
        ValidationException - if any validation rules fail, except if the ESAPI.properties> property "Validator.ValidationRule.getValid.ignore509Fix" is set to true, which is the default behavior for ESAPI 2.x releases. See ESAPI GitHub Issues 521 for futher details.
        See Also:
        ValidationRule.getValid(String context, String input, ValidationErrorList errorList)
      • sanitize

        public java.lang.String sanitize​(java.lang.String context,
                                         java.lang.String input)
        The method is similar to ValidationRuile.getSafe except that it returns a harmless object that may or may not have any similarity to the original input (in some cases you may not care). In most cases this should be the same as the getSafe method only instead of throwing an exception, return some default value.
        Specified by:
        sanitize in class BaseValidationRule
        Returns:
        a parsed version of the input or a default value.