com.yourmediashelf.fedora.client

Class FedoraClient

java.lang.Object

com.yourmediashelf.fedora.client.FedoraClient

public class FedoraClient
extends Object

A client for the Fedora REST API.

Author:

Edwin Shin

Constructor Summary

Constructors

Constructor and Description
FedoraClient(FedoraCredentials fc) Constructor for FedoraClient.

Method Summary

Methods

Modifier and Type	Method and Description
static AddDatastream	addDatastream(String pid, String dsId) Static convenience method for the AddDatastream request.
static AddRelationship	addRelationship(String subject) Static convenience method for the AddRelationship request.
void	debug(boolean debug) If enabled, adds a logging filter to all requests that outputs to System.out.
static DescribeRepository	describeRepository() Static convenience method for the DescribeRepository request.
FedoraResponse	execute(FedoraRequest<?> method) Convenience method for executing FedoraRequests.
static Export	export(String pid)
static FindObjects	findObjects()
static GetDatastream	getDatastream(String pid, String dsId)
static GetDatastreamDissemination	getDatastreamDissemination(String pid, String dsId)
static GetDatastreamHistory	getDatastreamHistory(String pid, String dsId)
static GetDatastreams	getDatastreams(String pid)
static GetDissemination	getDissemination(String pid, String sdefPid, String method)
Date	getLastModifiedDate(String pid) Convenience method for returning the lastModifiedDate of an object.
Date	getLastModifiedDate(String pid, String dsId) Convenience method for returning the lastModifiedDate of a datastream.
String	getMimeType(File file)
static GetNextPID	getNextPID()
static GetObjectHistory	getObjectHistory(String pid)
static GetObjectProfile	getObjectProfile(String pid)
static GetObjectXML	getObjectXML(String pid)
static GetRelationships	getRelationships(String subject)
String	getServerVersion() Get the version of the Fedora Repository this client is associated with as reported by DescribeRepository
static Ingest	ingest() Ingest request that uses a server-assigned pid
static Ingest	ingest(String pid)
static ListDatastreams	listDatastreams(String pid)
static ListMethods	listMethods(String pid)
static ListMethods	listMethods(String pid, String sdefPid)
static ModifyDatastream	modifyDatastream(String pid, String dsId)
static ModifyObject	modifyObject(String pid)
static PurgeDatastream	purgeDatastream(String pid, String dsId)
static PurgeObject	purgeObject(String pid)
static PurgeRelationship	purgeRelationship(String subject)
com.sun.jersey.api.client.WebResource	resource()
com.sun.jersey.api.client.WebResource	resource(String uri)
static RiSearch	riSearch(String query)
static Upload	upload(File file)
static Validate	validate(String pid)

Methods inherited from class java.lang.Object

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

Constructor Detail

FedoraClient

public FedoraClient(FedoraCredentials fc)

Constructor for FedoraClient.

Parameters:

fc - credentials for a Fedora repository

Method Detail

execute

public FedoraResponse execute(FedoraRequest<?> method)
                       throws FedoraClientException

Convenience method for executing FedoraRequests. Note that this method returns a FedoraResponse and therefore requires an explicit cast if a specific implementation of FedoraResponse is desired.

The preferred usage is actually the reverse: pass an instance of FedoraClient to the FedoraRequest, e.g.

    IngestResponse r = new Ingest("my:pid").execute(client);

As a further shorthand, if the default instance of FedoraClient that FedoraRequests should use is set (FedoraRequest.setDefaultClient(FedoraClient)), then you can use the following:

    IngestResponse r = new Ingest("my:pid").execute();

Finally, FedoraClient provides a number of static convenience methods for FedoraRequests. Therefore, with a static import, the following, abbreviated syntax can be used:

import static com.yourmediashelf.fedora.client.FedoraClient.*;
 ...
     IngestResponse r = ingest("my:pid").execute();

Parameters:

method - a FedoraRequest

Returns:

the wrapped HTTP response

Throws:

FedoraClientException

resource

public com.sun.jersey.api.client.WebResource resource()

resource

public com.sun.jersey.api.client.WebResource resource(String uri)

getMimeType

public String getMimeType(File file)

getLastModifiedDate

public Date getLastModifiedDate(String pid)
                         throws FedoraClientException

Convenience method for returning the lastModifiedDate of an object.

Equivalent to getObjectProfile(pid).execute().getLastModifiedDate().

Parameters:

pid - the pid of the object

Returns:

the lastModifiedDate of the requested object

Throws:

FedoraClientException

getLastModifiedDate

public Date getLastModifiedDate(String pid,
                       String dsId)
                         throws FedoraClientException

Convenience method for returning the lastModifiedDate of a datastream.

Equivalent to getDatastream(pid, dsId).execute().getLastModifiedDate().

Parameters:

pid - the pid of the object

dsId - the datastream ID

Returns:

the lastModifiedDate of the requested datastream

Throws:

FedoraClientException

debug

public void debug(boolean debug)

If enabled, adds a logging filter to all requests that outputs to System.out.

Parameters:

debug - true to enable debugging

getServerVersion

public String getServerVersion()
                        throws FedoraClientException

Get the version of the Fedora Repository this client is associated with as reported by DescribeRepository

Returns:

the version of the Fedora Repository this client is associated with.

Throws:

FedoraClientException

addDatastream

public static AddDatastream addDatastream(String pid,
                          String dsId)

Static convenience method for the AddDatastream request.

Equivalent to invoking: new AddDatastream(pid, dsId).

Parameters:

pid - the pid of the object to add the datastream to.

dsId - the identifier of the datastream to be added.

Returns:

builder for the AddDatastream method

See Also:

AddDatastream

addRelationship

public static AddRelationship addRelationship(String subject)

Static convenience method for the AddRelationship request.

Equivalent to invoking: new AddRelationship(subject).

Parameters:

subject - the subject of the object (e.g. demo:123 or info:fedora/demo:123/DC)

Returns:

builder for the AddRelationship method

See Also:

AddRelationship

describeRepository

public static DescribeRepository describeRepository()

Static convenience method for the DescribeRepository request.

Equivalent to invoking: new DescribeRepository().

Returns:

builder for the DescribeRepository method

See Also:

DescribeRepository

export

public static Export export(String pid)

findObjects

public static FindObjects findObjects()

getDatastream

public static GetDatastream getDatastream(String pid,
                          String dsId)

getDatastreams

public static GetDatastreams getDatastreams(String pid)

getDatastreamDissemination

public static GetDatastreamDissemination getDatastreamDissemination(String pid,
                                                    String dsId)

getDatastreamHistory

public static GetDatastreamHistory getDatastreamHistory(String pid,
                                        String dsId)

getDissemination

public static GetDissemination getDissemination(String pid,
                                String sdefPid,
                                String method)

getNextPID

public static GetNextPID getNextPID()

getObjectHistory

public static GetObjectHistory getObjectHistory(String pid)

getObjectProfile

public static GetObjectProfile getObjectProfile(String pid)

getObjectXML

public static GetObjectXML getObjectXML(String pid)

getRelationships

public static GetRelationships getRelationships(String subject)

ingest

public static Ingest ingest()

Ingest request that uses a server-assigned pid

Returns:

builder for the Ingest method

ingest

public static Ingest ingest(String pid)

Parameters:

pid - persistent identifier of the object to be created

Returns:

builder for the Ingest method

See Also:

Ingest

listDatastreams

public static ListDatastreams listDatastreams(String pid)

listMethods

public static ListMethods listMethods(String pid)

listMethods

public static ListMethods listMethods(String pid,
                      String sdefPid)

modifyDatastream

public static ModifyDatastream modifyDatastream(String pid,
                                String dsId)

modifyObject

public static ModifyObject modifyObject(String pid)

purgeDatastream

public static PurgeDatastream purgeDatastream(String pid,
                              String dsId)

purgeObject

public static PurgeObject purgeObject(String pid)

purgeRelationship

public static PurgeRelationship purgeRelationship(String subject)

riSearch

public static RiSearch riSearch(String query)

upload

public static Upload upload(File file)

validate

public static Validate validate(String pid)