|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.util.CommandLineTool
com.unboundid.util.LDAPCommandLineTool
com.unboundid.ldap.sdk.examples.ValidateLDIF
@ThreadSafety(level=NOT_THREADSAFE) public final class ValidateLDIF
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:
com.unboundid.util.args
package)com.unboundid.util
package)com.unboundid.ldif
package)com.unboundid.ldap.sdk.schema
package)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 |
---|
public ValidateLDIF(java.io.OutputStream outStream, java.io.OutputStream errStream)
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 |
---|
public static void main(java.lang.String[] args)
args
- The command line arguments provided to this program.public static ResultCode main(java.lang.String[] args, java.io.OutputStream outStream, java.io.OutputStream errStream)
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.
public java.lang.String getToolName()
getToolName
in class CommandLineTool
public java.lang.String getToolDescription()
getToolDescription
in class CommandLineTool
public java.lang.String getToolVersion()
getToolVersion
in class CommandLineTool
public void addNonLDAPArguments(ArgumentParser parser) throws ArgumentException
LDAPCommandLineTool
framework.
addNonLDAPArguments
in class LDAPCommandLineTool
parser
- The argument parser to which the arguments should be added.
ArgumentException
- If a problem occurs while adding the arguments.public ResultCode doToolProcessing()
doToolProcessing
in class CommandLineTool
public Entry translate(Entry entry, long firstLineNumber)
translate
in interface LDIFReaderEntryTranslator
entry
- The entry to be examined.firstLineNumber
- The line number of the LDIF source on which the
provided entry begins.
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.public java.util.LinkedHashMap<java.lang.String[],java.lang.String> getExampleUsages()
getExampleUsages
in class CommandLineTool
null
or empty if no example usage
information is available.public EntryValidator getEntryValidator()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |