com.yourmediashelf.fedora.client.request

Class ModifyDatastream

java.lang.Object

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

com.yourmediashelf.fedora.client.request.ModifyDatastream

public class ModifyDatastream
extends FedoraRequest<ModifyDatastream>

Builder for the ModifyDatastream method.

Author:

Edwin Shin

Constructor Summary

Constructors

Constructor and Description
ModifyDatastream(String pid, String dsId)

Method Summary

Methods

Modifier and Type	Method and Description
ModifyDatastream	altIDs(List<String> altIDs)
ModifyDatastream	checksum(String checksum)
ModifyDatastream	checksumType(String checksumType) The algorithm used to compute the checksum.
ModifyDatastream	content(File content)
ModifyDatastream	content(InputStream content)
ModifyDatastream	content(String content)
ModifyDatastream	controlGroup(String controlGroup)
ModifyDatastream	dsLabel(String dsLabel)
ModifyDatastream	dsLocation(String dsLocation)
ModifyDatastream	dsState(String dsState) One of "A", "I", "D" (*A*ctive, *I*nactive, *D*eleted)
ModifyDatastreamResponse	execute() Executes this request against the FedoraRequest.DEFAULT_CLIENT
ModifyDatastreamResponse	execute(FedoraClient fedora) Execute this request using the supplied FedoraClient instance.
ModifyDatastream	formatURI(String formatURI)
ModifyDatastream	ignoreContent(boolean ignoreContent)
ModifyDatastream	lastModifiedDate(Date lastModifiedDate) Convenience method for lastModifiedDate(String).
ModifyDatastream	lastModifiedDate(org.joda.time.DateTime lastModifiedDate) Convenience method for lastModifiedDate(String).
ModifyDatastream	lastModifiedDate(String lastModifiedDate) If provided, the server will use the supplied lastModifedDate to prevent concurrent modifications, only performing the request if the datastream has not been modified since the request-provided lastModifiedDate.
ModifyDatastream	logMessage(String logMessage)
ModifyDatastream	mimeType(String mimeType) Set the mime type of the datastream.
ModifyDatastream	versionable(boolean versionable) Enable versioning of the datastream.

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

ModifyDatastream

public ModifyDatastream(String pid,
                String dsId)

Method Detail

altIDs

public ModifyDatastream altIDs(List<String> altIDs)

checksum

public ModifyDatastream checksum(String checksum)

checksumType

public ModifyDatastream checksumType(String checksumType)

The algorithm used to compute the checksum.

Parameters:

checksumType - One of DEFAULT, DISABLED, MD5, SHA-1, SHA-256, SHA-385, SHA-512

Returns:

this builder

controlGroup

public ModifyDatastream controlGroup(String controlGroup)

dsLabel

public ModifyDatastream dsLabel(String dsLabel)

dsLocation

public ModifyDatastream dsLocation(String dsLocation)

dsState

public ModifyDatastream dsState(String dsState)

One of "A", "I", "D" (*A*ctive, *I*nactive, *D*eleted)

Parameters:

dsState -

Returns:

this builder

formatURI

public ModifyDatastream formatURI(String formatURI)

ignoreContent

public ModifyDatastream ignoreContent(boolean ignoreContent)

lastModifiedDate

public ModifyDatastream lastModifiedDate(org.joda.time.DateTime lastModifiedDate)

Convenience method for lastModifiedDate(String).

Parameters:

lastModifiedDate -

Returns:

this builder

lastModifiedDate

public ModifyDatastream lastModifiedDate(Date lastModifiedDate)

Convenience method for lastModifiedDate(String).

Parameters:

lastModifiedDate -

Returns:

this builder

lastModifiedDate

public ModifyDatastream lastModifiedDate(String lastModifiedDate)

If provided, the server will use the supplied lastModifedDate to prevent concurrent modifications, only performing the request if the datastream has not been modified since the request-provided lastModifiedDate. Otherwise, the request will fail with an HTTP 409 Conflict.

Typical usage would be to get the lastModifiedDate of a datastream before modification, and then to pass that date as part of the subsequent modify request, which would then only succeed if the datastream has not been already modified since.

Supported against Fedora 3.4.0 and later (with earlier versions, this parameter is ignored).

Parameters:

lastModifiedDate - an xsd:dateTime string, e.g. 2001-12-31T12:50:01.000Z

Returns:

this builder

logMessage

public ModifyDatastream logMessage(String logMessage)

mimeType

public ModifyDatastream mimeType(String mimeType)

Set the mime type of the datastream.

If not set, fedora-client will make a best-guess based on the actual content.

Parameters:

mimeType - the mime type of the datastream.

Returns:

this builder

versionable

public ModifyDatastream versionable(boolean versionable)

Enable versioning of the datastream.

Parameters:

versionable -

Returns:

this builder

content

public ModifyDatastream content(File content)

content

public ModifyDatastream content(InputStream content)

content

public ModifyDatastream content(String content)

execute

public ModifyDatastreamResponse execute()
                                 throws FedoraClientException

Description copied from class: FedoraRequest

Executes this request against the FedoraRequest.DEFAULT_CLIENT

Overrides:

execute in class FedoraRequest<ModifyDatastream>

Returns:

the FedoraResponse to this request

Throws:

FedoraClientException - if FedoraRequest.DEFAULT_CLIENT is null

execute

public ModifyDatastreamResponse execute(FedoraClient fedora)
                                 throws FedoraClientException

Description copied from class: FedoraRequest

Execute this request using the supplied FedoraClient instance.

Specified by:

execute in class FedoraRequest<ModifyDatastream>

Parameters:

fedora - an instance of FedoraClient

Returns:

the response

Throws:

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