Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 4.0

In the WebRoot/WEB-INF/conf directory, there should be an IngestTool.properties file with the following configurations:

Shared Configurations:

  • DB connection information for the tracking DB:
    • jdbcDriver
      • Sets the JDBC driver class
      • defaults to: oracle.jdbc.OracleDriver
    • jdbcPath
      • Sets the JDBC path, for example: jdbc:oracle:thin:@ora-iudl-dev.dlib.indiana.edu:1521:iudl
      • No default
    • jdbcUsername
      • Sets the JDBC username to use when connecting to the jdbcPath, for example: infrastructure
      • No default
    • jdbcPassword
      • Sets the JDBC password to use when connecting to the jdbcPath, for example: ey3nEff
      • No default

Startup Servlet Configurations:

  • Background execution configuration:
    • javaExecutable
      • This is the full path of the java application to use when running the worker process.
      • Defaults to: C:/Sun/AppServer/jdk/bin/java.exe
    • javaArgs.[num]
      • These are the arguments to pass to the javaExecutable when running the worker process.
      • The defaults are as follows (remove linebreaks):
        • javaArgs.1= -Djavax.xml.parsers.DocumentBuilderFactory= org.apache.xerces.jaxp.DocumentBuilderFactoryImpl
        • javaArgs.2=
          -Djavax.xml.parsers.SAXParserFactory=
          org.apache.xerces.jaxp.SAXParserFactoryImpl
        • javaArgs.3=
          -Djavax.xml.transform.TransformerFactory=
          net.sf.saxon.TransformerFactoryImpl
        • javaArgs.4=
          -Djavax.xml.xpath.XPathFactory=
          net.sf.saxon.xpath.XPathFactoryImpl
        • javaArgs.5=
          -Djavax.xml.xpath.XPathFactory:http://saxon.sf.net/jaxp/xpath/om=
          net.sf.saxon.xpath.XPathFactoryImpl
        • javaArgs.6=-Xmx1536M
    • javaWorker
      • This is the worker class to execute
      • Defaults to: edu.indiana.dlib.fedora.server.ingestTool.IngestToolWorker

Worker Configurations:

  • Fedora configurations:
    • fedoraVersion
      • This is the version of Fedora that we will connect to. Must be 2.0 or 2.1 (In 2.1 mode, the normal operation is to do uploads via (SSL) https://, and ingests via http://)
      • Defaults to: 2.1
    • fedoraServer
      • This is the Fedora server to connect to.
      • Defaults to: localhost
    • fedoraPort
      • This is the port of the Fedora server.
      • Defaults to: 8080
    • fedoraUploadPort
      • This is the port for upload (and other secure processes?) on the Fedora server. Only valid for version 2.1 and beyond.
      • Defaults to: 8443
    • fedoraUsername
      • This is the username for the Fedora Server, for example: fedoraAdmin
      • No default.
    • fedoraPassword
      • This is the password for the Fedora Server, for example: fedoraAdmin
      • No default.
    • advanced:
      • fedoraUploadUsername
        • This is the username for upload (and other secure functions?) on the fedora server. Only valid in version 2.1 and beyond.
        • Defaults to the same username as specified by fedoraUsername
      • fedoraUploadPassword
        • This is the password for upload (and other secure functions?) on the fedora server. Only valid in version 2.1 and beyond.
        • Defaults to the same password as specified by fedoraPassword
      • fedoraMethod
        • This is the Fedora access method.
        • Defaults to: http://
      • fedoraUploadMethod
        • This is the Fedora access method for upload (and other secure functions?). Only valid in versions 2.1 and beyond.
        • Defaults to: https://
      • fedoraAccessURI
        • Defaults to: /fedora/services/access
      • fedoraManagementURI
        • Defaults to: /fedora/services/management
      • fedoraUploadURI
        • Defaults to: fedora/management/upload
      • fedoraGetURI
        • Defaults to: /fedora/get
      • fedoraCerts
        • This is the java keystore of trusted keys. It is located in the webroot folder, and should be a file that comes from the fedora distribution. This is essential for version 2.1. (Note, it might be a good idea to remove the hardcoded path to the webroot folder in the code, and allow for that to be provided here. Just s thought)
        • Defaults to: truststore
  • User-level Logging Configuration
    • loggingSender
      • This is who the mailed logs appear to come from, for example: erpeters@indiana.edu
      • There is no default
    • loggingSubject
      • This is the subject of the emailed log files, for example: IngestTool Output...
      • There is no default
    • loggingSMTPServer
      • This is the SMTP server to use when emailing logs, for instance: rhyme.dlib.indiana.edu
      • There is no default
    • log4jConfigFile
      • This is the location of the server log configuration file.
      • Defaults to ./log4j.properties
  • Default missing image configuration:
    • missingImage
      • This is the path to the default image to use when images are not available, for example: resources/unavailable.jpg
      • There is no default.
  • Debug configuration:
    • testingWorker
      • Defines if any of the testing flags will be functional
      • Defaults to: false
    • testingSingleItem
      • If set to true, only 1 item will be processed, and the processing will end. The processing will end regardless of the success or failure of the single item ingest.
      • Defaults to: false
    • testingFakeFedora
      • This will fake all Fedora calls, imitating a success. This is used for quickly testing logical flow, or for development while Fedora is off-line.
      • Defaults to: false
    • testingSkipAnalysis
      • This will skip the (lengthy) analysis steps.
      • Defaults to: false
  • Behavior configurations:
    • ingestSleepTime
      • This is a sleep time for the worker to pause between each ingestion. Unfortunately, the process is very greedy, so it will rest to let others get Fedoras attention from time to time.
      • Defaults to: 250
    • commRetryCount
      • This is the number of times the ingest tool will retry a fedora operation in the event of a connection reset or refused error.
      • Defaults to: 5
    • commRetryDelay
      • This is the delay between retries of a fedora operation in the event of a connection reset or refused error.
      • Defaults to: 5000