com.dtolabs.rundeck.core.plugins.configuration
Class Validator

java.lang.Object
  extended by com.dtolabs.rundeck.core.plugins.configuration.Validator

public class Validator
extends java.lang.Object

Validator utility class can create a validation report for a set of input properties and a configuration description.


Nested Class Summary
static class Validator.Report
          A validation report
 
Constructor Summary
Validator()
           
 
Method Summary
static java.util.Map<java.lang.String,java.lang.String> demapProperties(java.util.Map<java.lang.String,java.lang.String> input, Description desc)
          Reverses a set of properties mapped using the description's configuration to property mapping, or the same input if the description has no mapping
static java.util.Map<java.lang.String,java.lang.String> mapProperties(java.util.Map<java.lang.String,java.lang.String> input, Description desc)
          Converts a set of input configuration keys using the description's configuration to property mapping, or the same input if the description has no mapping
static Validator.Report validate(java.util.Properties props, Description desc)
          Validate a set of properties for a description, and return a report.
static Validator.Report validate(PropertyResolver resolver, Description description, PropertyScope defaultScope)
          Validate a set of properties for a description, and return a report.
static Validator.Report validate(PropertyResolver resolver, Description description, PropertyScope defaultScope, PropertyScope ignoredScope)
          Validate a set of properties for a description, and return a report.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Validator

public Validator()
Method Detail

validate

public static Validator.Report validate(java.util.Properties props,
                                        Description desc)
Validate a set of properties for a description, and return a report.

Parameters:
props - the input properties
desc - the configuration description
Returns:
the validation report

validate

public static Validator.Report validate(PropertyResolver resolver,
                                        Description description,
                                        PropertyScope defaultScope)
Validate a set of properties for a description, and return a report.

Parameters:
resolver - property resolver
description - description
defaultScope - default scope for properties
Returns:
the validation report

validate

public static Validator.Report validate(PropertyResolver resolver,
                                        Description description,
                                        PropertyScope defaultScope,
                                        PropertyScope ignoredScope)
Validate a set of properties for a description, and return a report.

Parameters:
resolver - property resolver
description - description
defaultScope - default scope for properties
ignoredScope - ignore properties at or below this scope, or null to ignore none
Returns:
the validation report

mapProperties

public static java.util.Map<java.lang.String,java.lang.String> mapProperties(java.util.Map<java.lang.String,java.lang.String> input,
                                                                             Description desc)
Converts a set of input configuration keys using the description's configuration to property mapping, or the same input if the description has no mapping


demapProperties

public static java.util.Map<java.lang.String,java.lang.String> demapProperties(java.util.Map<java.lang.String,java.lang.String> input,
                                                                               Description desc)
Reverses a set of properties mapped using the description's configuration to property mapping, or the same input if the description has no mapping