ch.icosys.popjava.core.util

Class Configuration

java.lang.Object

ch.icosys.popjava.core.util.Configuration

public final class Configuration
extends java.lang.Object

This class regroup some configuration values

Method Summary

Modifier and Type	Method and Description
int	getAllocatePortRange()
int	getAllocTimeout()
int	getConnectionTimeout()
java.lang.String	getDefaultEncoding()
java.lang.String	getDefaultNetwork()
java.lang.String	getDefaultProtocol()
static Configuration	getInstance()
java.lang.String	getJobManagerDefaultConnector()
java.lang.String	getJobManagerExecutionBaseDirectory()
java.lang.String	getJobmanagerExecutionUser()
int[]	getJobManagerPorts()
java.lang.String[]	getJobManagerProtocols()
int	getJobManagerSelfRegisterInterval() Deprecated.
int	getJobManagerUpdateInterval()
int	getPopJavaDaemonPort()
java.lang.String	getPopJavaLocation()
java.util.Set<java.lang.String>	getProtocolsBlacklist()
java.util.Set<java.lang.String>	getProtocolsWhitelist()
int	getReserveTimeout()
int	getSearchNodeExplorationQueueSize()
int	getSearchNodeMaxRequests()
int	getSearchNodeSearchTimeout()
int	getSearchNodeUnlimitedHops()
int	getSearchNodeUnlockTimeout()
java.lang.String	getSelectedEncoding()
java.io.File	getSSLKeyStoreFile()
KeyStoreDetails.KeyStoreFormat	getSSLKeyStoreFormat()
KeyStoreDetails	getSSLKeyStoreOptions()
java.lang.String	getSSLKeyStorePassword()
java.lang.String	getSSLKeyStorePrivateKeyPassword()
java.lang.String	getSSLProtocolVersion()
java.io.File	getSSLTemporaryCertificateLocation()
java.io.File	getSystemJobManagerConfig()
int	getTFCSearchTimeout()
java.io.File	getUserConfig()
boolean	isActivateJmx()
boolean	isAsyncConstructor()
boolean	isConnectToJavaJobmanager()
boolean	isConnectToPOPcpp()
boolean	isDebug()
boolean	isDebugCombox()
boolean	isRedirectOutputToRoot()
boolean	isUseNativeSSHifPossible()
boolean	isUsingUserConfig()
void	load(java.io.File file) Load a custom configuration file on top of the system and defaults one.
void	setActivateJmx(boolean activateJmx)
void	setAllocatePortRange(int allocatePortRange)
void	setAllocTimeout(int allocTimeout)
void	setAsyncConstructor(boolean asyncConstructor)
void	setConnectionTimeout(int connectionTimeout)
void	setConnectToJavaJobmanager(boolean connectToJavaJobmanager)
void	setConnectToPOPcpp(boolean connectToPOPcpp)
void	setDebug(boolean debug)
void	setDebugCombox(boolean debugCombox)
void	setDefaultEncoding(java.lang.String defaultEncoding)
void	setDefaultNetwork(java.lang.String systemDefaultNetwork)
void	setDefaultProtocol(java.lang.String defaultProtocol)
void	setJobManagerDefaultConnector(java.lang.String jobManagerDefaultConnector)
void	setJobManagerExecutionBaseDirectory(java.lang.String jobManagerExecutionBaseDirectory)
void	setJobmanagerExecutionUser(java.lang.String jobmanagerExecutionUser)
void	setJobManagerPorts(int[] jobManagerPorts)
void	setJobManagerProtocols(java.lang.String[] jobManagerProtocols)
void	setJobManagerSelfRegisterInterval(int jobManagerSelfRegisterInterval)
void	setJobManagerUpdateInterval(int jobManagerUpdateInterval)
void	setPopJavaDaemonPort(int popJavaDaemonPort)
void	setProtocolsBlacklist(java.util.Set<java.lang.String> protocolsBlacklist)
void	setProtocolsWhitelist(java.util.Set<java.lang.String> protocolsWhitelist)
void	setRedirectOutputToRoot(boolean redirectOutputToRoot)
void	setReserveTimeout(int reserveTimeout)
void	setSearchNodeExplorationQueueSize(int searchNodeExplorationQueueSize)
void	setSearchNodeMaxRequests(int searchNodeMaxRequests)
void	setSearchNodeSearchTimeout(int searchNodeSearchTimeout)
void	setSearchNodeUnlockTimeout(int searchNodeUnlockTimeout)
void	setSelectedEncoding(java.lang.String selectedEncoding)
void	setSSLKeyStoreFile(java.io.File file)
void	setSSLKeyStoreFormat(KeyStoreDetails.KeyStoreFormat val)
void	setSSLKeyStoreOptions(KeyStoreDetails options)
void	setSSLKeyStorePassword(java.lang.String val)
void	setSSLKeyStorePrivateKeyPassword(java.lang.String val)
void	setSSLProtocolVersion(java.lang.String SSLProtocolVersion)
void	setSSLTemporaryCertificateDirectory(java.io.File file)
void	setSystemJobManagerConfig(java.io.File systemJobManagerConfig)
void	setTFCSearchTimeout(int tfcSearchTimeout)
void	setUseNativeSSHifPossible(boolean useNativeSSHifPossible)
void	setUserConfig(java.io.File userConfig)
void	store() Save the configuration to a new properties file, the file is defined in setUserConfig(File)
void	writeSystemConfiguration() Dump configuration to system location, may not work if rights block writing.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static Configuration getInstance()

getPopJavaLocation

public java.lang.String getPopJavaLocation()

Returns:

The location of the PopJava installation directory

getSystemJobManagerConfig

public java.io.File getSystemJobManagerConfig()

Returns:

The location of the Job Manager configuration file

getUserConfig

public java.io.File getUserConfig()

Returns:

The location of the user configuration file, if given

isUsingUserConfig

public boolean isUsingUserConfig()

Returns:

true is a user configuration file is set

isDebug

public boolean isDebug()

Returns:

true if debug information will be displayed

isDebugCombox

public boolean isDebugCombox()

Returns:

true if the combox connection will print their debug information

getReserveTimeout

public int getReserveTimeout()

Returns:

how many ms after a job manager will drop a request

getAllocTimeout

public int getAllocTimeout()

Returns:

how many ms a Interface should wait for a Broker to contact it

getConnectionTimeout

public int getConnectionTimeout()

Returns:

how many ms until a lost connection is dropped

getJobManagerUpdateInterval

public int getJobManagerUpdateInterval()

Returns:

interval in ms for the job manager to refresh itself

getJobManagerSelfRegisterInterval

@Deprecated
public int getJobManagerSelfRegisterInterval()

Deprecated.

Returns:

interval in ms for the job manager to signal its present to its neighbors

getJobManagerDefaultConnector

public java.lang.String getJobManagerDefaultConnector()

Returns:

the default approach a job manager will use in case none was expressed in the OD

getJobManagerExecutionBaseDirectory

public java.lang.String getJobManagerExecutionBaseDirectory()

Returns:

where the job manager should execute the object it will create

getJobmanagerExecutionUser

public java.lang.String getJobmanagerExecutionUser()

Returns:

the use which should be used to execute the object

getSearchNodeUnlockTimeout

public int getSearchNodeUnlockTimeout()

Returns:

default timeout when looking for a single answer

getSearchNodeSearchTimeout

public int getSearchNodeSearchTimeout()

Returns:

default timeout when looking for multiple answers

getTFCSearchTimeout

public int getTFCSearchTimeout()

Returns:

default time a TFC research should last

getSearchNodeUnlimitedHops

public int getSearchNodeUnlimitedHops()

Returns:

how many nodes should we explore

getSearchNodeMaxRequests

public int getSearchNodeMaxRequests()

Returns:

how many requests should be remember at the same time

getSearchNodeExplorationQueueSize

public int getSearchNodeExplorationQueueSize()

Returns:

how many visited nodes should be remember when searching

getDefaultEncoding

public java.lang.String getDefaultEncoding()

Returns:

getSelectedEncoding

public java.lang.String getSelectedEncoding()

Returns:

getDefaultProtocol

public java.lang.String getDefaultProtocol()

Returns:

default communication protocol

getDefaultNetwork

public java.lang.String getDefaultNetwork()

Returns:

default POP network signaled

getAllocatePortRange

public int getAllocatePortRange()

Returns:

from where do we start allocating ports

isAsyncConstructor

public boolean isAsyncConstructor()

Returns:

is the constructor async

isActivateJmx

public boolean isActivateJmx()

Returns:

is jmx active for remote analysis

isConnectToPOPcpp

public boolean isConnectToPOPcpp()

Returns:

use the POPC job manager

isConnectToJavaJobmanager

public boolean isConnectToJavaJobmanager()

Returns:

use the Java job manager

isRedirectOutputToRoot

public boolean isRedirectOutputToRoot()

Returns:

print ssh output locally

isUseNativeSSHifPossible

public boolean isUseNativeSSHifPossible()

Returns:

use the available ssh command if possible

getSSLKeyStoreOptions

public KeyStoreDetails getSSLKeyStoreOptions()

Returns:

information on the keystore containing the private keys

getSSLProtocolVersion

public java.lang.String getSSLProtocolVersion()

Returns:

which TLS version are we using

getSSLKeyStoreFile

public java.io.File getSSLKeyStoreFile()

Returns:

alias for KeyStoreDetails.getKeyStoreFile()

getSSLKeyStorePassword

public java.lang.String getSSLKeyStorePassword()

Returns:

alias for KeyStoreDetails.getKeyStorePassword()

getSSLKeyStorePrivateKeyPassword

public java.lang.String getSSLKeyStorePrivateKeyPassword()

Returns:

alias for KeyStoreDetails.getPrivateKeyPassword()

getSSLKeyStoreFormat

public KeyStoreDetails.KeyStoreFormat getSSLKeyStoreFormat()

Returns:

alias for KeyStoreDetails.getKeyStoreFormat()

getSSLTemporaryCertificateLocation

public java.io.File getSSLTemporaryCertificateLocation()

Returns:

the location for this object temporary certificates

getJobManagerPorts

public int[] getJobManagerPorts()

Returns:

the ports to be used by the job manager

getJobManagerProtocols

public java.lang.String[] getJobManagerProtocols()

Returns:

the protocols to the used by the job manger

getPopJavaDaemonPort

public int getPopJavaDaemonPort()

Returns:

the port used by the object creation daemon

getProtocolsWhitelist

public java.util.Set<java.lang.String> getProtocolsWhitelist()

Returns:

the only protocol we can use, unless in blacklist

getProtocolsBlacklist

public java.util.Set<java.lang.String> getProtocolsBlacklist()

Returns:

the protocols we can't use

setSystemJobManagerConfig

public void setSystemJobManagerConfig(java.io.File systemJobManagerConfig)

setUserConfig

public void setUserConfig(java.io.File userConfig)

setDebug

public void setDebug(boolean debug)

setDebugCombox

public void setDebugCombox(boolean debugCombox)

setReserveTimeout

public void setReserveTimeout(int reserveTimeout)

setAllocTimeout

public void setAllocTimeout(int allocTimeout)

setConnectionTimeout

public void setConnectionTimeout(int connectionTimeout)

setJobManagerUpdateInterval

public void setJobManagerUpdateInterval(int jobManagerUpdateInterval)

setJobManagerSelfRegisterInterval

public void setJobManagerSelfRegisterInterval(int jobManagerSelfRegisterInterval)

setJobManagerDefaultConnector

public void setJobManagerDefaultConnector(java.lang.String jobManagerDefaultConnector)

setJobManagerExecutionBaseDirectory

public void setJobManagerExecutionBaseDirectory(java.lang.String jobManagerExecutionBaseDirectory)

setJobmanagerExecutionUser

public void setJobmanagerExecutionUser(java.lang.String jobmanagerExecutionUser)

setSearchNodeUnlockTimeout

public void setSearchNodeUnlockTimeout(int searchNodeUnlockTimeout)

setSearchNodeSearchTimeout

public void setSearchNodeSearchTimeout(int searchNodeSearchTimeout)

setTFCSearchTimeout

public void setTFCSearchTimeout(int tfcSearchTimeout)

setSearchNodeMaxRequests

public void setSearchNodeMaxRequests(int searchNodeMaxRequests)

setSearchNodeExplorationQueueSize

public void setSearchNodeExplorationQueueSize(int searchNodeExplorationQueueSize)

setDefaultEncoding

public void setDefaultEncoding(java.lang.String defaultEncoding)

setSelectedEncoding

public void setSelectedEncoding(java.lang.String selectedEncoding)

setDefaultProtocol

public void setDefaultProtocol(java.lang.String defaultProtocol)

setAllocatePortRange

public void setAllocatePortRange(int allocatePortRange)

setDefaultNetwork

public void setDefaultNetwork(java.lang.String systemDefaultNetwork)

setAsyncConstructor

public void setAsyncConstructor(boolean asyncConstructor)

setActivateJmx

public void setActivateJmx(boolean activateJmx)

setConnectToPOPcpp

public void setConnectToPOPcpp(boolean connectToPOPcpp)

setConnectToJavaJobmanager

public void setConnectToJavaJobmanager(boolean connectToJavaJobmanager)

setRedirectOutputToRoot

public void setRedirectOutputToRoot(boolean redirectOutputToRoot)

setUseNativeSSHifPossible

public void setUseNativeSSHifPossible(boolean useNativeSSHifPossible)

setSSLProtocolVersion

public void setSSLProtocolVersion(java.lang.String SSLProtocolVersion)

setSSLKeyStoreFile

public void setSSLKeyStoreFile(java.io.File file)

setSSLKeyStorePassword

public void setSSLKeyStorePassword(java.lang.String val)

setSSLKeyStorePrivateKeyPassword

public void setSSLKeyStorePrivateKeyPassword(java.lang.String val)

setSSLKeyStoreFormat

public void setSSLKeyStoreFormat(KeyStoreDetails.KeyStoreFormat val)

setSSLTemporaryCertificateDirectory

public void setSSLTemporaryCertificateDirectory(java.io.File file)

setSSLKeyStoreOptions

public void setSSLKeyStoreOptions(KeyStoreDetails options)

setJobManagerPorts

public void setJobManagerPorts(int[] jobManagerPorts)

setJobManagerProtocols

public void setJobManagerProtocols(java.lang.String[] jobManagerProtocols)

setPopJavaDaemonPort

public void setPopJavaDaemonPort(int popJavaDaemonPort)

setProtocolsWhitelist

public void setProtocolsWhitelist(java.util.Set<java.lang.String> protocolsWhitelist)

setProtocolsBlacklist

public void setProtocolsBlacklist(java.util.Set<java.lang.String> protocolsBlacklist)

load

public void load(java.io.File file)
          throws java.io.IOException

Load a custom configuration file on top of the system and defaults one. Hierarchy: User Machine POP Defaults

Parameters:

file - The properties file to load

Throws:

java.io.IOException - if the given file fail to load

store

public void store()
           throws java.io.IOException

Save the configuration to a new properties file, the file is defined in setUserConfig(File)

Throws:

java.io.IOException - if we fail to write the file to disk

writeSystemConfiguration

public void writeSystemConfiguration()
                              throws java.io.IOException

Dump configuration to system location, may not work if rights block writing.

Throws:

java.io.IOException - if we fail to override the system configuration