Uses of Class
org.forgerock.opendj.setup.model.Setup

Packages that use Setup

Package	Description
org.forgerock.opendj.server.embedded	Provides support for an embedded directory server.
org.forgerock.opendj.setup.model	Contains code of the opendj setup model.

Uses of Setup in org.forgerock.opendj.server.embedded

Methods in org.forgerock.opendj.server.embedded that return Setup

Modifier and Type	Method	Description
Setup	EmbeddedDirectoryServer.initializeConfiguration()	Creates a directory server setup object pre-initialized with configuration and connection parameters provided while creating this embedded directory server and returns the setup object to allow further configuration actions such as backend creation or profile setup.

Uses of Setup in org.forgerock.opendj.setup.model

Methods in org.forgerock.opendj.setup.model that return Setup

Modifier and Type	Method	Description
Setup	Setup.adminPort(int adminPort)	Specifies the administration port of the instance to setup.
Setup	Setup.bootstrapReplicationServers(com.forgerock.opendj.util.HostPort... bootstrapReplicationServers)	Specifies the addresses of replication servers to which the server will try to connect at startup time.
Setup	Setup.bootstrapReplicationServers(String... bootstrapReplicationServers)	Specifies the addresses of replication servers to which the server will try to connect at startup time.
Setup	Setup.bootstrapReplicationServers(Collection<com.forgerock.opendj.util.HostPort> bootstrapReplicationServers)	Specifies the addresses of replication servers to which the server will try to connect at startup time.
Setup	Setup.checkPortAvailability(boolean checkPortAvailability)	Specifies whether the port availability should be verified during the validation phase.
Setup	Setup.clearBootstrapReplicationServers()	Removes all bootstrapReplicationServers(HostPort...) bootstrap replication servers} registered in this Setup.
Setup	Setup.clearProfiles()	Removes all profiles registered in this Setup.
Setup	Setup.console(SetupConsole console)	Specifies the SetupConsole which be used to print information issued during setup.
Setup	Setup.deploymentId(String key, String password, Consumer<LocalizableMessage> warningHandler)	Specifies the DeploymentId which should be used for securing the deployment.
Setup	Setup.deploymentId(DeploymentId deploymentId)	Specifies the DeploymentId which should be used for securing the deployment.
Setup	Setup.disableHttpConnectionHandler()	Disables the HTTP connection handler.
Setup	Setup.disableHttpSecureConnectionHandler()	Disables the HTTPS connection handler.
Setup	Setup.disableLdapConnectionHandler()	Disables the LDAP connection handler.
Setup	Setup.disableLdapSecureConnectionHandler()	Disables the LDAPS connection handler.
Setup	Setup.disableMonitorUserCreation()	Specifies that a monitor user must not be created in the DS server to be setup.
Setup	Setup.enableCloudBackups(boolean enableCloudBackups)	Specifies whether the OpenDJ Cloud Backup feature should be enabled.
Setup	Setup.enableStartTls(boolean enableStartTls)	Specifies whether start TLS should be enabled on the LDAP connection handler.
Setup	Setup.enableWindowsService(boolean enableWindowsService)	Specifies whether the OpenDJ windows service should be enabled.
Setup	Setup.fullyQualifiedHostName(String fullyQualifiedHostName)	Specifies the fully qualified hostname of the server to setup.
Setup	Setup.httpPort(int httpPort)	Specifies that the http connection handler must be enabled and listening on the provided port.
Setup	Setup.httpSecurePort(int httpSecurePort)	Specifies that the https connection handler must be enabled and listening on the provided port.
Setup	Setup.installDirectory(String installDirectory)	Specifies the path of the OpenDJ archive to use to setup the server instance.
Setup	Setup.installDirectory(Path installPath)	Specifies the path of the OpenDJ archive to use to setup the server instance.
Setup	Setup.instanceDirectory(String instanceDirectory)	Specifies the path of the OpenDJ instance to setup.
Setup	Setup.instanceDirectory(Path instancePath)	Specifies the path of the opendj instance to setup.
Setup	Setup.ldapPort(int ldapPort)	Specifies that the ldap connection handler must be enabled and listening on the provided port.
Setup	Setup.ldapPort(int ldapPort, boolean enableStartTls)	Specifies that the ldap connection handler must be enabled and listening on the provided port and whether start TLS should be enabled.
Setup	Setup.ldapSecurePort(int ldapSecurePort)	Specifies that the ldaps connection handler must be enabled and listening on the provided port.
Setup	Setup.monitorUserDn(String monitorUserDn)	Specifies the DN of the monitor user, having access to monitor information.
Setup	Setup.monitorUserDn(Dn monitorUserDn)	Specifies the DN of the monitor user, having access to monitor information.
Setup	Setup.monitorUserPassword(String monitorUserPassword)	Specifies the password of the monitor user.
static Setup	Setup.newSetup()	Creates a new Setup object to start adding setup parameters.
Setup	Setup.replicationPort(int replicationPort)	Specifies that the instance to setup will be configured with a replication server listening on the provided port number.
Setup	Setup.rootUserDn(String rootUserDn)	Specifies the user root distinguish name of the instance to setup.
Setup	Setup.rootUserDn(Dn rootUserDn)	Specifies the user root distinguish name of the instance to setup.
Setup	Setup.rootUserPassword(String rootUserPassword)	Specifies the user root password of the instance to setup.
Setup	Setup.serverId(String serverId)	Specifies the server ID.
Setup	Setup.startServer(boolean startServer)	Specifies whether the server should start during the setup process.
Setup	Setup.useDeploymentIdForTls()	Specifies that peer-to-peer communications will be secured with certificates derived from the deployment ID.
Setup	Setup.useExistingCertificatesForTls(Security.KeyStoreModel keyStore, Security.TrustStoreModel trustStore)	Specifies that peer-to-peer communications will be secured with certificates located in the user-provided key and trust store.
Setup	Setup.withProfiles(Collection<Profile> profilesToAdd)	Specifies the setup profiles which will be run during the setup.
Setup	Setup.withProfiles(Profile... profiles)	Specifies the setup profiles which will be run during the setup.