public class UserData extends Object
Modifier and Type | Field and Description |
---|---|
static String |
IMPORT_SCRIPT_NAME
The script name to be used to get and set the java arguments for the (off-line) import.
|
static String |
SERVER_SCRIPT_NAME
The script name to be used to get and set the java arguments for the server runtime.
|
Constructor and Description |
---|
UserData()
Creates a user data object with default values.
|
Modifier and Type | Method and Description |
---|---|
void |
createAdministrator(boolean createAdministrator)
Sets whether must create a global administrator or not.
|
int |
getAdminConnectorPort()
Returns the admin connector port.
|
org.forgerock.opendj.config.ManagedObjectDefinition<? extends org.forgerock.opendj.server.config.client.BackendCfgClient,? extends org.forgerock.opendj.server.config.server.BackendCfg> |
getBackendType()
Returns the new userRoot backend type.
|
int |
getConnectTimeout()
Returns the timeout to be used to connect in milliseconds.
|
static int |
getDefaultAdminConnectorPort()
Provides the administration port that will be proposed to the user in the
second page of the installation wizard.
|
JavaArguments |
getDefaultJavaArguments(String scriptName)
Returns the default java arguments associated with a script name.
|
static int |
getDefaultJMXPort(int[] forbiddenPorts)
Provides the port that will be used by default for JMX.
|
static int |
getDefaultPort()
Provides the port that will be proposed to the user in the second page of
the installation wizard.
|
static int |
getDefaultSslPort(int defaultLdapPort)
Provides the port that will be proposed to the user in the security dialog
of the installation wizard.
|
org.forgerock.opendj.ldap.Dn |
getDirectoryManagerDn()
Returns the Directory Manager DN.
|
String |
getDirectoryManagerPwd()
Returns the Directory Manager password.
|
boolean |
getEnableWindowsService()
Returns
true if the windows service must be enabled during
installation, false if not. |
String |
getGlobalAdministratorPassword()
Returns the password of the global administrator.
|
String |
getGlobalAdministratorUID()
Returns the UID of the global administrator.
|
String |
getHostName()
Returns the server host name.
|
HostPort |
getHostPort()
Returns the server host name and LDAP port.
|
JavaArguments |
getJavaArguments(String scriptName)
Returns the java arguments associated with a script name.
|
NewSuffixOptions |
getNewSuffixOptions()
Returns the NewSuffixOptions object representing the data in the New Suffix
Data Options panel.
|
Map<ServerDescriptor,AuthenticationData> |
getRemoteWithNoReplicationPort()
Returns a Map containing as key a ServerDescriptor and as value an Integer
corresponding to the Replication Port chosen by the user.
|
DataReplicationOptions |
getReplicationOptions()
Returns the DataReplicationOptions object representing the data in the
Data Replication panel.
|
Set<String> |
getScriptNamesForJavaArguments()
Returns the different script names for which there are java arguments.
|
SecurityOptions |
getSecurityOptions()
Returns the SecurityOptions representing the SSL/StartTLS configuration
chosen by the user.
|
int |
getServerJMXPort()
Returns the server JMX port.
|
String |
getServerLocation()
Returns the location of the server (installation path).
|
int |
getServerPort()
Returns the server LDAP port.
|
boolean |
getStartServer()
Returns
true if the server must be started once the
installation is finished, false if not. |
boolean |
getStopServer()
Returns whether the user wants to stop the server or not.
|
SuffixesToReplicateOptions |
getSuffixesToReplicateOptions()
Returns the suffixes to replicate options.
|
boolean |
isForceOnError()
Indicates whether the user has requested to continue when a non
critical error occurs.
|
boolean |
isInteractive()
Indicates whether the user has requested interactive mode.
|
boolean |
isQuiet()
Indicates whether the user has requested quiet mode.
|
boolean |
isVerbose()
Indicates whether the user has requested verbose mode.
|
boolean |
mustCreateAdministrator()
Returns whether must create a global administrator or not.
|
void |
setAdminConnectorPort(int adminConnectorPort)
Sets the admin connector port.
|
void |
setBackendType(org.forgerock.opendj.config.ManagedObjectDefinition<? extends org.forgerock.opendj.server.config.client.BackendCfgClient,? extends org.forgerock.opendj.server.config.server.BackendCfg> backendType)
Sets the new userRoot backend type.
|
void |
setConnectTimeout(int connectTimeout)
Sets the timeout to be used to establish a connection.
|
void |
setDirectoryManagerDn(org.forgerock.opendj.ldap.Dn directoryManagerDn)
Sets the new Directory Manager DN.
|
void |
setDirectoryManagerPwd(String directoryManagerPwd)
Sets the new Directory Manager password.
|
void |
setEnableWindowsService(boolean enableWindowsService)
Sets whether we want to enable windows service during installation or not.
|
void |
setForceOnError(boolean forceOnError)
Sets whether we must continue when there is a non critical error.
|
void |
setGlobalAdministratorPassword(String globalAdministratorPwd)
Sets the password of the global administrator.
|
void |
setGlobalAdministratorUID(String globalAdministratorUID)
Sets the UID of the global administrator.
|
void |
setHostName(String hostName)
Sets the host name.
|
void |
setJavaArguments(String scriptName,
JavaArguments args)
Sets the java arguments associated with a script name.
|
void |
setNewSuffixOptions(NewSuffixOptions newSuffixOptions)
Sets the NewSuffixOptions object representing the data in the New Suffix
Data Options panel.
|
void |
setQuiet(boolean quiet)
Sets whether this session should print messages to the
console if in CLI mode.
|
void |
setRemoteWithNoReplicationPort(Map<ServerDescriptor,AuthenticationData> remoteWithNoReplicationPort)
Sets a the Replication Ports chosen by the user in the remote servers.
|
void |
setReplicationOptions(DataReplicationOptions replicationOptions)
Sets the DataReplicationOptions object representing the data in the
Data Replication panel.
|
void |
setSecurityOptions(SecurityOptions securityOptions)
Sets the SecurityOptions representing the SSL/StartTLS configuration
chosen by the user.
|
void |
setServerJMXPort(int serverJMXPort)
Sets the server JMX port.
|
void |
setServerLocation(String serverLocation)
Sets the location of the server (installation path).
|
void |
setServerPort(int serverPort)
Sets the server LDAP port.
|
void |
setStartServer(boolean startServer)
Sets whether we want to start the server once the installation is finished
or not.
|
void |
setStopServer(boolean stopServer)
Sets whether to stop the server or not.
|
void |
setSuffixesToReplicateOptions(SuffixesToReplicateOptions suffixesToReplicateOptions)
Sets the suffixes to replicate options.
|
void |
setVerbose(boolean verbose)
Sets whether this session should be verbose.
|
public static final String SERVER_SCRIPT_NAME
public static final String IMPORT_SCRIPT_NAME
public UserData()
public void setServerLocation(String serverLocation)
serverLocation
- the new server location (installation path).public String getServerLocation()
public void setHostName(String hostName)
hostName
- the server host name.public String getHostName()
public HostPort getHostPort()
public void setServerPort(int serverPort)
serverPort
- the new server LDAP port.public int getServerPort()
public void setAdminConnectorPort(int adminConnectorPort)
adminConnectorPort
- the new admin connector port.public int getAdminConnectorPort()
public void setServerJMXPort(int serverJMXPort)
serverJMXPort
- the new server JMX port.public int getServerJMXPort()
public org.forgerock.opendj.ldap.Dn getDirectoryManagerDn()
public void setDirectoryManagerDn(org.forgerock.opendj.ldap.Dn directoryManagerDn)
directoryManagerDn
- the new Directory Manager DN.public String getDirectoryManagerPwd()
public void setDirectoryManagerPwd(String directoryManagerPwd)
directoryManagerPwd
- the new Directory Manager password.public boolean getStartServer()
true
if the server must be started once the
installation is finished, false
if not.true
if the server must be started once the
installation is finished, false
if not.public void setStartServer(boolean startServer)
startServer
- the boolean indicating whether to start the server or
not.public void setStopServer(boolean stopServer)
stopServer
- stop the server or not.public boolean getStopServer()
true
if the user wants to stop the server and \
false
otherwise.public boolean getEnableWindowsService()
true
if the windows service must be enabled during
installation, false
if not.true
if the windows service must be enabled during
installation, false
if not.public void setEnableWindowsService(boolean enableWindowsService)
enableWindowsService
- the boolean indicating whether we want to
enable windows service during installation or not.public org.forgerock.opendj.config.ManagedObjectDefinition<? extends org.forgerock.opendj.server.config.client.BackendCfgClient,? extends org.forgerock.opendj.server.config.server.BackendCfg> getBackendType()
public void setBackendType(org.forgerock.opendj.config.ManagedObjectDefinition<? extends org.forgerock.opendj.server.config.client.BackendCfgClient,? extends org.forgerock.opendj.server.config.server.BackendCfg> backendType)
backendType
- The new backend type. This string must be compatible with
dsconfig tool.public NewSuffixOptions getNewSuffixOptions()
public void setNewSuffixOptions(NewSuffixOptions newSuffixOptions)
newSuffixOptions
- the NewSuffixOptions object representing the data
in the New Suffix Data Options panel.public DataReplicationOptions getReplicationOptions()
public void setReplicationOptions(DataReplicationOptions replicationOptions)
replicationOptions
- the DataReplicationOptions object
representing the data in the Data Replication panel.public boolean mustCreateAdministrator()
true
if we must create a global administrator and
false
otherwise.public void createAdministrator(boolean createAdministrator)
createAdministrator
- whether we must create a global administrator or
not.public String getGlobalAdministratorUID()
public void setGlobalAdministratorUID(String globalAdministratorUID)
globalAdministratorUID
- the UID of the global administrator.public String getGlobalAdministratorPassword()
public void setGlobalAdministratorPassword(String globalAdministratorPwd)
globalAdministratorPwd
- the password of the global administrator.public void setSuffixesToReplicateOptions(SuffixesToReplicateOptions suffixesToReplicateOptions)
suffixesToReplicateOptions
- the suffixes to replicate options
object.public SuffixesToReplicateOptions getSuffixesToReplicateOptions()
public SecurityOptions getSecurityOptions()
public void setSecurityOptions(SecurityOptions securityOptions)
securityOptions
- the SecurityOptions representing the SSL/StartTLS
configuration chosen by the user.public void setQuiet(boolean quiet)
quiet
- where true indicates this session should be quietpublic boolean isQuiet()
Quiet mode in the CLI means that nothing is written to output including prompts for information and whether to continue an operation experiencing errors.
public void setVerbose(boolean verbose)
verbose
- where true indicates this session should be verbosepublic boolean isVerbose()
public void setForceOnError(boolean forceOnError)
forceOnError
- where true indicates to continue uninstall if there is
a non critical error.public boolean isForceOnError()
public boolean isInteractive()
Interactive mode in the CLI means that the CLI will prompt the user for more information if it is required. Interactivity does NOT affect prompts to the user regarding actions like continuing an operation that is experiencing errors.
public static int getDefaultPort()
public static int getDefaultAdminConnectorPort()
public static int getDefaultSslPort(int defaultLdapPort)
defaultLdapPort
- the default port used for LDAP.public static int getDefaultJMXPort(int[] forbiddenPorts)
forbiddenPorts
- an array of ports that we cannot use.public Map<ServerDescriptor,AuthenticationData> getRemoteWithNoReplicationPort()
public void setRemoteWithNoReplicationPort(Map<ServerDescriptor,AuthenticationData> remoteWithNoReplicationPort)
remoteWithNoReplicationPort
- the Map containing as key a
ServerDescriptor and as value an AuthenticationData corresponding to the
Replication Port chosen by the user.public Set<String> getScriptNamesForJavaArguments()
public JavaArguments getJavaArguments(String scriptName)
null
if no java arguments are defined.scriptName
- the script name.public JavaArguments getDefaultJavaArguments(String scriptName)
null
if no java arguments are defined.scriptName
- the script name.public void setJavaArguments(String scriptName, JavaArguments args)
scriptName
- the script name.args
- the java arguments associated with a script name.public void setConnectTimeout(int connectTimeout)
connectTimeout
- the timeout to be used to establish a connection.public int getConnectTimeout()
0
if there is no timeout.Copyright © 2010-2017 ForgeRock AS. All Rights Reserved.