com.unboundid.ldap.sdk.examples
Class ValidateLDIF

java.lang.Object
  extended by com.unboundid.util.CommandLineTool
      extended by com.unboundid.util.LDAPCommandLineTool
          extended by 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:



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:


Constructor Summary
ValidateLDIF(java.io.OutputStream outStream, java.io.OutputStream errStream)
          Creates a new instance of this tool.
 
Method Summary
 void addNonLDAPArguments(ArgumentParser parser)
          Adds the arguments used by this program that aren't already provided by the generic LDAPCommandLineTool framework.
 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.
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.
 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, createBindRequest, createServerSet, createSSLUtil, createSSLUtil, doExtendedArgumentValidation, doExtendedNonLDAPArgumentValidation, getBindControls, getConnection, getConnectionOptions, getConnectionPool, getUnauthenticatedConnection, supportsAuthentication, supportsMultipleServers
 
Methods inherited from class com.unboundid.util.CommandLineTool
createArgumentParser, doShutdownHookProcessing, err, getErr, getMaxTrailingArguments, getOut, getTrailingArgumentsPlaceholder, out, registerShutdownHook, 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(java.io.OutputStream outStream,
                    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(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

public 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.

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

public java.lang.String getToolName()
Retrieves the name for this tool.

Specified by:
getToolName in class CommandLineTool
Returns:
The name for this tool.

getToolDescription

public java.lang.String getToolDescription()
Retrieves the description for this tool.

Specified by:
getToolDescription in class CommandLineTool
Returns:
The description for this tool.

getToolVersion

public java.lang.String getToolVersion()
Retrieves the version string for this tool.

Overrides:
getToolVersion in class CommandLineTool
Returns:
The version string for this tool.

addNonLDAPArguments

public void addNonLDAPArguments(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

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

public Entry translate(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

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

public EntryValidator getEntryValidator()
Returns:
EntryValidator Returns the EntryValidator