Versions Compared

Key

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

Ingests one or more objects into a Fedora repository.

Usage:

Ingesting one file:

No Format
fedora-ingest f[ile]
              [path]
              [format]
              [targetHost:targetPort]
              [targetUser]
              [targetPassword]
              [targetProtocol]
              [log]
              [context]

Ingesting from a directory:

No Format
fedora-ingest d[ir]
              [path]
              [format]
              [targetHost:targetPort]
              [targetUser]
              [targetPassword]
              [targetProtocol]
              [log]
              [context]

Ingesting from another repository:

No Format
fedora-ingest r[epos]
              [sourceHost:sourcePort]
              [sourceUser]
              [sourcePassword]
              [pid | *]
              [targetHost:targetPort]
              [targetUser]
              [targetPassword]
              [sourceProtocol]
              [targetProtocol]
              [log]
              [context]

Where:

  • file | dir | repos - indicates whether the ingest is from a file, directory, or repository as source.
  • path - the local file or directory name
  • format - the XML format of the ingest file(s). Valid options are:
    • info:fedora/fedora-system:FOXML-1.1
    • info:fedora/fedora-system:FOXML-1.0
    • info:fedora/fedora-system:METSFedoraExt-1.1
    • info:fedora/fedora-system:ATOM-1.0
  • sourceHost/targetHost - the source or target repository's hostname
  • sourcePort/targetPort - the source or target repository's port number
  • sourceUser/targetUser - the id of the source or target repository user
  • sourcePassword/targetPassword - the password of the source or target repository user
  • pid | * - Either the identifier (PID) of the object to export from the repository OR * to indicate all objects from the source repository
  • sourceProtocol - the protocol to communicate with source repository, either http or https
  • targetProtocol - the protocol to communicate with target repository, either http or https
  • log - the optional log message. If unspecified, the log message will indicate the source of the object(s)
  • context - an optional parameter indicating the webapp context. This is only necessary if the Fedora server was installed under a context name other than 'fedora' (see Alternative Webapp Context Configuration). NOTE: This parameter can only be used if the 'log' parameter has been used as well.

Examples:

Examples:

Ingest obj1.xml (encoded in foxml1.1 format) from the current directory into the repository at myrepo.com:80 as user 'jane' with password 'jpw'. The log message will be system-generated, indicating the source path+filename.

No Format
fedora-ingest f obj1.xml info:fedora/fedora-system:FOXML-1.1 myrepo.com:80 jane jpw http

Traverse the entire directory structure of c:\archive, and ingests any file. It assumes all files will be in the FOXML 1.1 format and will fail on ingests of files that are not of this format. All log messages will be the quoted string.

No Format
fedora-ingest d c:\archive info:fedora/fedora-system:FOXML-1.1 myrepo.com:80 jane janepw http ""

Ingest the object whose pid is 'demo:1' from the source repository 'srcrepo.com:8081' into the target repository 'myrepo.com:80'. The object will be exported from the source repository in the default export format configured at the source. All log messages will be empty.

No Format
fedora-ingest r jrepo.com:8081 mike mpw demo:1 myrepo.com:80 jane jpw http http ""

Same as above, but ingests all data objects (type O).

No Format
fedora-ingest r jrepo.com:8081 mike mpw O myrepo.com:80 jane jpw http http ""