|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.types.OperationConfig
org.opends.server.types.LDIFImportConfig
@PublicAPI(stability=VOLATILE, mayInstantiate=true, mayExtend=false, mayInvoke=true) public final class LDIFImportConfig
This class defines a data structure for holding configuration information to use when performing an LDIF import.
Constructor Summary | |
---|---|
LDIFImportConfig(java.io.InputStream ldifInputStream)
Creates a new LDIF import configuration that will read from the provided input stream. |
|
LDIFImportConfig(java.util.List<java.lang.String> ldifFiles)
Creates a new LDIF import configuration that will read from the specified LDIF files. |
|
LDIFImportConfig(java.io.Reader ldifInputReader)
Creates a new LDIF import configuration that will read from the provided reader. |
|
LDIFImportConfig(java.lang.String ldifFile)
Creates a new LDIF import configuration that will read from the specified LDIF file. |
|
LDIFImportConfig(TemplateFile templateFile)
Creates a new LDIF import configuration that will generate entries using the given MakeLDIF template file rather than reading them from an existing LDIF file. |
Method Summary | |
---|---|
boolean |
appendToExistingData()
Indicates whether to append to an existing data set or completely replace it. |
boolean |
clearBackend()
Indicates whether to clear the entire backend if importing to a backend with more than one base DNs. |
void |
close()
Closes any resources that this import config might have open. |
int |
getBufferSize()
Retrieves the buffer size that should be used when reading LDIF data. |
java.util.Set<AttributeType> |
getExcludeAttributes()
Retrieves the set of attributes that should be excluded from the entries read from the LDIF. |
java.util.List<DN> |
getExcludeBranches()
Retrieves the set of base DNs that specify the set of entries to exclude from the import. |
java.util.List<SearchFilter> |
getExcludeFilters()
Retrieves the set of search filters that should be used to determine which entries to exclude from the LDIF. |
java.util.Set<AttributeType> |
getIncludeAttributes()
Retrieves the set of attributes that should be included in the entries read from the LDIF. |
java.util.List<DN> |
getIncludeBranches()
Retrieves the set of base DNs that specify the set of entries to include in the import. |
java.util.List<SearchFilter> |
getIncludeFilters()
Retrieves the set of search filters that should be used to determine which entries to include in the LDIF. |
java.io.BufferedReader |
getReader()
Retrieves the reader that should be used to read the LDIF data. |
java.io.BufferedWriter |
getRejectWriter()
Retrieves the writer that should be used to write entries that are rejected rather than imported for some reason. |
java.io.BufferedWriter |
getSkipWriter()
Retrieves the writer that should be used to write entries that are skipped because they don't match the criteri. |
boolean |
includeAttribute(AttributeType attributeType)
Indicates whether the specified attribute should be included in the entries read from the LDIF. |
boolean |
includeEntry(DN dn)
Indicates whether to include the entry with the specified DN in the import. |
boolean |
includeEntry(Entry entry)
Indicates whether the specified entry should be included in the import based on the configured set of include and exclude filters. |
boolean |
includeObjectClasses()
Indicates whether the set of objectclasses should be included in the entries read from the LDIF. |
boolean |
invokeImportPlugins()
Indicates whether any LDIF import plugins registered with the server should be invoked during the import operation. |
boolean |
isCompressed()
Indicates whether the input LDIF source is expected to be compressed. |
boolean |
isEncrypted()
Indicates whether the input LDIF source is expected to be encrypted. |
java.io.BufferedReader |
nextReader()
Retrieves the LDIF reader configured to read from the next LDIF file in the list. |
boolean |
replaceExistingEntries()
Indicates whether to replace the existing entry if a duplicate is found or to reject the new entry. |
void |
setAppendToExistingData(boolean appendToExistingData)
Specifies whether to append to an existing data set or completely replace it. |
void |
setBufferSize(int bufferSize)
Specifies the buffer size that should be used when reading LDIF data. |
void |
setClearBackend(boolean clearBackend)
Specifies whether to clear the entire backend if importing to a backend. |
void |
setCompressed(boolean isCompressed)
Specifies whether the input LDIF source is expected to be compressed. |
void |
setEncrypted(boolean isEncrypted)
Specifies whether the input LDIF source is expected to be encrypted. |
void |
setExcludeAllOperationalAttributes(boolean excludeAllOpAttrs)
Specifies whether all the operational attributes should be excluded. |
void |
setExcludeAllUserAttributes(boolean excludeAllUserAttrs)
Specifies whether all the user attributes should be excluded. |
void |
setExcludeAttributes(java.util.Set<AttributeType> excludeAttributes)
Specifies the set of attributes that should be excluded from the entries read from the LDIF. |
void |
setExcludeBranches(java.util.List<DN> excludeBranches)
Specifies the set of base DNs that specify the set of entries to exclude from the import. |
void |
setExcludeFilters(java.util.List<SearchFilter> excludeFilters)
Specifies the set of search filters that should be used to determine which entries to exclude from the LDIF. |
void |
setIncludeAllOpAttributes(boolean includeAllOpAttrs)
Specifies whether all the operational attributes should be included. |
void |
setIncludeAllUserAttributes(boolean includeAllUserAttrs)
Specifies whether all the user attributes should be included. |
void |
setIncludeAttributes(java.util.Set<AttributeType> includeAttributes)
Specifies the set of attributes that should be included in the entries read from the LDIF. |
void |
setIncludeBranches(java.util.List<DN> includeBranches)
Specifies the set of base DNs that specify the set of entries to include in the import. |
void |
setIncludeFilters(java.util.List<SearchFilter> includeFilters)
Specifies the set of search filters that should be used to determine which entries to include in the LDIF. |
void |
setIncludeObjectClasses(boolean includeObjectClasses)
Specifies whether the set of objectclasses should be included in the entries read from the LDIF. |
void |
setInvokeImportPlugins(boolean invokeImportPlugins)
Specifies whether any LDIF import plugins registered with the server should be invoked during the import operation. |
void |
setReplaceExistingEntries(boolean replaceExistingEntries)
Specifies whether to replace the existing entry if a duplicate is found or to reject the new entry. |
void |
setValidateSchema(boolean validateSchema)
Specifies whether to perform schema validation on entries as they are read. |
boolean |
validateSchema()
Indicates whether to perform schema validation on entries as they are read. |
void |
writeRejectedEntries(java.io.OutputStream outputStream)
Indicates that rejected entries should be written to the provided output stream. |
void |
writeRejectedEntries(java.lang.String rejectFile,
ExistingFileBehavior existingFileBehavior)
Indicates that rejected entries should be written to the specified file. |
void |
writeSkippedEntries(java.io.OutputStream outputStream)
Indicates that skipped entries should be written to the provided output stream. |
void |
writeSkippedEntries(java.lang.String skipFile,
ExistingFileBehavior existingFileBehavior)
Indicates that skipped entries should be written to the specified file. |
Methods inherited from class org.opends.server.types.OperationConfig |
---|
cancel, isCancelled |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public LDIFImportConfig(java.lang.String ldifFile)
ldifFile
- The path to the LDIF file with the data to
import.public LDIFImportConfig(java.util.List<java.lang.String> ldifFiles)
ldifFiles
- The paths to the LDIF files with the data to
import.public LDIFImportConfig(java.io.InputStream ldifInputStream)
ldifInputStream
- The input stream from which to read the
LDIF data.public LDIFImportConfig(java.io.Reader ldifInputReader)
ldifInputReader
- The input stream from which to read the
LDIF data.public LDIFImportConfig(TemplateFile templateFile)
templateFile
- The template file to use to generate the
entries.Method Detail |
---|
public java.io.BufferedReader getReader() throws java.io.IOException
java.io.IOException
- If a problem occurs while obtaining the
reader.public java.io.BufferedReader nextReader() throws java.io.IOException
null
if there are no more files to read.
java.io.IOException
- If a problem occurs while obtaining the
reader.public java.io.BufferedWriter getRejectWriter()
null
if none is to be
used.public java.io.BufferedWriter getSkipWriter()
null
if none is to be
used.public void writeRejectedEntries(java.lang.String rejectFile, ExistingFileBehavior existingFileBehavior) throws java.io.IOException
rejectFile
- The path to the file to which
reject information should be
written.existingFileBehavior
- Indicates how to treat an existing
file.
java.io.IOException
- If a problem occurs while opening the
reject file for writing.public void writeRejectedEntries(java.io.OutputStream outputStream)
outputStream
- The output stream to which rejected entries
should be written.public void writeSkippedEntries(java.lang.String skipFile, ExistingFileBehavior existingFileBehavior) throws java.io.IOException
skipFile
- The path to the file to which
skipped information should be
written.existingFileBehavior
- Indicates how to treat an existing
file.
java.io.IOException
- If a problem occurs while opening the
skip file for writing.public void writeSkippedEntries(java.io.OutputStream outputStream)
outputStream
- The output stream to which skipped entries
should be written.public boolean appendToExistingData()
true
if the import should append to an
existing data set, or false
if not.public void setAppendToExistingData(boolean appendToExistingData)
appendToExistingData
- Indicates whether to append to an
existing data set or completely
replace it.public boolean replaceExistingEntries()
true
if an existing entry should be
replaced with the new entry from the provided data set,
or false
if the new entry should be
rejected.public void setReplaceExistingEntries(boolean replaceExistingEntries)
replaceExistingEntries
- Indicates whether to replace the
existing entry if a duplicate is
found or to reject the new entry.public boolean invokeImportPlugins()
true
if registered LDIF import plugins
should be invoked during the import operation, or
false
if they should not be invoked.public void setInvokeImportPlugins(boolean invokeImportPlugins)
invokeImportPlugins
- Specifies whether any LDIF import
plugins registered with the server
should be invoked during the import
operation.public boolean isCompressed()
true
if the LDIF source is expected to be
compressed, or false
if not.public void setCompressed(boolean isCompressed)
getReader
.
isCompressed
- Indicates whether the input LDIF source is
expected to be compressed.public boolean isEncrypted()
true
if the LDIF source is expected to be
encrypted, or false
if not.public void setEncrypted(boolean isEncrypted)
getReader
.
isEncrypted
- Indicates whether the input LDIF source is
expected to be encrypted.public boolean clearBackend()
true
if the entire backend should be
cleared or false
if not.public void setClearBackend(boolean clearBackend)
clearBackend
- Indicates whether to clear the entire
backend.public boolean validateSchema()
true
if schema validation should be
performed on the entries as they are read, or
false
if not.public void setValidateSchema(boolean validateSchema)
validateSchema
- Indicates whether to perform schema
validation on entries as they are read.public java.util.List<DN> getExcludeBranches()
public void setExcludeBranches(java.util.List<DN> excludeBranches)
excludeBranches
- The set of base DNs that specify the set
of entries to exclude from the import.public java.util.List<DN> getIncludeBranches()
public void setIncludeBranches(java.util.List<DN> includeBranches)
includeBranches
- The set of base DNs that specify the set
of entries to include in the import.public boolean includeEntry(DN dn)
dn
- The DN of the entry for which to make the
determination.
true
if the entry with the specified DN
should be included in the import, or false
if not.public boolean includeObjectClasses()
true
if the set of objectclasses should be
included in the entries read from the LDIF, or
false
if not.public void setIncludeObjectClasses(boolean includeObjectClasses)
includeObjectClasses
- Indicates whether the set of
objectclasses should be included in
the entries read from the LDIF.public java.util.Set<AttributeType> getExcludeAttributes()
public void setExcludeAttributes(java.util.Set<AttributeType> excludeAttributes)
excludeAttributes
- The set of attributes that should be
excluded from the entries read from
the LDIF.public java.util.Set<AttributeType> getIncludeAttributes()
public void setIncludeAttributes(java.util.Set<AttributeType> includeAttributes)
includeAttributes
- The set of attributes that should be
included in the entries read from the
LDIF.public boolean includeAttribute(AttributeType attributeType)
attributeType
- The attribute type for which to make the
determination.
true
if the specified attribute should be
included in the entries read from the LDIF, or
false
if not.public java.util.List<SearchFilter> getExcludeFilters()
public void setExcludeFilters(java.util.List<SearchFilter> excludeFilters)
excludeFilters
- The set of search filters that should be
used to determine which entries to
exclude from the LDIF.public java.util.List<SearchFilter> getIncludeFilters()
public void setIncludeFilters(java.util.List<SearchFilter> includeFilters)
includeFilters
- The set of search filters that should be
used to determine which entries to
include in the LDIF.public boolean includeEntry(Entry entry) throws DirectoryException
entry
- The entry for which to make the determination.
true
if the specified entry should be
included in the import, or false
if not.
DirectoryException
- If there is a problem with any of
the search filters used to make the
determination.public int getBufferSize()
public void setBufferSize(int bufferSize)
bufferSize
- The buffer size that should be used when
reading LDIF data.public void setExcludeAllUserAttributes(boolean excludeAllUserAttrs)
excludeAllUserAttrs
- Specifies all user attributes to
be excluded.public void setExcludeAllOperationalAttributes(boolean excludeAllOpAttrs)
excludeAllOpAttrs
- Specifies whether all the
operational attributes
should be excluded.public void setIncludeAllOpAttributes(boolean includeAllOpAttrs)
includeAllOpAttrs
- Specifies whether all
the operation attributes should be included.public void setIncludeAllUserAttributes(boolean includeAllUserAttrs)
includeAllUserAttrs
- Specifies whether all the
user attributes should be
included.public void close()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |