org.fcrepo.client

Interface FedoraRepository

public interface FedoraRepository

The primary client class for interacting with a Fedora repository.

Since:

2014-08-01

Author:

escowles

Method Summary

Methods

Modifier and Type	Method and Description
void	addNamespace(String prefix, String uri) Register a namespace.
FedoraDatastream	createDatastream(String path, FedoraContent content) Create a new Datastream.
FedoraObject	createObject(String path) Create a new Object.
boolean	exists(String path) Check whether a path is an existing resource.
FedoraDatastream	findOrCreateDatastream(String path) Get an existing Datastream if it exists, otherwise create a new Datastream.
FedoraObject	findOrCreateObject(String path) Get an existing Object if it exists, otherwise create a new Object.
FedoraDatastream	getDatastream(String path) Get an existing Datastream.
Iterator<com.hp.hpl.jena.graph.Triple>	getNodeTypes() Get an RDF description of the node types configured for this repository.
FedoraObject	getObject(String path) Get an existing Object.
Map<String,String>	getRepositoryNamespaces() Get a map of namespace prefixes to URIs.
Long	getRepositoryObjectCount() Get the number of objects this repository contains.
Long	getRepositorySize() Get the size of the repository content in bytes.
String	getRepositoryUrl() Get the base URL for the repository.
boolean	isWritable() Check whether this repository is writable.
void	registerNodeTypes(InputStream cndStream) Update the node types for this repository.
void	removeNamespace(String prefix) Remove a namespace.

Method Detail

getRepositoryUrl

String getRepositoryUrl()

Get the base URL for the repository.

exists

boolean exists(String path)
               throws FedoraException

Check whether a path is an existing resource.

Parameters:

path - The resource path.

Throws:

FedoraException

getDatastream

FedoraDatastream getDatastream(String path)
                               throws FedoraException

Get an existing Datastream.

Parameters:

path - The Datastream path.

Throws:

FedoraException

getObject

FedoraObject getObject(String path)
                       throws FedoraException

Get an existing Object.

Parameters:

path - The Object path.

Throws:

FedoraException

createDatastream

FedoraDatastream createDatastream(String path,
                                FedoraContent content)
                                  throws FedoraException

Create a new Datastream.

Parameters:

path - The path of the new datastream.

content - Content of the new datastream.

Throws:

FedoraException

createObject

FedoraObject createObject(String path)
                          throws FedoraException

Create a new Object.

Parameters:

path - The Object path.

Throws:

FedoraException

findOrCreateDatastream

FedoraDatastream findOrCreateDatastream(String path)
                                        throws FedoraException

Get an existing Datastream if it exists, otherwise create a new Datastream.

Parameters:

path - The Datastream path.

Throws:

FedoraException

findOrCreateObject

FedoraObject findOrCreateObject(String path)
                                throws FedoraException

Get an existing Object if it exists, otherwise create a new Object.

Parameters:

path - The Object path.

Throws:

FedoraException

getNodeTypes

Iterator<com.hp.hpl.jena.graph.Triple> getNodeTypes()
                                                    throws FedoraException

Get an RDF description of the node types configured for this repository.

Throws:

FedoraException

registerNodeTypes

void registerNodeTypes(InputStream cndStream)
                       throws FedoraException

Update the node types for this repository.

Parameters:

cndStream - The new node type definition as a CND content stream.

Throws:

FedoraException

getRepositoryNamespaces

Map<String,String> getRepositoryNamespaces()
                                           throws FedoraException

Get a map of namespace prefixes to URIs.

Throws:

FedoraException

addNamespace

void addNamespace(String prefix,
                String uri)
                  throws FedoraException

Register a namespace.

Parameters:

prefix - The namespace prefix.

uri - The namespace URI.

Throws:

FedoraException

removeNamespace

void removeNamespace(String prefix)
                     throws FedoraException

Remove a namespace.

Parameters:

prefix - The namespace prefix.

Throws:

FedoraException

getRepositoryObjectCount

Long getRepositoryObjectCount()
                              throws FedoraException

Get the number of objects this repository contains.

Throws:

FedoraException

getRepositorySize

Long getRepositorySize()
                       throws FedoraException

Get the size of the repository content in bytes.

Throws:

FedoraException

isWritable

boolean isWritable()

Check whether this repository is writable.