EdalConfiguration (eDAL-MetaDataAPI 2.3.8 API)

java.lang.Object
- de.ipk_gatersleben.bit.bi.edal.primary_data.EdalConfiguration

```
public final class EdalConfiguration
extends Object
```
class to collect all parameters to start the eDAL system.

Author:

arendd

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DATACITE_CONNECTION_READ_TIMEOUT` Connection read timeout for HTTP connection to DataCite in milliseconds.
`static int`	`DATACITE_CONNECTION_TIMEOUT` Connection timeout for HTTP connection to DataCite in milliseconds.
`static String`	`DATACITE_SEARCH_URL`
`static String`	`DATACITE_TESTPREFIX`
`static String`	`DEFAULT_DATABASE_PASSWORD` The default database password
`static String`	`DEFAULT_DATABASE_USERNAME` The default database user name
`static int`	`DEFAULT_HTTP_PORT` The default port for the HTTP listener
`static Path`	`DEFAULT_PATH`
`static List<Class<? extends Principal>>`	`DEFAULT_SUPPORTED_PRINCIPALS` The default supported principals by eDAL.
`static URL`	`KEY_STORE_PATH`
`static String`	`KEYSTORE_PASSWORD`
`static int`	`SMTP_CONNECTION_TIMEOUT` Connection timeout for SMTP connection.

Constructor Summary

Constructors
Constructor and Description
`EdalConfiguration(String dataCiteUser, String dataCitePassword, String dataCitePrefix, javax.mail.internet.InternetAddress scientificReviewer, javax.mail.internet.InternetAddress substituteReviewer, javax.mail.internet.InternetAddress managingReviewer, javax.mail.internet.InternetAddress rootUser)`
`EdalConfiguration(String dataCiteUser, String dataCitePassword, String dataCitePrefix, javax.mail.internet.InternetAddress scientificReviewer, javax.mail.internet.InternetAddress substituteReviewer, javax.mail.internet.InternetAddress managingReviewer, javax.mail.internet.InternetAddress rootUser, String httpProxyHost, int httpProxyPort, String httpsProxyHost, int httpsProxyPort, String smtpHost, String smtpLogin, String smtpPassword)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addSupportedPrincipal(Class<? extends Principal> principal)` Add a supported Principal to the list of principals.
`List<String>`	`getAliasDomainNames()`
`protected URL`	`getCertificatePathForHttpListener()`
`String`	`getDatabasePassword()` Getter for the database password.
`String`	`getDatabaseUsername()` Getter for the database user name.
`String`	`getDataCitePassword()` Getter for the DataCite password.
`String`	`getDataCitePrefix()` Getter for the DataCite prefix
`String`	`getDataCiteUser()` Getter for the DataCite user name.
`Path`	`getDataPath()`
`String`	`getEdalEmailAddress()` Getter for the edal email address.
`protected javax.mail.internet.InternetAddress`	`getErrorEmailAddress()` Getter for the eMail address to send error messages.
`org.apache.log4j.Logger`	`getErrorLogger()`
`int`	`getHttpPort()` Getter for the port of the HTTP server/listener.
`String`	`getHttpProxyHost()` Getter for the HTTP proxy host.
`int`	`getHttpProxyPort()` Getter for the HTTP proxy port.
`String`	`getHttpsProxyHost()` Getter for the HTTPS proxy host.
`int`	`getHttpsProxyPort()` Getter for the HTTPS proxy port.
`protected String`	`getKeystorePasswordForHttpListener()`
`org.apache.log4j.Logger`	`getLogger()`
`String`	`getMailSmtpHost()` Getter for the mail SMTP host.
`String`	`getMailSmtpLogin()` Getter for the mail SMTP host.
`String`	`getMailSmtpPassword()` Getter for the mail SMTP password.
`Path`	`getMountPath()` Getter for the mount path of the eDAL system.
`javax.mail.internet.InternetAddress`	`getReviewerManaging()` Getter for the eMail address of the managing reviewer.
`javax.mail.internet.InternetAddress`	`getReviewerScientific()` Getter for the eMail address of the scientific reviewer.
`javax.mail.internet.InternetAddress`	`getReviewerSubstitute()` Getter for the eMail address of the substitute reviewer.
`javax.mail.internet.InternetAddress`	`getRootUser()` Getter for the eMail address for the root user.
`List<Class<? extends Principal>>`	`getSupportedPrincipals()` Getter for the List of supported `Principal`s.
`static InetSocketAddress`	`guessProxySettings()`
`static String`	`guessSmtpSettings(String smtpLogin, String smtpPassword)`
`boolean`	`isInTestMode()`
`boolean`	`isUseSSL()`
`boolean`	`isUseSSLForHttpListener()`
`boolean`	`isUseSystemProxies()` Check if proxies should be used.
`protected void`	`setCertificatePathForHttpListener(URL certificatePathForHttpListener)`
`void`	`setDatabasePassword(String databasePassword)` Setter for the database password.
`void`	`setDatabaseUsername(String databaseUsername)` Setter for the database user name.
`void`	`setDataPath(Path dataPath)` Setter for the data path.
`protected void`	`setErrorEmailAddress(javax.mail.internet.InternetAddress errorEmailAddress)`
`void`	`setHttpPort(int httpPort)` Setter for the port of the HTTP server/listener.
`void`	`setHttpProxyHost(String httpProxyHost)` Setter for the HTTP proxy host.
`void`	`setHttpProxyPort(int httpProxyPort)` Setter for the HTTP proxy port.
`void`	`setHttpsProxyHost(String httpsProxyHost)` Setter for the HTTPS proxy host.
`void`	`setHttpsProxyPort(int httpsProxyPort)` Setter for the HTTPS proxy port.
`protected void`	`setKeystorePasswordForHttpListener(String keystorePasswordForHttpListener)`
`void`	`setMailSmtpHost(String mailSmtpHost)` Setter for the mail SMTP host.
`void`	`setMailSmtpLogin(String mailSmtpLogin)` Setter for the mail SMTP login.
`void`	`setMailSmtpPassword(String mailSmtpPassword)` Setter for the SMTP password.
`void`	`setMountPath(Path mountPath)` Setter for the mount path.
`void`	`setSupportedPrincipals(List<Class<? extends Principal>> supportedPrincipals)` Setter for the supported `Principal`s.
`void`	`setUseSSL(boolean useSSL)`
`void`	`setUseSSLForHttpListener(boolean useSSLForHttpListener, URL pathToKeyStore, String keystorePassword)`
`void`	`setUseSystemProxies(boolean useSystemProxies)` Setter to activate the usage of proxies.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DATACITE_SEARCH_URL
```
public static final String DATACITE_SEARCH_URL
```
    See Also:
    Constant Field Values
  - DATACITE_TESTPREFIX
```
public static final String DATACITE_TESTPREFIX
```
    See Also:
    Constant Field Values
  - DATACITE_CONNECTION_TIMEOUT
```
public static final int DATACITE_CONNECTION_TIMEOUT
```
    Connection timeout for HTTP connection to DataCite in milliseconds.
    
    See Also:
    Constant Field Values
  - DATACITE_CONNECTION_READ_TIMEOUT
```
public static final int DATACITE_CONNECTION_READ_TIMEOUT
```
    Connection read timeout for HTTP connection to DataCite in milliseconds.
    
    See Also:
    Constant Field Values
  - SMTP_CONNECTION_TIMEOUT
```
public static final int SMTP_CONNECTION_TIMEOUT
```
    Connection timeout for SMTP connection.
    
    See Also:
    Constant Field Values
  - DEFAULT_PATH
```
public static final Path DEFAULT_PATH
```
  - KEY_STORE_PATH
```
public static final URL KEY_STORE_PATH
```
  - KEYSTORE_PASSWORD
```
public static final String KEYSTORE_PASSWORD
```
    See Also:
    Constant Field Values
  - DEFAULT_SUPPORTED_PRINCIPALS
```
public static final List<Class<? extends Principal>> DEFAULT_SUPPORTED_PRINCIPALS
```
    The default supported principals by eDAL.
  - DEFAULT_DATABASE_USERNAME
```
public static final String DEFAULT_DATABASE_USERNAME
```
    The default database user name
    
    See Also:
    Constant Field Values
  - DEFAULT_DATABASE_PASSWORD
```
public static final String DEFAULT_DATABASE_PASSWORD
```
    The default database password
    
    See Also:
    Constant Field Values
  - DEFAULT_HTTP_PORT
```
public static final int DEFAULT_HTTP_PORT
```
    The default port for the HTTP listener
    
    See Also:
    Constant Field Values
- Constructor Detail
  - EdalConfiguration
```
public EdalConfiguration(String dataCiteUser,
                 String dataCitePassword,
                 String dataCitePrefix,
                 javax.mail.internet.InternetAddress scientificReviewer,
                 javax.mail.internet.InternetAddress substituteReviewer,
                 javax.mail.internet.InternetAddress managingReviewer,
                 javax.mail.internet.InternetAddress rootUser)
                  throws EdalConfigurationException
```
    Throws:
    
    EdalConfigurationException
  - EdalConfiguration
```
public EdalConfiguration(String dataCiteUser,
                 String dataCitePassword,
                 String dataCitePrefix,
                 javax.mail.internet.InternetAddress scientificReviewer,
                 javax.mail.internet.InternetAddress substituteReviewer,
                 javax.mail.internet.InternetAddress managingReviewer,
                 javax.mail.internet.InternetAddress rootUser,
                 String httpProxyHost,
                 int httpProxyPort,
                 String httpsProxyHost,
                 int httpsProxyPort,
                 String smtpHost,
                 String smtpLogin,
                 String smtpPassword)
                  throws EdalConfigurationException
```
    Throws:
    
    EdalConfigurationException
- Method Detail
  - guessProxySettings
```
public static InetSocketAddress guessProxySettings()
```
  - guessSmtpSettings
```
public static String guessSmtpSettings(String smtpLogin,
                       String smtpPassword)
                                throws EdalConfigurationException
```
    Throws:
    
    EdalConfigurationException
  - addSupportedPrincipal
```
public void addSupportedPrincipal(Class<? extends Principal> principal)
```
    Add a supported Principal to the list of principals.
    
    Parameters:
    principal - the principal to add.
  - getCertificatePathForHttpListener
```
protected URL getCertificatePathForHttpListener()
```
    Returns:
    the certificatePathForHttpListener
  - getDataCitePassword
```
public String getDataCitePassword()
                           throws EdalConfigurationException
```
    Getter for the DataCite password.
    
    Returns:
    the DataCite password.
    
    Throws:
    
    EdalConfigurationException - if no DataCite password is defined
  - getDataCitePrefix
```
public String getDataCitePrefix()
                         throws EdalConfigurationException
```
    Getter for the DataCite prefix
    
    Returns:
    the DataCite prefix
    
    Throws:
    
    EdalConfigurationException - if no prefix is defined
  - getDataCiteUser
```
public String getDataCiteUser()
                       throws EdalConfigurationException
```
    Getter for the DataCite user name.
    
    Returns:
    the DataCite user name.
    
    Throws:
    
    EdalConfigurationException - if no DataCite user name is defined
  - getDataPath
```
public Path getDataPath()
```
    Returns:
    the data path.
  - getEdalEmailAddress
```
public String getEdalEmailAddress()
```
    Getter for the edal email address.
    
    Returns:
    the email address for edal messages.
  - getErrorEmailAddress
```
protected javax.mail.internet.InternetAddress getErrorEmailAddress()
                                                            throws EdalConfigurationException
```
    Getter for the eMail address to send error messages.
    
    Returns:
    the errorEmail
    
    Throws:
    
    EdalConfigurationException
  - getErrorLogger
```
public org.apache.log4j.Logger getErrorLogger()
```
    Returns:
    the logger
  - getDatabasePassword
```
public String getDatabasePassword()
                           throws EdalConfigurationException
```
    Getter for the database password.
    
    Returns:
    the database password
    
    Throws:
    
    EdalConfigurationException - if no database password is defined
  - getDatabaseUsername
```
public String getDatabaseUsername()
                           throws EdalConfigurationException
```
    Getter for the database user name.
    
    Returns:
    the database user name.
    
    Throws:
    
    EdalConfigurationException - if no database user name is defined
  - getHttpPort
```
public int getHttpPort()
                throws EdalConfigurationException
```
    Getter for the port of the HTTP server/listener.
    
    Returns:
    the HTTP port.
    
    Throws:
    
    EdalConfigurationException - if no HTTP port is set.
  - getHttpProxyHost
```
public String getHttpProxyHost()
                        throws EdalConfigurationException
```
    Getter for the HTTP proxy host.
    
    Returns:
    the HTTP proxy host.
    
    Throws:
    
    EdalConfigurationException - if no HTTP proxy host is defined
  - getHttpProxyPort
```
public int getHttpProxyPort()
                     throws EdalConfigurationException
```
    Getter for the HTTP proxy port.
    
    Returns:
    the HTTP proxy port.
    
    Throws:
    
    EdalConfigurationException - if no HTTP proxy port is defined
  - getHttpsProxyHost
```
public String getHttpsProxyHost()
                         throws EdalConfigurationException
```
    Getter for the HTTPS proxy host.
    
    Returns:
    the HTTPS proxy host.
    
    Throws:
    
    EdalConfigurationException - if no HTTPS proxy host is defined
  - getHttpsProxyPort
```
public int getHttpsProxyPort()
                      throws EdalConfigurationException
```
    Getter for the HTTPS proxy port.
    
    Returns:
    the HTTPS proxy port.
    
    Throws:
    
    EdalConfigurationException - if no HTTPS proxy port is defined
  - getKeystorePasswordForHttpListener
```
protected String getKeystorePasswordForHttpListener()
```
    Returns:
    the keystorePasswordForHttpListener
  - getLogger
```
public org.apache.log4j.Logger getLogger()
```
    Returns:
    the logger
  - getMailSmtpHost
```
public String getMailSmtpHost()
```
    Getter for the mail SMTP host.
    
    Returns:
    the mail SMTP host.
  - getMailSmtpLogin
```
public String getMailSmtpLogin()
```
    Getter for the mail SMTP host.
    
    Returns:
    the mail SMTP host.
  - getMailSmtpPassword
```
public String getMailSmtpPassword()
```
    Getter for the mail SMTP password.
    
    Returns:
    the mail SMTP password.
  - getMountPath
```
public Path getMountPath()
```
    Getter for the mount path of the eDAL system.
    
    Returns:
    the mountPath
  - getReviewerManaging
```
public javax.mail.internet.InternetAddress getReviewerManaging()
                                                        throws EdalConfigurationException
```
    Getter for the eMail address of the managing reviewer.
    
    Returns:
    the REVIEWER_MANAGING
    
    Throws:
    
    EdalConfigurationException - if no emailAddress is defined or if it is invalid.
  - getReviewerScientific
```
public javax.mail.internet.InternetAddress getReviewerScientific()
                                                          throws EdalConfigurationException
```
    Getter for the eMail address of the scientific reviewer.
    
    Returns:
    the reviewerScientific
    
    Throws:
    
    EdalConfigurationException - if no emailAddress is defined or if it is invalid.
  - getReviewerSubstitute
```
public javax.mail.internet.InternetAddress getReviewerSubstitute()
                                                          throws EdalConfigurationException
```
    Getter for the eMail address of the substitute reviewer.
    
    Returns:
    the reviewerSubstitute
    
    Throws:
    
    EdalConfigurationException - if no emailAddress is defined or if it is invalid.
  - getRootUser
```
public javax.mail.internet.InternetAddress getRootUser()
                                                throws EdalConfigurationException
```
    Getter for the eMail address for the root user.
    
    Returns:
    the rootUser
    
    Throws:
    
    EdalConfigurationException - if no emailAddress is defined or if it is invalid.
  - getSupportedPrincipals
```
public List<Class<? extends Principal>> getSupportedPrincipals()
                                                        throws EdalConfigurationException
```
    Getter for the List of supported Principals.
    
    Returns:
    the List of supported Principals
    
    Throws:
    
    EdalConfigurationException - if no supported principals are defined !
  - isInTestMode
```
public boolean isInTestMode()
```
    Returns:
    the inTestModeE
  - isUseSSL
```
public boolean isUseSSL()
```
    Returns:
    the useSSL
  - isUseSSLForHttpListener
```
public boolean isUseSSLForHttpListener()
```
    Returns:
    the useSSLForHttpListener
  - isUseSystemProxies
```
public boolean isUseSystemProxies()
```
    Check if proxies should be used.
    
    Returns:
    true or false
  - setCertificatePathForHttpListener
```
protected void setCertificatePathForHttpListener(URL certificatePathForHttpListener)
```
    Parameters:
    certificatePathForHttpListener - the certificatePathForHttpListener to set
  - setDataPath
```
public void setDataPath(Path dataPath)
```
    Setter for the data path.
    
    Parameters:
    dataPath - the dataPath to set
  - setErrorEmailAddress
```
protected void setErrorEmailAddress(javax.mail.internet.InternetAddress errorEmailAddress)
```
    Parameters:
    errorEmailAddress - the errorEmail to set
  - setDatabasePassword
```
public void setDatabasePassword(String databasePassword)
```
    Setter for the database password.
    
    Parameters:
    databasePassword - the database password to set
  - setDatabaseUsername
```
public void setDatabaseUsername(String databaseUsername)
```
    Setter for the database user name.
    
    Parameters:
    databaseUsername - the database user name to set
  - setHttpPort
```
public void setHttpPort(int httpPort)
```
    Setter for the port of the HTTP server/listener.
    
    Parameters:
    httpPort - the HTTP port to set.
  - setHttpProxyHost
```
public void setHttpProxyHost(String httpProxyHost)
```
    Setter for the HTTP proxy host.
    
    Parameters:
    httpProxyHost - the HTTP proxy host.
  - setHttpProxyPort
```
public void setHttpProxyPort(int httpProxyPort)
```
    Setter for the HTTP proxy port.
    
    Parameters:
    httpProxyPort - the HTTP proxy port.
  - setHttpsProxyHost
```
public void setHttpsProxyHost(String httpsProxyHost)
```
    Setter for the HTTPS proxy host.
    
    Parameters:
    httpsProxyHost - the HTTP proxy host to set.
  - setHttpsProxyPort
```
public void setHttpsProxyPort(int httpsProxyPort)
```
    Setter for the HTTPS proxy port.
    
    Parameters:
    httpsProxyPort - the HTTP proxy port to set.
  - setKeystorePasswordForHttpListener
```
protected void setKeystorePasswordForHttpListener(String keystorePasswordForHttpListener)
```
    Parameters:
    keystorePasswordForHttpListener - the keystorePasswordForHttpListener to set
  - setMailSmtpHost
```
public void setMailSmtpHost(String mailSmtpHost)
```
    Setter for the mail SMTP host.
    
    Parameters:
    mailSmtpHost - the mail SMTP host to set.
  - setMailSmtpLogin
```
public void setMailSmtpLogin(String mailSmtpLogin)
```
    Setter for the mail SMTP login.
    
    Parameters:
    mailSmtpLogin - the mail SMTP login to set.
  - setMailSmtpPassword
```
public void setMailSmtpPassword(String mailSmtpPassword)
```
    Setter for the SMTP password.
    
    Parameters:
    mailSmtpPassword -
  - setMountPath
```
public void setMountPath(Path mountPath)
```
    Setter for the mount path.
    
    Parameters:
    mountPath - the mount path to set
  - setSupportedPrincipals
```
public void setSupportedPrincipals(List<Class<? extends Principal>> supportedPrincipals)
```
    Setter for the supported Principals.
    
    Parameters:
    supportedPrincipals - the supported Principals to set.
  - setUseSSL
```
public void setUseSSL(boolean useSSL)
```
    Parameters:
    useSSL - the useSSL to set
  - setUseSSLForHttpListener
```
public void setUseSSLForHttpListener(boolean useSSLForHttpListener,
                            URL pathToKeyStore,
                            String keystorePassword)
```
    Parameters:
    useSSLForHttpListener - the useSSLForHttpListener to set
  - setUseSystemProxies
```
public void setUseSystemProxies(boolean useSystemProxies)
```
    Setter to activate the usage of proxies.
    
    Parameters:
    useSystemProxies -
  - getAliasDomainNames
```
public List<String> getAliasDomainNames()
```

Class EdalConfiguration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DATACITE_SEARCH_URL

DATACITE_TESTPREFIX

DATACITE_CONNECTION_TIMEOUT

DATACITE_CONNECTION_READ_TIMEOUT

SMTP_CONNECTION_TIMEOUT

DEFAULT_PATH

KEY_STORE_PATH

KEYSTORE_PASSWORD

DEFAULT_SUPPORTED_PRINCIPALS

DEFAULT_DATABASE_USERNAME

DEFAULT_DATABASE_PASSWORD

DEFAULT_HTTP_PORT

Constructor Detail

EdalConfiguration

EdalConfiguration

Method Detail

guessProxySettings

guessSmtpSettings

addSupportedPrincipal

getCertificatePathForHttpListener

getDataCitePassword

getDataCitePrefix

getDataCiteUser

getDataPath

getEdalEmailAddress

getErrorEmailAddress

getErrorLogger

getDatabasePassword

getDatabaseUsername

getHttpPort

getHttpProxyHost

getHttpProxyPort

getHttpsProxyHost

getHttpsProxyPort

getKeystorePasswordForHttpListener

getLogger

getMailSmtpHost

getMailSmtpLogin

getMailSmtpPassword

getMountPath

getReviewerManaging

getReviewerScientific

getReviewerSubstitute

getRootUser

getSupportedPrincipals

isInTestMode

isUseSSL

isUseSSLForHttpListener

isUseSystemProxies

setCertificatePathForHttpListener

setDataPath

setErrorEmailAddress

setDatabasePassword

setDatabaseUsername

setHttpPort

setHttpProxyHost

setHttpProxyPort

setHttpsProxyHost

setHttpsProxyPort

setKeystorePasswordForHttpListener

setMailSmtpHost

setMailSmtpLogin

setMailSmtpPassword

setMountPath

setSupportedPrincipals

setUseSSL

setUseSSLForHttpListener

setUseSystemProxies

getAliasDomainNames