Package org.codelibs.fess.mylasta.direction

Interface FessEnv

All Known Subinterfaces:
FessConfig
All Known Implementing Classes:
FessConfig.SimpleImpl, FessConfigImpl, FessEnv.SimpleImpl
public interface FessEnv
Author:
FreeGen

  • Field Details

    • lasta_di_SMART_DEPLOY_MODE

      static final String lasta_di_SMART_DEPLOY_MODE
      The key of the configuration. e.g. warm
      See Also:

    • DEVELOPMENT_HERE

      static final String DEVELOPMENT_HERE
      The key of the configuration. e.g. true
      See Also:

    • ENVIRONMENT_TITLE

      static final String ENVIRONMENT_TITLE
      The key of the configuration. e.g. Local Development
      See Also:

    • FRAMEWORK_DEBUG

      static final String FRAMEWORK_DEBUG
      The key of the configuration. e.g. false
      See Also:

    • TIME_ADJUST_TIME_MILLIS

      static final String TIME_ADJUST_TIME_MILLIS
      The key of the configuration. e.g. 0
      See Also:

    • MAIL_SEND_MOCK

      static final String MAIL_SEND_MOCK
      The key of the configuration. e.g. true
      See Also:

    • MAIL_SMTP_SERVER_MAIN_HOST_AND_PORT

      static final String MAIL_SMTP_SERVER_MAIN_HOST_AND_PORT
      The key of the configuration. e.g. localhost:25
      See Also:

    • MAIL_SUBJECT_TEST_PREFIX

      static final String MAIL_SUBJECT_TEST_PREFIX
      The key of the configuration. e.g. [Test]
      See Also:

    • MAIL_RETURN_PATH

      static final String MAIL_RETURN_PATH
      The key of the configuration. e.g. root@localhost
      See Also:

  • Method Details

    • get

      String get(String propertyKey)
      Get the value of property as String.
      Parameters:
      propertyKey - The key of the property. (NotNull)
      Returns:
      The value of found property. (NotNull: if not found, exception)
      Throws:
      org.lastaflute.core.direction.exception.ConfigPropertyNotFoundException - When the property is not found.

    • is

      boolean is(String propertyKey)
      Is the property true?
      Parameters:
      propertyKey - The key of the property which is boolean type. (NotNull)
      Returns:
      The determination, true or false. (if not found, exception)
      Throws:
      org.lastaflute.core.direction.exception.ConfigPropertyNotFoundException - When the property is not found.

    • getLastaDiSmartDeployMode

      String getLastaDiSmartDeployMode()
      Get the value for the key 'lasta_di.smart.deploy.mode'.
      The value is, e.g. warm
      comment: The mode of Lasta Di's smart-deploy, should be cool in production (e.g. hot, cool, warm)
      Returns:
      The value of found property. (NotNull: if not found, exception but basically no way)

    • getDevelopmentHere

      String getDevelopmentHere()
      Get the value for the key 'development.here'.
      The value is, e.g. true
      comment: Is development environment here? (used for various purpose, you should set false if unknown)
      Returns:
      The value of found property. (NotNull: if not found, exception but basically no way)

    • isDevelopmentHere

      boolean isDevelopmentHere()
      Is the property for the key 'development.here' true?
      The value is, e.g. true
      comment: Is development environment here? (used for various purpose, you should set false if unknown)
      Returns:
      The determination, true or false. (if not found, exception but basically no way)

    • getEnvironmentTitle

      String getEnvironmentTitle()
      Get the value for the key 'environment.title'.
      The value is, e.g. Local Development
      comment: The title of environment (e.g. local or integration or production)
      Returns:
      The value of found property. (NotNull: if not found, exception but basically no way)

    • getFrameworkDebug

      String getFrameworkDebug()
      Get the value for the key 'framework.debug'.
      The value is, e.g. false
      comment: Does it enable the Framework internal debug? (true only when emergency)
      Returns:
      The value of found property. (NotNull: if not found, exception but basically no way)

    • isFrameworkDebug

      boolean isFrameworkDebug()
      Is the property for the key 'framework.debug' true?
      The value is, e.g. false
      comment: Does it enable the Framework internal debug? (true only when emergency)
      Returns:
      The determination, true or false. (if not found, exception but basically no way)

    • getTimeAdjustTimeMillis

      String getTimeAdjustTimeMillis()
      Get the value for the key 'time.adjust.time.millis'.
      The value is, e.g. 0
      comment:
      one day: 86400000, three days: 259200000, five days: 432000000, one week: 604800000, one year: 31556926000
      special script :: absolute mode: $(2014/07/10), relative mode: addDay(3).addMonth(4)
      The milliseconds for (relative or absolute) adjust time (set only when test) @LongType *dynamic in development
      Returns:
      The value of found property. (NotNull: if not found, exception but basically no way)

    • getTimeAdjustTimeMillisAsLong

      Long getTimeAdjustTimeMillisAsLong()
      Get the value for the key 'time.adjust.time.millis' as Long.
      The value is, e.g. 0
      comment:
      one day: 86400000, three days: 259200000, five days: 432000000, one week: 604800000, one year: 31556926000
      special script :: absolute mode: $(2014/07/10), relative mode: addDay(3).addMonth(4)
      The milliseconds for (relative or absolute) adjust time (set only when test) @LongType *dynamic in development
      Returns:
      The value of found property. (NotNull: if not found, exception but basically no way)
      Throws:
      NumberFormatException - When the property is not long.

    • getMailSendMock

      String getMailSendMock()
      Get the value for the key 'mail.send.mock'.
      The value is, e.g. true
      comment: Does it send mock mail? (true: no send actually, logging only)
      Returns:
      The value of found property. (NotNull: if not found, exception but basically no way)

    • isMailSendMock

      boolean isMailSendMock()
      Is the property for the key 'mail.send.mock' true?
      The value is, e.g. true
      comment: Does it send mock mail? (true: no send actually, logging only)
      Returns:
      The determination, true or false. (if not found, exception but basically no way)

    • getMailSmtpServerMainHostAndPort

      String getMailSmtpServerMainHostAndPort()
      Get the value for the key 'mail.smtp.server.main.host.and.port'.
      The value is, e.g. localhost:25
      comment: SMTP server settings for main: host:port
      Returns:
      The value of found property. (NotNull: if not found, exception but basically no way)

    • getMailSubjectTestPrefix

      String getMailSubjectTestPrefix()
      Get the value for the key 'mail.subject.test.prefix'.
      The value is, e.g. [Test]
      comment: The prefix of subject to show test environment or not
      Returns:
      The value of found property. (NotNull: if not found, exception but basically no way)

    • getMailReturnPath

      String getMailReturnPath()
      Get the value for the key 'mail.return.path'.
      The value is, e.g. root@localhost
      comment: The common return path of all mail
      Returns:
      The value of found property. (NotNull: if not found, exception but basically no way)