A C D E F G H L M N O P R S T V W

A

ALL - Static variable in class org.dsmltools.DSMLLDAPReader
 
acceptNode(Node) - Method in class org.dsmltools.util.WhitespaceFilter
This method determines whether a node is a whitespace text node or not.
add(Document) - Method in class org.dsmltools.DSMLLDAPWriter
This method adds the entries in a Document to the directory.
argv - Variable in class gnu.getopt.Getopt
Saved argument list passed to the program
attrTypeToNode(LDAPAttributeSchema, Document) - Static method in class org.dsmltools.DSMLLDAPConverter
This function converts an LDAPAttributeSchema into the equivalent Document representation.

C

checkLongOption() - Method in class gnu.getopt.Getopt
Check to see if an option is a valid long option.
compare(Object, Object) - Method in class org.dsmltools.util.DNLengthComparator
This method compares two Objects (which should be LDAPEntry objects) and returns -1, 0 or 1 depending on the relative length of their DNs.
connect(String, int, String, String) - Method in class org.dsmltools.DSMLLDAPConnection
This function connects to an LDAP database

D

DATA - Static variable in class org.dsmltools.DSMLLDAPReader
 
DNLengthComparator - class org.dsmltools.util.DNLengthComparator.
This class implements the Comparator interface for comparing LDAPEntry objects on the basis of length of DN.
DNLengthComparator(boolean) - Constructor for class org.dsmltools.util.DNLengthComparator
Defines which way we are sorting.
DSML2LDAP - class org.dsmltools.DSML2LDAP.
This class exposes functionality to import a DSML file into a directory.
DSML2LDAP() - Constructor for class org.dsmltools.DSML2LDAP
 
DSMLDOMDiffer - class org.dsmltools.DSMLDOMDiffer.
This class implements asymmetric diffing of two DSML Documents, with the results returned as two more DSML Documents.
DSMLDOMDiffer() - Constructor for class org.dsmltools.DSMLDOMDiffer
 
DSMLDiff - class org.dsmltools.DSMLDiff.
This class exposes functionality to produce an asymmetric diff of two DSML documents.
DSMLDiff() - Constructor for class org.dsmltools.DSMLDiff
 
DSMLDocumentImpl - class org.dsmltools.DSMLDocumentImpl.
This class extends DocumentImpl, an implementation of the Document interface, to add DSML-specific functionality, such as directory-style validation.
DSMLDocumentImpl() - Constructor for class org.dsmltools.DSMLDocumentImpl
When we create new DSML documents, this constructor ensures that they will automatically have the <dsml> node.
DSMLFile - class org.dsmltools.DSMLFile.
This class does file IO for DSML documents.
DSMLFile() - Constructor for class org.dsmltools.DSMLFile
 
DSMLLDAPConnection - class org.dsmltools.DSMLLDAPConnection.
This class manages the connection to an LDAP server.
DSMLLDAPConnection() - Constructor for class org.dsmltools.DSMLLDAPConnection
 
DSMLLDAPConverter - class org.dsmltools.DSMLLDAPConverter.
 
DSMLLDAPConverter() - Constructor for class org.dsmltools.DSMLLDAPConverter
 
DSMLLDAPReader - class org.dsmltools.DSMLLDAPReader.
This class implements functionality to search an LDAP directory and return the results of the search as a DSML document.
DSMLLDAPReader() - Constructor for class org.dsmltools.DSMLLDAPReader
 
DSMLLDAPWriter - class org.dsmltools.DSMLLDAPWriter.
This class implements functionality to modify an LDAP directory based on the contents of a DSML document.
DSMLLDAPWriter() - Constructor for class org.dsmltools.DSMLLDAPWriter
 
DSMLRefException - exception org.dsmltools.DSMLRefException.
This is an exception that can be thrown when, while validating a DSML document, we come across a non-local URI ref.
DSMLRefException(String) - Constructor for class org.dsmltools.DSMLRefException
Just calls super()
DSMLValidate - class org.dsmltools.DSMLValidate.
This class reads in a DSML file, converts it to a Document, validates it, and then writes it out again.
DSMLValidate() - Constructor for class org.dsmltools.DSMLValidate
 
delete(Document) - Method in class org.dsmltools.DSMLLDAPWriter
This method removes the entries in the Document from the directory.
diff(Document, Document, DocumentImpl, DocumentImpl) - Method in class org.dsmltools.DSMLDOMDiffer
This method creates, in Document form, the diffs necessary to turn xiDoc1 into xiDoc2.
disconnect() - Method in class org.dsmltools.DSMLLDAPConnection
 

E

entryToNode(LDAPEntry, Document, LDAPSchema) - Static method in class org.dsmltools.DSMLLDAPConverter
This function converts an LDAPEntry into the equivalent Document representation.
equals(Object, Object) - Method in class org.dsmltools.util.DNLengthComparator
This method uses compare() to return a boolean if the LDAPEntries have DNs of equal length.
exchange(String[]) - Method in class gnu.getopt.Getopt
Exchange the shorter segment with the far end of the longer segment.

F

first_nonopt - Variable in class gnu.getopt.Getopt
The index of the first non-option in argv[]
flag - Variable in class gnu.getopt.LongOpt
If this variable is not null, then the value stored in "val" is stored here when this long option is encountered.

G

Getopt - class gnu.getopt.Getopt.
This is a Java port of GNU getopt, a class for parsing command line arguments passed to programs.
Getopt(String, String[], String) - Constructor for class gnu.getopt.Getopt
Construct a basic Getopt instance with the given input data.
Getopt(String, String[], String, LongOpt[]) - Constructor for class gnu.getopt.Getopt
Construct a Getopt instance with given input data that is capable of parsing long options as well as short.
Getopt(String, String[], String, LongOpt[], boolean) - Constructor for class gnu.getopt.Getopt
Construct a Getopt instance with given input data that is capable of parsing long options and short options.
getFlag() - Method in class gnu.getopt.LongOpt
Returns the value of the 'flag' field for this long option
getHasArg() - Method in class gnu.getopt.LongOpt
Returns the value set for the 'has_arg' field for this long option
getLongind() - Method in class gnu.getopt.Getopt
Returns the index into the array of long options (NOT argv) representing the long option that was found.
getName() - Method in class gnu.getopt.LongOpt
Returns the name of this LongOpt as a String
getOptarg() - Method in class gnu.getopt.Getopt
For communication from `getopt' to the caller.
getOptind() - Method in class gnu.getopt.Getopt
optind it the index in ARGV of the next element to be scanned.
getOptopt() - Method in class gnu.getopt.Getopt
When getopt() encounters an invalid option, it stores the value of that option in optopt which can be retrieved with this method.
getSubText(Node) - Static method in class org.dsmltools.DSMLLDAPConverter
This method gets the value of the first sub node of the passed in node that is a Text node.
getVal() - Method in class gnu.getopt.LongOpt
Returns the value of the 'val' field for this long option
getopt() - Method in class gnu.getopt.Getopt
This method returns a char that is the current option that has been parsed from the command line.

H

has_arg - Variable in class gnu.getopt.LongOpt
Indicates whether the option has no argument, a required argument, or an optional argument.

L

LDAP2DSML - class org.dsmltools.LDAP2DSML.
This class exposes functionality to export a DSML file from a directory.
LDAP2DSML() - Constructor for class org.dsmltools.LDAP2DSML
 
LongOpt - class gnu.getopt.LongOpt.
This object represents the definition of a long option in the Java port of GNU getopt.
LongOpt(String, int, StringBuffer, int) - Constructor for class gnu.getopt.LongOpt
Create a new LongOpt object with the given parameter values.
last_nonopt - Variable in class gnu.getopt.Getopt
The index of the last non-option in argv[]
long_only - Variable in class gnu.getopt.Getopt
This flag determines whether or not we are parsing only long args
long_options - Variable in class gnu.getopt.Getopt
This is an array of LongOpt objects which describ the valid long options.
longind - Variable in class gnu.getopt.Getopt
Stores the index into the long_options array of the long option found
longopt_handled - Variable in class gnu.getopt.Getopt
A flag which communicates whether or not checkLongOption() did all necessary processing for the current option

M

m_conn - Variable in class org.dsmltools.DSMLLDAPConnection
The object which controls the LDAP connection
main(String[]) - Static method in class org.dsmltools.DSML2LDAP
This method drives the DSML2LDAP process.
main(String[]) - Static method in class org.dsmltools.DSMLDiff
This method drives the DSMLDiff process.
main(String[]) - Static method in class org.dsmltools.DSMLValidate
This method drives the DSML2DSML process.
main(String[]) - Static method in class org.dsmltools.LDAP2DSML
This method drives the LDAP2DSML process.

N

NO_ARGUMENT - Static variable in class gnu.getopt.LongOpt
Constant value used for the "has_arg" constructor argument.
name - Variable in class gnu.getopt.LongOpt
The name of the long option
nextchar - Variable in class gnu.getopt.Getopt
The next char to be scanned in the option-element in which the last option character we returned was found.
nodeToEntry(Node) - Static method in class org.dsmltools.DSMLLDAPConverter
This function converts a Node representation of a directory entry into an LDAPEntry one.
nodeToSchema(Node) - Static method in class org.dsmltools.DSMLLDAPConverter
This method converts a Document representation of a schema, the contents of a <directory-schema> tag, to an LDAPSchema object.

O

OPTIONAL_ARGUMENT - Static variable in class gnu.getopt.LongOpt
Constant value used for the "has_arg" constructor argument.
objectclassToNode(LDAPObjectClassSchema, Document) - Static method in class org.dsmltools.DSMLLDAPConverter
This function converts an LDAPObjectClassSchema into the equivalent Document representation.
optarg - Variable in class gnu.getopt.Getopt
For communication from `getopt' to the caller.
opterr - Variable in class gnu.getopt.Getopt
Callers store false here to inhibit the error message for unrecognized options.
optind - Variable in class gnu.getopt.Getopt
Index in ARGV of the next element to be scanned.
optopt - Variable in class gnu.getopt.Getopt
When an unrecognized option is encountered, getopt will return a '?' and store the value of the invalid option here.
optstring - Variable in class gnu.getopt.Getopt
This is the string describing the valid short options.
ordering - Variable in class gnu.getopt.Getopt
Determines whether we permute arguments or not
org.dsmltools - package org.dsmltools
 
org.dsmltools.util - package org.dsmltools.util
 

P

PERMUTE - Static variable in class gnu.getopt.Getopt
PERMUTE is the default.
posixly_correct - Variable in class gnu.getopt.Getopt
The flag determines whether or not we operate in strict POSIX compliance
progname - Variable in class gnu.getopt.Getopt
Name to print as the program name in error messages.

R

REQUIRED_ARGUMENT - Static variable in class gnu.getopt.LongOpt
Constant value used for the "has_arg" constructor argument.
REQUIRE_ORDER - Static variable in class gnu.getopt.Getopt
Describe how to deal with options that follow non-option ARGV-elements.
RETURN_IN_ORDER - Static variable in class gnu.getopt.Getopt
RETURN_IN_ORDER is an option available to programs that were written to expect options and other ARGV-elements in any order and that care about the ordering of the two.
readDSML(String) - Static method in class org.dsmltools.DSMLFile
Reads DSML from a given filename, or stdin if the filename is null.

S

SCHEMA - Static variable in class org.dsmltools.DSMLLDAPReader
Constants for use in setting the value of m_contents
search(String, int, String, String[], boolean, LDAPSearchConstraints) - Method in class org.dsmltools.DSMLLDAPReader
This method has an interface like that of LDAPConnection.search, except that it returns a Document object, representing the directory information as DSML, rather than an LDAPSearchResults object.
serialize(OutputStream) - Method in class org.dsmltools.DSMLDocumentImpl
This method serializes this Document to the given OutputStream.
serialize(Document, OutputStream) - Static method in class org.dsmltools.DSMLDocumentImpl
This method takes a Document and writes its contents as a stream of DSML to the given OutputStream.
setAddComments(boolean) - Method in class org.dsmltools.DSMLDOMDiffer
This method sets whether human-readable comments are added to the Add file.
setArgv(String[]) - Method in class gnu.getopt.Getopt
Since in GNU getopt() the argument vector is passed back in to the function every time, the caller can swap out argv on the fly.
setCareful(boolean) - Method in class org.dsmltools.DSMLLDAPWriter
This method sets the Careful flag.
setContents(int) - Method in class org.dsmltools.DSMLLDAPReader
Sets what sort of output is required.
setOpterr(boolean) - Method in class gnu.getopt.Getopt
Normally Getopt will print a message to the standard error when an invalid option is encountered.
setOptind(int) - Method in class gnu.getopt.Getopt
This method allows the optind index to be set manually.
setOptstring(String) - Method in class gnu.getopt.Getopt
In GNU getopt, it is possible to change the string containg valid options on the fly because it is passed as an argument to getopt() each time.
setOutputFullSchema(boolean) - Method in class org.dsmltools.DSMLLDAPReader
Sets whether we output the full directory schema or a mini schema.

T

TAB_SIZE - Static variable in class org.dsmltools.DSMLDocumentImpl
The amount each line is indented from the previous one when a DSMLDocumentImpl is serialized.

V

val - Variable in class gnu.getopt.LongOpt
The value to store in "flag" if flag is not null, otherwise the equivalent short option character for this long option.
validate() - Method in class org.dsmltools.DSMLDocumentImpl
This function calls validate(this, null) on this Document.
validate(Document) - Static method in class org.dsmltools.DSMLDocumentImpl
This function calls validate(xiDoc, null) on this Document - in other words, validation using the Document's schema.
validate(Document, LDAPSchema) - Static method in class org.dsmltools.DSMLDocumentImpl
This function checks the directory data in the passed in Document for consistency at a directory (rather than XML) level.

W

WhitespaceFilter - class org.dsmltools.util.WhitespaceFilter.
This class is an implementation of the NodeFilter interface which passes only text nodes that contain only whitespace.
WhitespaceFilter() - Constructor for class org.dsmltools.util.WhitespaceFilter
 
writeDSML(String, Document) - Static method in class org.dsmltools.DSMLFile
Writes a given document to a given filename, or to stdout if the filename is null.

A C D E F G H L M N O P R S T V W