com.yourmediashelf.fedora.client.request

Class Ingest

java.lang.Object

com.yourmediashelf.fedora.client.request.FedoraRequest<Ingest>

com.yourmediashelf.fedora.client.request.Ingest

public class Ingest
extends FedoraRequest<Ingest>

Builder for the Ingest method.

Author:

Edwin Shin

Constructor Summary

Constructors

Constructor and Description
Ingest() Constructor that will use a server-generated pid.
Ingest(String pid)

Method Summary

Methods

Modifier and Type	Method and Description
Ingest	content(File content) The file to be ingested as a new object.
Ingest	content(InputStream content) The InputStream to be ingested as a new object.
Ingest	content(String content) The XML to be ingested as a new object.
Ingest	encoding(String encoding) The encoding of the XML to be ingested.
IngestResponse	execute() Executes this request against the FedoraRequest.DEFAULT_CLIENT
IngestResponse	execute(FedoraClient fedora) Execute this request using the supplied FedoraClient instance.
Ingest	format(String format) The XML format of the object to be ingested.
Ingest	ignoreMime(boolean ignoreMime) Indicates that the request should not be checked to ensure that the content is XML prior to attempting an ingest.
Ingest	label(String label) The label of the new object
Ingest	logMessage(String logMessage) A message describing the activity being performed, which will be recorded in the Fedora server log.
Ingest	namespace(String namespace) The namespace to be used to create a PID for a new empty object; if object XML is included with the request, the namespace parameter is ignored.
Ingest	ownerId(String ownerId) The id of the user to be listed at the object owner.

Methods inherited from class com.yourmediashelf.fedora.client.request.FedoraRequest

addHeader, addQueryParam, getFirstQueryParam, getHeaders, getQueryParam, getQueryParams, isDefaultClientSet, removeHeader, resource, resource, resource, resource, setDefaultClient, setHeaders, xParam

Methods inherited from class java.lang.Object

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

Constructor Detail

Ingest

public Ingest(String pid)

Parameters:

pid - the identified to assign or null to use a server-assigned pid

Ingest

public Ingest()

Constructor that will use a server-generated pid.

Method Detail

label

public Ingest label(String label)

The label of the new object

Parameters:

label - the object label

Returns:

this builder

format

public Ingest format(String format)

The XML format of the object to be ingested.

One of:

• 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:METSFedoraExt-1.0
• info:fedora/fedora-system:ATOM-1.1
• info:fedora/fedora-system:ATOMZip-1.1

Parameters:

format - the XML format of the object to be ingested.

Returns:

this builder

encoding

public Ingest encoding(String encoding)

The encoding of the XML to be ingested.

Parameters:

encoding -

Returns:

this builder

namespace

public Ingest namespace(String namespace)

The namespace to be used to create a PID for a new empty object; if object XML is included with the request, the namespace parameter is ignored.

Parameters:

namespace - the namespace of the PID to create

Returns:

this builder

ownerId

public Ingest ownerId(String ownerId)

The id of the user to be listed at the object owner.

Parameters:

ownerId -

Returns:

this builder

logMessage

public Ingest logMessage(String logMessage)

A message describing the activity being performed, which will be recorded in the Fedora server log.

Parameters:

logMessage - the log message

Returns:

this builder

ignoreMime

public Ingest ignoreMime(boolean ignoreMime)

Indicates that the request should not be checked to ensure that the content is XML prior to attempting an ingest.

This is provided to allow for client applications which do not indicate the correct Content-Type when submitting a request.

If not provided, defaults to false.

Parameters:

ignoreMime -

Returns:

this builder

content

public Ingest content(InputStream content)

The InputStream to be ingested as a new object.

Parameters:

content -

Returns:

this builder

content

public Ingest content(File content)

The file to be ingested as a new object.

Parameters:

content -

Returns:

this builder

content

public Ingest content(String content)

The XML to be ingested as a new object.

Parameters:

content -

Returns:

this builder

execute

public IngestResponse execute()
                       throws FedoraClientException

Description copied from class: FedoraRequest

Executes this request against the FedoraRequest.DEFAULT_CLIENT

Overrides:

execute in class FedoraRequest<Ingest>

Returns:

the FedoraResponse to this request

Throws:

FedoraClientException - if FedoraRequest.DEFAULT_CLIENT is null

execute

public IngestResponse execute(FedoraClient fedora)
                       throws FedoraClientException

Description copied from class: FedoraRequest

Execute this request using the supplied FedoraClient instance.

Specified by:

execute in class FedoraRequest<Ingest>

Parameters:

fedora - an instance of FedoraClient

Returns:

the response

Throws:

FedoraClientException - if the HTTP status code of the response is >= 400.