Package org.opends.quicksetup.installer

Class NewSuffixOptions

java.lang.Object

org.opends.quicksetup.installer.NewSuffixOptions

public class NewSuffixOptions
extends Object

This class is used to provide a data model for the Data Options panel of the installer.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NewSuffixOptions.Type	This enumeration is used to know what the user wants to do for the data (import data or not, what use as source of the data...).

Method Summary

Modifier and Type	Method	Description
static NewSuffixOptions	createAutomaticallyGenerated(List<String> baseDNs, int numberEntries)	Creates an automatically generated entries suffix options.
static NewSuffixOptions	createBaseEntry(List<String> baseDNs)	Creates a base entry suffix options.
static NewSuffixOptions	createEmpty(List<String> baseDNs)	Creates an empty suffix options.
static NewSuffixOptions	createImportFromLDIF(List<String> baseDNs, List<String> ldifPaths, String rejectedFile, String skippedFile)	Creates a base entry suffix options.
LinkedList<String>	getBaseDns()	Returns the base DN of the suffix that will be created in the server.
InstallProgressStep	getInstallProgressStep()	Returns InstallProgressStep equivalent to the type of new suffix options.
LinkedList<String>	getLDIFPaths()	Returns the path of the LDIF file used to import data.
int	getNumberEntries()	Returns the number of entries that will be automatically generated.
String	getRejectedFile()	Returns the path to store the rejected entries of the import.
String	getSkippedFile()	Returns the path to store the skipped entries of the import.
NewSuffixOptions.Type	getType()	Returns the type of NewSuffixOptions represented by this object (import data or not, what use as source of the data...).

Methods inherited from class java.lang.Object

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

Method Detail

createBaseEntry

public static NewSuffixOptions createBaseEntry(List<String> baseDNs)

Creates a base entry suffix options.

Parameters:

baseDNs - the base DNs of the suffix options.

Returns:

a base entry suffix options.

createEmpty

public static NewSuffixOptions createEmpty(List<String> baseDNs)

Creates an empty suffix options.

Parameters:

baseDNs - the base DNs of the suffix options.

Returns:

an empty suffix options.

createImportFromLDIF

public static NewSuffixOptions createImportFromLDIF(List<String> baseDNs,
                                                    List<String> ldifPaths,
                                                    String rejectedFile,
                                                    String skippedFile)

Creates a base entry suffix options.

Parameters:

baseDNs - the base DNs of the suffix options.

ldifPaths - the LDIF files to be imported.

rejectedFile - the files where the rejected entries are stored.

skippedFile - the files where the skipped entries are stored.

Returns:

a base entry suffix options.

createAutomaticallyGenerated

public static NewSuffixOptions createAutomaticallyGenerated(List<String> baseDNs,
                                                            int numberEntries)

Creates an automatically generated entries suffix options.

Parameters:

baseDNs - the base DNs of the suffix options.

numberEntries - the number of entries to generate.

Returns:

a base entry suffix options.

getType

public NewSuffixOptions.Type getType()

Returns the type of NewSuffixOptions represented by this object (import data or not, what use as source of the data...).

Returns:

the type of NewSuffixOptions.

getLDIFPaths

public LinkedList<String> getLDIFPaths()

Returns the path of the LDIF file used to import data.

Returns:

the path of the LDIF file used to import data.

getRejectedFile

public String getRejectedFile()

Returns the path to store the rejected entries of the import. null if no rejected file is specified.

Returns:

the path to store the rejected entries of the import. null if no rejected file is specified.

getSkippedFile

public String getSkippedFile()

Returns the path to store the skipped entries of the import. null if no skipped file is specified.

Returns:

the path to store the skipped entries of the import. null if no skipped file is specified.

getNumberEntries

public int getNumberEntries()

Returns the number of entries that will be automatically generated.

Returns:

the number of entries that will be automatically generated.

getBaseDns

public LinkedList<String> getBaseDns()

Returns the base DN of the suffix that will be created in the server.

Returns:

the base DN of the suffix that will be created in the server.

getInstallProgressStep

public InstallProgressStep getInstallProgressStep()

Returns InstallProgressStep equivalent to the type of new suffix options.

Returns:

Returns InstallProgressStep equivalent to the type of new suffix options.