Package com.unboundid.util.args
Class LDAPURLArgumentValueValidator
- java.lang.Object
-
- com.unboundid.util.args.ArgumentValueValidator
-
- com.unboundid.util.args.LDAPURLArgumentValueValidator
-
- All Implemented Interfaces:
java.io.Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class LDAPURLArgumentValueValidator extends ArgumentValueValidator implements java.io.Serializable
This class provides an implementation of an argument value validator that is expected to be used with a string argument and ensures that all values for the argument are valid LDAP URLs. It can optionally indicate which elements are required to be present in the URL.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description LDAPURLArgumentValueValidator()
Creates a new instance of this LDAP URL argument value validator that will accept values that represent any valid LDAP URL.LDAPURLArgumentValueValidator(boolean requireHost, boolean requirePort, boolean requireBaseDN, boolean requireAttributes, boolean requireScope, boolean requireFilter)
Creates a new instance of this LDAP URL argument value validator that will accept values that represent valid LDAP URLs with the specified constraints.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
requireAttributes()
Indicates whether LDAP URL values are required to include the attributes element with at least one attribute description.boolean
requireBaseDN()
Indicates whether LDAP URL values are required to include a non-empty base DN element.boolean
requireFilter()
Indicates whether LDAP URL values are required to include the filter element.boolean
requireHost()
Indicates whether LDAP URL values are required to include the host element.boolean
requirePort()
Indicates whether LDAP URL values are required to include the port element.boolean
requireScope()
Indicates whether LDAP URL values are required to include the scope element.java.lang.String
toString()
Retrieves a string representation of this argument value validator.void
toString(java.lang.StringBuilder buffer)
Appends a string representation of this argument value validator to the provided buffer.void
validateArgumentValue(Argument argument, java.lang.String valueString)
Examines the value(s) assigned to the provided argument to determine whether they are acceptable.
-
-
-
Constructor Detail
-
LDAPURLArgumentValueValidator
public LDAPURLArgumentValueValidator()
Creates a new instance of this LDAP URL argument value validator that will accept values that represent any valid LDAP URL.
-
LDAPURLArgumentValueValidator
public LDAPURLArgumentValueValidator(boolean requireHost, boolean requirePort, boolean requireBaseDN, boolean requireAttributes, boolean requireScope, boolean requireFilter)
Creates a new instance of this LDAP URL argument value validator that will accept values that represent valid LDAP URLs with the specified constraints.- Parameters:
requireHost
- Indicates whether LDAP URL values are required to include the host element.requirePort
- Indicates whether LDAP URL values are required to include the port element.requireBaseDN
- Indicates whether LDAP URL values are required to include a non-empty base DN element.requireAttributes
- Indicates whether LDAP URL values are required to include an attribute list with at least one attribute description.requireScope
- Indicates whether LDAP URL values are required to include the scope element.requireFilter
- Indicates whether LDAP URL values are required to include the filter element.
-
-
Method Detail
-
requireHost
public boolean requireHost()
Indicates whether LDAP URL values are required to include the host element.- Returns:
true
if LDAP URL values are required to include the host element, orfalse
if not.
-
requirePort
public boolean requirePort()
Indicates whether LDAP URL values are required to include the port element.- Returns:
true
if LDAP URL values are required to include the port element, orfalse
if not.
-
requireBaseDN
public boolean requireBaseDN()
Indicates whether LDAP URL values are required to include a non-empty base DN element.- Returns:
true
if LDAP URL values are required to include a non-empty base DN element, orfalse
if not.
-
requireAttributes
public boolean requireAttributes()
Indicates whether LDAP URL values are required to include the attributes element with at least one attribute description.- Returns:
true
if LDAP URL values are required to include the attributes element, orfalse
if not.
-
requireScope
public boolean requireScope()
Indicates whether LDAP URL values are required to include the scope element.- Returns:
true
if LDAP URL values are required to include the scope element, orfalse
if not.
-
requireFilter
public boolean requireFilter()
Indicates whether LDAP URL values are required to include the filter element.- Returns:
true
if LDAP URL values are required to include the filter element, orfalse
if not.
-
validateArgumentValue
public void validateArgumentValue(@NotNull Argument argument, @NotNull java.lang.String valueString) throws ArgumentException
Examines the value(s) assigned to the provided argument to determine whether they are acceptable.- Specified by:
validateArgumentValue
in classArgumentValueValidator
- Parameters:
argument
- The argument to which the value is being provided.valueString
- The string representation of the value to be validated. This value will have already passed any normal validation performed by the argument.- Throws:
ArgumentException
- If the provided value is determined to be unacceptable.
-
toString
@NotNull public java.lang.String toString()
Retrieves a string representation of this argument value validator.- Overrides:
toString
in classjava.lang.Object
- Returns:
- A string representation of this argument value validator.
-
-