com.unboundid.ldap.sdk.examples

Class ValidateLDIF

java.lang.Object

com.unboundid.util.CommandLineTool

com.unboundid.util.LDAPCommandLineTool

com.unboundid.ldap.sdk.examples.ValidateLDIF

All Implemented Interfaces:

LDIFReaderEntryTranslator

@ThreadSafety(level=NOT_THREADSAFE)
public final class ValidateLDIF
extends LDAPCommandLineTool
implements LDIFReaderEntryTranslator

This class provides a simple tool that can be used to validate that the contents of an LDIF file are valid. This includes ensuring that the contents can be parsed as valid LDIF, and it can also ensure that the LDIF content conforms to the server schema. It will obtain the schema by connecting to the server and retrieving the default schema (i.e., the schema which governs the root DSE). By default, a thorough set of validation will be performed, but it is possible to disable certain types of validation.

Some of the APIs demonstrated by this example include:

• Argument Parsing (from the com.unboundid.util.args package)
• LDAP Command-Line Tool (from the com.unboundid.util package)
• LDIF Processing (from the com.unboundid.ldif package)
• Schema Parsing (from the com.unboundid.ldap.sdk.schema package)

Supported arguments include those allowed by the LDAPCommandLineTool class (to obtain the information to use to connect to the server to read the schema), as well as the following additional arguments:

• "--schemaDirectory {path}" -- specifies the path to a directory containing files with schema definitions. If this argument is provided, then no attempt will be made to communicate with a directory server.
• "-f {path}" or "--ldifFile {path}" -- specifies the path to the LDIF file to be validated.
• "-c" or "--isCompressed" -- indicates that the LDIF file is compressed.
• "-R {path}" or "--rejectFile {path}" -- specifies the path to the file to be written with information about all entries that failed validation.
• "-t {num}" or "--numThreads {num}" -- specifies the number of concurrent threads to use when processing the LDIF. If this is not provided, then a default of one thread will be used.
• "--ignoreUndefinedObjectClasses" -- indicates that the validation process should ignore validation failures due to entries that contain object classes not defined in the server schema.
• "--ignoreUndefinedAttributes" -- indicates that the validation process should ignore validation failures due to entries that contain attributes not defined in the server schema.
• "--ignoreMalformedDNs" -- indicates that the validation process should ignore validation failures due to entries with malformed DNs.
• "--ignoreMissingRDNValues" -- indicates that the validation process should ignore validation failures due to entries that contain an RDN attribute value that is not present in the set of entry attributes.
• "--ignoreStructuralObjectClasses" -- indicates that the validation process should ignore validation failures due to entries that either do not have a structural object class or that have multiple structural object classes.
• "--ignoreProhibitedObjectClasses" -- indicates that the validation process should ignore validation failures due to entries containing auxiliary classes that are not allowed by a DIT content rule, or abstract classes that are not subclassed by an auxiliary or structural class contained in the entry.
• "--ignoreProhibitedAttributes" -- indicates that the validation process should ignore validation failures due to entries including attributes that are not allowed or are explicitly prohibited by a DIT content rule.
• "--ignoreMissingAttributes" -- indicates that the validation process should ignore validation failures due to entries missing required attributes.
• "--ignoreSingleValuedAttributes" -- indicates that the validation process should ignore validation failures due to single-valued attributes containing multiple values.
• "--ignoreAttributeSyntax" -- indicates that the validation process should ignore validation failures due to attribute values which violate the associated attribute syntax.
• "--ignoreSyntaxViolationsForAttribute" -- indicates that the validation process should ignore validation failures due to attribute values which violate the associated attribute syntax, but only for the specified attribute types.
• "--ignoreNameForms" -- indicates that the validation process should ignore validation failures due to name form violations (in which the entry's RDN does not comply with the associated name form).

Constructor Summary

Constructors

Constructor and Description
ValidateLDIF(java.io.OutputStream outStream, java.io.OutputStream errStream) Creates a new instance of this tool.

Method Summary

Modifier and Type	Method and Description
void	addNonLDAPArguments(ArgumentParser parser) Adds the arguments used by this program that aren't already provided by the generic LDAPCommandLineTool framework.
boolean	defaultsToInteractiveMode() Indicates whether this tool defaults to launching in interactive mode if the tool is invoked without any command-line arguments.
protected boolean	defaultToPromptForBindPassword() Indicates whether this tool should default to interactively prompting for the bind password if a password is required but no argument was provided to indicate how to get the password.
ResultCode	doToolProcessing() Performs the actual processing for this tool.
EntryValidator	getEntryValidator()
java.util.LinkedHashMap<java.lang.String[],java.lang.String>	getExampleUsages() Retrieves a set of information that may be used to generate example usage information.
java.lang.String	getToolDescription() Retrieves the description for this tool.
java.lang.String	getToolName() Retrieves the name for this tool.
java.lang.String	getToolVersion() Retrieves the version string for this tool.
protected boolean	includeAlternateLongIdentifiers() Indicates whether the LDAP-specific arguments should include alternate versions of all long identifiers that consist of multiple words so that they are available in both camelCase and dash-separated versions.
static void	main(java.lang.String[] args) Parse the provided command line arguments and make the appropriate set of changes.
static ResultCode	main(java.lang.String[] args, java.io.OutputStream outStream, java.io.OutputStream errStream) Parse the provided command line arguments and make the appropriate set of changes.
boolean	supportsInteractiveMode() Indicates whether this tool should provide support for an interactive mode, in which the tool offers a mode in which the arguments can be provided in a text-driven menu rather than requiring them to be given on the command line.
protected boolean	supportsOutputFile() Indicates whether this tool should provide arguments for redirecting output to a file.
boolean	supportsPropertiesFile() Indicates whether this tool supports the use of a properties file for specifying default values for arguments that aren't specified on the command line.
protected boolean	supportsSSLDebugging() Indicates whether this tool should provide a command-line argument that allows for low-level SSL debugging.
Entry	translate(Entry entry, long firstLineNumber) Examines the provided entry to determine whether it conforms to the server schema.

Methods inherited from class com.unboundid.util.LDAPCommandLineTool

addToolArguments, anyLDAPArgumentsProvided, createBindRequest, createServerSet, createSSLUtil, createSSLUtil, doExtendedArgumentValidation, doExtendedNonLDAPArgumentValidation, getBindControls, getConnection, getConnectionOptions, getConnectionOptionsWithRequestedSettings, getConnectionPool, getConnectionPool, getSuppressedShortIdentifiers, getUnauthenticatedConnection, supportsAuthentication, supportsMultipleServers, supportsSASLHelp

Methods inherited from class com.unboundid.util.CommandLineTool

addEnableSSLDebuggingArgument, createArgumentParser, doShutdownHookProcessing, err, getAdditionalDescriptionParagraphs, getErr, getMaxTrailingArguments, getMinTrailingArguments, getOriginalErr, getOriginalOut, getOut, getPasswordFileReader, getToolCompletionMessage, getTrailingArgumentsPlaceholder, logToolInvocationByDefault, out, registerShutdownHook, requestToolArgumentsInteractively, runTool, wrapErr, wrapOut

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ValidateLDIF

public ValidateLDIF(@Nullable
                    java.io.OutputStream outStream,
                    @Nullable
                    java.io.OutputStream errStream)

Creates a new instance of this tool.

Parameters:

outStream - The output stream to which standard out should be written. It may be null if output should be suppressed.

errStream - The output stream to which standard error should be written. It may be null if error messages should be suppressed.

Method Detail

main

public static void main(@NotNull
                        java.lang.String[] args)

Parse the provided command line arguments and make the appropriate set of changes.

Parameters:

args - The command line arguments provided to this program.

main

@NotNull
public static ResultCode main(@NotNull
                                       java.lang.String[] args,
                                       @Nullable
                                       java.io.OutputStream outStream,
                                       @Nullable
                                       java.io.OutputStream errStream)

Parse the provided command line arguments and make the appropriate set of changes.

Parameters:

args - The command line arguments provided to this program.

outStream - The output stream to which standard out should be written. It may be null if output should be suppressed.

errStream - The output stream to which standard error should be written. It may be null if error messages should be suppressed.

Returns:

A result code indicating whether the processing was successful.

getToolName

@NotNull
public java.lang.String getToolName()

Retrieves the name for this tool.

Specified by:

getToolName in class CommandLineTool

Returns:

The name for this tool.

getToolDescription

@NotNull
public java.lang.String getToolDescription()

Retrieves the description for this tool.

Specified by:

getToolDescription in class CommandLineTool

Returns:

The description for this tool.

getToolVersion

@NotNull
public java.lang.String getToolVersion()

Retrieves the version string for this tool.

Overrides:

getToolVersion in class CommandLineTool

Returns:

The version string for this tool.

supportsInteractiveMode

public boolean supportsInteractiveMode()

Indicates whether this tool should provide support for an interactive mode, in which the tool offers a mode in which the arguments can be provided in a text-driven menu rather than requiring them to be given on the command line. If interactive mode is supported, it may be invoked using the "--interactive" argument. Alternately, if interactive mode is supported and defaultsToInteractiveMode() returns true, then interactive mode may be invoked by simply launching the tool without any arguments.

Overrides:

supportsInteractiveMode in class CommandLineTool

Returns:

true if this tool supports interactive mode, or false if not.

defaultsToInteractiveMode

public boolean defaultsToInteractiveMode()

Indicates whether this tool defaults to launching in interactive mode if the tool is invoked without any command-line arguments. This will only be used if supportsInteractiveMode() returns true.

Overrides:

defaultsToInteractiveMode in class CommandLineTool

Returns:

true if this tool defaults to using interactive mode if launched without any command-line arguments, or false if not.

supportsOutputFile

protected boolean supportsOutputFile()

Indicates whether this tool should provide arguments for redirecting output to a file. If this method returns true, then the tool will offer an "--outputFile" argument that will specify the path to a file to which all standard output and standard error content will be written, and it will also offer a "--teeToStandardOut" argument that can only be used if the "--outputFile" argument is present and will cause all output to be written to both the specified output file and to standard output.

Overrides:

supportsOutputFile in class CommandLineTool

Returns:

true if this tool should provide arguments for redirecting output to a file, or false if not.

defaultToPromptForBindPassword

protected boolean defaultToPromptForBindPassword()

Indicates whether this tool should default to interactively prompting for the bind password if a password is required but no argument was provided to indicate how to get the password.

Overrides:

defaultToPromptForBindPassword in class LDAPCommandLineTool

Returns:

true if this tool should default to interactively prompting for the bind password, or false if not.

supportsPropertiesFile

public boolean supportsPropertiesFile()

Indicates whether this tool supports the use of a properties file for specifying default values for arguments that aren't specified on the command line.

Overrides:

supportsPropertiesFile in class CommandLineTool

Returns:

true if this tool supports the use of a properties file for specifying default values for arguments that aren't specified on the command line, or false if not.

includeAlternateLongIdentifiers

protected boolean includeAlternateLongIdentifiers()

Indicates whether the LDAP-specific arguments should include alternate versions of all long identifiers that consist of multiple words so that they are available in both camelCase and dash-separated versions.

Overrides:

includeAlternateLongIdentifiers in class LDAPCommandLineTool

Returns:

true if this tool should provide multiple versions of long identifiers for LDAP-specific arguments, or false if not.

supportsSSLDebugging

protected boolean supportsSSLDebugging()

Indicates whether this tool should provide a command-line argument that allows for low-level SSL debugging. If this returns true, then an "--enableSSLDebugging}" argument will be added that sets the "javax.net.debug" system property to "all" before attempting any communication.

Overrides:

supportsSSLDebugging in class LDAPCommandLineTool

Returns:

true if this tool should offer an "--enableSSLDebugging" argument, or false if not.

addNonLDAPArguments

public void addNonLDAPArguments(@NotNull
                                ArgumentParser parser)
                         throws ArgumentException

Adds the arguments used by this program that aren't already provided by the generic LDAPCommandLineTool framework.

Specified by:

addNonLDAPArguments in class LDAPCommandLineTool

Parameters:

parser - The argument parser to which the arguments should be added.

Throws:

ArgumentException - If a problem occurs while adding the arguments.

doToolProcessing

@NotNull
public ResultCode doToolProcessing()

Performs the actual processing for this tool. In this case, it gets a connection to the directory server and uses it to retrieve the server schema. It then reads the LDIF file and validates each entry accordingly.

Specified by:

doToolProcessing in class CommandLineTool

Returns:

The result code for the processing that was performed.

translate

@Nullable
public Entry translate(@NotNull
                                 Entry entry,
                                 long firstLineNumber)

Examines the provided entry to determine whether it conforms to the server schema.

Specified by:

translate in interface LDIFReaderEntryTranslator

Parameters:

entry - The entry to be examined.

firstLineNumber - The line number of the LDIF source on which the provided entry begins.

Returns:

The updated entry. This method will always return null because all of the real processing needed for the entry is performed in this method and the entry isn't needed any more after this method is done.

getExampleUsages

@NotNull
public java.util.LinkedHashMap<java.lang.String[],java.lang.String> getExampleUsages()

Retrieves a set of information that may be used to generate example usage information. Each element in the returned map should consist of a map between an example set of arguments and a string that describes the behavior of the tool when invoked with that set of arguments.

Overrides:

getExampleUsages in class CommandLineTool

Returns:

A set of information that may be used to generate example usage information. It may be null or empty if no example usage information is available.

getEntryValidator

@Nullable
public EntryValidator getEntryValidator()

Returns:

EntryValidator Returns the EntryValidator