public final class DirectoryServerSetup extends FrontEndServerSetup<DirectoryServerSetup>
Modifier and Type | Class and Description |
---|---|
static class |
DirectoryServerSetup.CreateBaseEntry
Represents data needed to only generate base entry.
|
static class |
DirectoryServerSetup.ImportDataFromLdifFile
Contains data needed to import existing ldif file content in the directory server at setup.
|
static class |
DirectoryServerSetup.ImportDataMethod<T extends DirectoryServerSetup.ImportDataMethod<T>>
Represents the option chosen to import data in a local backend at setup.
|
static class |
DirectoryServerSetup.ImportSampleData
Represents data used to generate sample entries.
|
static class |
DirectoryServerSetup.LeaveDataBaseEmpty
Represents the fact that no data needs to be imported.
|
static class |
DirectoryServerSetup.LocalBackend
Represents a local backend which must be created at directory server setup.
|
JVM_TRUST_MANAGER_PROVIDER
Modifier and Type | Method and Description |
---|---|
DirectoryServerSetup |
addLocalBackend(DirectoryServerSetup.LocalBackend localBackend)
Specifies a local backend to create during this directory server setup.
|
DirectoryServerSetup |
clearLocalBackends()
Removes all
DirectoryServerSetup.LocalBackend and base DNs registered in this DirectoryServerSetup . |
DirectoryServerSetup |
clearProfiles()
Removes all
profiles registered in this DirectoryServerSetup . |
static DirectoryServerSetup.CreateBaseEntry |
createBaseEntry()
Returns the
DirectoryServerSetup.ImportDataMethod which should be used to only creates the base entry
in the baseDn created at setup. |
static DirectoryServerSetup.ImportDataFromLdifFile |
importFromLdif(List<Path> ldifFilesToImport)
Returns the
DirectoryServerSetup.ImportDataMethod which should be used to populate base Dn created at setup
with data contained in ldif file. |
static DirectoryServerSetup.ImportDataFromLdifFile |
importFromLdif(Path... ldifFilesToImport)
Returns the
DirectoryServerSetup.ImportDataMethod which should be used to populate base Dn created at setup
with data contained in ldif file. |
static DirectoryServerSetup.ImportDataFromLdifFile |
importFromLdif(String... ldifFilesToImport)
Returns the
DirectoryServerSetup.ImportDataMethod which should be used to populate base Dn created at setup
with data contained in ldif file. |
static DirectoryServerSetup.ImportSampleData |
importSampleData(int nbEntries)
Returns the
DirectoryServerSetup.ImportDataMethod which should be used to populate base Dn created at
setup with generated data. |
static DirectoryServerSetup.LeaveDataBaseEmpty |
leaveDataBaseEmpty()
Returns the
DirectoryServerSetup.ImportDataMethod which should be used to leave database created at setup empty. |
static DirectoryServerSetup.LocalBackend |
localBackend(String backendName)
Creates a new empty
DirectoryServerSetup.LocalBackend with no data to import. |
static DirectoryServerSetup |
newDirectorySetup()
Creates a new
DirectoryServerSetup object to start adding setup parameters. |
DirectoryServerSetup |
withProfiles(Collection<Profile> profilesToAdd)
Specifies the setup profiles which will be run during the setup.
|
DirectoryServerSetup |
withProfiles(Profile... profiles)
Specifies the setup profiles which will be run during the setup.
|
disableLdapConnectionHandler, disableLdapSecureConnectionHandler, enableStartTls, ldapPort, ldapPort, ldapSecurePort
adminPort, checkPortAvailability, console, disableHttpConnectionHandler, disableHttpSecureConnectionHandler, enableWindowsService, fullyQualifiedHostName, httpPort, httpSecurePort, installDirectory, installDirectory, instanceDirectory, instanceDirectory, monitorUserDn, monitorUserDn, monitorUserPassword, productionModeEnabled, rootUserDn, rootUserDn, rootUserPassword, secureWith, setup, startServer
public static DirectoryServerSetup.LeaveDataBaseEmpty leaveDataBaseEmpty()
DirectoryServerSetup.ImportDataMethod
which should be used to leave database created at setup empty.DirectoryServerSetup.ImportDataMethod
for addLocalBackend(LocalBackend)
addLocalBackend(LocalBackend)
public static DirectoryServerSetup.CreateBaseEntry createBaseEntry()
DirectoryServerSetup.ImportDataMethod
which should be used to only creates the base entry
in the baseDn created at setup.DirectoryServerSetup.ImportDataMethod
for addLocalBackend(LocalBackend)
public static DirectoryServerSetup.ImportSampleData importSampleData(int nbEntries) throws com.forgerock.opendj.cli.ArgumentException
DirectoryServerSetup.ImportDataMethod
which should be used to populate base Dn created at
setup with generated data.
You can specify more base Dns using DirectoryServerSetup.ImportDataMethod.addBaseDns(String...)
or
DirectoryServerSetup.ImportDataMethod.addBaseDns(List)
.
Each base Dn specified will be populated with the specify number of sample data.
nbEntries
- The number of sample entries to generateDirectoryServerSetup.ImportDataMethod
for addLocalBackend(LocalBackend)
com.forgerock.opendj.cli.ArgumentException
- If the provided number of entries is negativepublic static DirectoryServerSetup.ImportDataFromLdifFile importFromLdif(String... ldifFilesToImport) throws com.forgerock.opendj.cli.ArgumentException
DirectoryServerSetup.ImportDataMethod
which should be used to populate base Dn created at setup
with data contained in ldif file.ldifFilesToImport
- ldif file paths which contains entries to importDirectoryServerSetup.ImportDataMethod
for addLocalBackend(LocalBackend)
com.forgerock.opendj.cli.ArgumentException
- If one or more of the provided files are invalidpublic static DirectoryServerSetup.ImportDataFromLdifFile importFromLdif(Path... ldifFilesToImport) throws com.forgerock.opendj.cli.ArgumentException
DirectoryServerSetup.ImportDataMethod
which should be used to populate base Dn created at setup
with data contained in ldif file.ldifFilesToImport
- ldif file paths which contains entries to importDirectoryServerSetup.ImportDataMethod
for addLocalBackend(LocalBackend)
com.forgerock.opendj.cli.ArgumentException
- If one or more of the provided files are invalidpublic static DirectoryServerSetup.ImportDataFromLdifFile importFromLdif(List<Path> ldifFilesToImport) throws com.forgerock.opendj.cli.ArgumentException
DirectoryServerSetup.ImportDataMethod
which should be used to populate base Dn created at setup
with data contained in ldif file.ldifFilesToImport
- ldif file paths which contains entries to importDirectoryServerSetup.ImportDataMethod
for addLocalBackend(LocalBackend)
com.forgerock.opendj.cli.ArgumentException
- If one or more of the provided files are invalidpublic static DirectoryServerSetup.LocalBackend localBackend(String backendName)
DirectoryServerSetup.LocalBackend
with no data to import.backendName
- The name of the backend to createDirectoryServerSetup.LocalBackend
to continue building itDirectoryServerSetup.LocalBackend.importDataMethods
public static DirectoryServerSetup newDirectorySetup()
DirectoryServerSetup
object to start adding setup parameters.DirectoryServerSetup
object to start adding setup parameters.public DirectoryServerSetup addLocalBackend(DirectoryServerSetup.LocalBackend localBackend) throws com.forgerock.opendj.cli.ArgumentException
localBackend
- The local backend to createDirectoryServerSetup
objectcom.forgerock.opendj.cli.ArgumentException
- If a local backend name already exists or if some base dns to import already existspublic DirectoryServerSetup clearLocalBackends()
DirectoryServerSetup.LocalBackend
and base DNs registered in this DirectoryServerSetup
.DirectoryServerSetup
objectpublic DirectoryServerSetup withProfiles(Profile... profiles) throws com.forgerock.opendj.cli.ArgumentException
Provided profiles parameters
values must have been
resolved (with a call to Profile.resolveParameterValues(SetupConfiguration, ParameterValuesProvider)
)
before the Setup.setup()
method is used on this object.
If this directory server object already contains some profiles with the same name(s) as the provided profiles, they will be replaced by the provided profiles.
profiles
- The setup profiles
DirectoryServerSetup
objectcom.forgerock.opendj.cli.ArgumentException
- If a profile with the same name as one of the provided ones has already been registered to be setuppublic DirectoryServerSetup withProfiles(Collection<Profile> profilesToAdd) throws com.forgerock.opendj.cli.ArgumentException
Provided profiles parameters
values must have been
resolved (with a call to Profile.resolveParameterValues(SetupConfiguration, ParameterValuesProvider)
)
before the Setup.setup()
method is used on this object.
If this directory server object already contains some profiles with the same name(s) as the provided profiles, they will be replaced by the provided profiles.
profilesToAdd
- The setup profiles
DirectoryServerSetup
objectcom.forgerock.opendj.cli.ArgumentException
- If a profile with the same name as one of the provided ones has already been registered to be setuppublic DirectoryServerSetup clearProfiles()
profiles
registered in this DirectoryServerSetup
.DirectoryServerSetup
objectCopyright 2010-2022 ForgeRock AS.