org.fcrepo.oai.service

Class OAIProviderService

java.lang.Object

org.fcrepo.oai.service.OAIProviderService

public class OAIProviderService
extends Object

The type OAI provider service.

Author:

lsitu, Frank Asseg

Constructor Summary

Constructors

Constructor and Description
OAIProviderService() Instantiates a new OAI provider service.

Method Summary

Modifier and Type	Method and Description
String	createSet(javax.jcr.Session session, javax.ws.rs.core.UriInfo uriInfo, InputStream src) Create set.
static ResumptionToken	decodeResumptionToken(String token) Decode resumption token.
static String	encodeResumptionToken(String verb, String metadataPrefix, String from, String until, String set, int offset) Encode resumption token.
static JAXBElement<org.openarchives.oai._2.OAIPMHtype>	error(org.openarchives.oai._2.VerbType verb, String identifier, String metadataPrefix, org.openarchives.oai._2.OAIPMHerrorcodeType errorCode, String msg) Creates a OAI error response for JAX-B
JAXBElement<org.openarchives.oai._2.OAIPMHtype>	getRecord(javax.jcr.Session session, javax.ws.rs.core.UriInfo uriInfo, String identifier, String metadataPrefix) Gets record.
JAXBElement<org.openarchives.oai._2.OAIPMHtype>	identify(javax.jcr.Session session, javax.ws.rs.core.UriInfo uriInfo) Identify jAXB element.
void	init() Service intitialization
JAXBElement<org.openarchives.oai._2.OAIPMHtype>	listIdentifiers(javax.jcr.Session session, javax.ws.rs.core.UriInfo uriInfo, String metadataPrefix, String from, String until, String set, int offset) List identifiers.
JAXBElement<org.openarchives.oai._2.OAIPMHtype>	listMetadataFormats(javax.jcr.Session session, javax.ws.rs.core.UriInfo uriInfo, String identifier) List metadata formats.
JAXBElement<org.openarchives.oai._2.OAIPMHtype>	listRecords(javax.jcr.Session session, javax.ws.rs.core.UriInfo uriInfo, String metadataPrefix, String from, String until, String set, int offset) List records.
JAXBElement<org.openarchives.oai._2.OAIPMHtype>	listSets(javax.jcr.Session session, javax.ws.rs.core.UriInfo uriInfo, int offset) List sets.
void	setAutoGenerateOaiDc(boolean autoGenerateOaiDc) Sets auto generate oai dc.
void	setDescriptiveContent(Map<String,String> descriptiveContent) Sets descriptive content.
void	setMaxListSize(int maxListSize) Sets max list size.
void	setMetadataFormats(Map<String,MetadataFormat> metadataFormats) Sets metadata formats.
void	setOaiNamespace(String oaiNamespace) Set oaiNamespace
void	setPropertyHasSets(String propertyHasSets) Sets property has sets.
void	setPropertyHasSetSpec(String propertyHasSetSpec) Sets property has set spec.
void	setPropertyIsPartOfSet(String propertyIsPartOfSet) Sets property is part of set.
void	setPropertyOaiAdminEmail(String propertyOaiAdminEmail) Set propertyOaiAdminEmail
void	setPropertyOaiDescription(String propertyOaiDescription) Set propertyOaiDescription
void	setPropertyOaiRepositoryName(String propertyOaiRepositoryName) Set propertyOaiRepositoryName
void	setPropertySetName(String propertySetName) Sets property set name.
void	setSetsEnabled(boolean setsEnabled) Sets sets enabled.
void	setSetsRootPath(String setsRootPath) Sets sets root path.
static String	urlDecode(String value) Url decode.
static String	urlEncode(String value) Url encode.

Methods inherited from class java.lang.Object

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

Constructor Detail

OAIProviderService

public OAIProviderService()
                   throws DatatypeConfigurationException,
                          JAXBException

Instantiates a new OAI provider service.

Throws:

DatatypeConfigurationException - the datatype configuration exception

JAXBException - the jAXB exception

Method Detail

setPropertyHasSetSpec

public void setPropertyHasSetSpec(String propertyHasSetSpec)

Sets property has set spec.

Parameters:

propertyHasSetSpec - the property has set spec

setPropertySetName

public void setPropertySetName(String propertySetName)

Sets property set name.

Parameters:

propertySetName - the property set name

setPropertyHasSets

public void setPropertyHasSets(String propertyHasSets)

Sets property has sets.

Parameters:

propertyHasSets - the property has sets

setMaxListSize

public void setMaxListSize(int maxListSize)

Sets max list size.

Parameters:

maxListSize - the max list size

setPropertyIsPartOfSet

public void setPropertyIsPartOfSet(String propertyIsPartOfSet)

Sets property is part of set.

Parameters:

propertyIsPartOfSet - the property is part of set

setPropertyOaiRepositoryName

public void setPropertyOaiRepositoryName(String propertyOaiRepositoryName)

Set propertyOaiRepositoryName

Parameters:

propertyOaiRepositoryName - the oai repository name

setPropertyOaiDescription

public void setPropertyOaiDescription(String propertyOaiDescription)

Set propertyOaiDescription

Parameters:

propertyOaiDescription - the oai description

setPropertyOaiAdminEmail

public void setPropertyOaiAdminEmail(String propertyOaiAdminEmail)

Set propertyOaiAdminEmail

Parameters:

propertyOaiAdminEmail - the oai admin email

setOaiNamespace

public void setOaiNamespace(String oaiNamespace)

Set oaiNamespace

Parameters:

oaiNamespace - the oai namespace

setSetsRootPath

public void setSetsRootPath(String setsRootPath)

Sets sets root path.

Parameters:

setsRootPath - the sets root path

setSetsEnabled

public void setSetsEnabled(boolean setsEnabled)

Sets sets enabled.

Parameters:

setsEnabled - the sets enabled

setAutoGenerateOaiDc

public void setAutoGenerateOaiDc(boolean autoGenerateOaiDc)

Sets auto generate oai dc.

Parameters:

autoGenerateOaiDc - the auto generate oai dc

setMetadataFormats

public void setMetadataFormats(Map<String,MetadataFormat> metadataFormats)

Sets metadata formats.

Parameters:

metadataFormats - the metadata formats

setDescriptiveContent

public void setDescriptiveContent(Map<String,String> descriptiveContent)

Sets descriptive content.

Parameters:

descriptiveContent - the descriptive content

init

@PostConstruct
public void init()
                         throws javax.jcr.RepositoryException

Service intitialization

Throws:

javax.jcr.RepositoryException - the repository exception

identify

public JAXBElement<org.openarchives.oai._2.OAIPMHtype> identify(javax.jcr.Session session,
                                                                javax.ws.rs.core.UriInfo uriInfo)
                                                         throws javax.jcr.RepositoryException,
                                                                JAXBException

Identify jAXB element.

Parameters:

session - the session

uriInfo - the uri info

Returns:

the jAXB element

Throws:

javax.jcr.RepositoryException - the repository exception

JAXBException - the jAXB exception

listMetadataFormats

public JAXBElement<org.openarchives.oai._2.OAIPMHtype> listMetadataFormats(javax.jcr.Session session,
                                                                           javax.ws.rs.core.UriInfo uriInfo,
                                                                           String identifier)
                                                                    throws javax.jcr.RepositoryException

List metadata formats.

Parameters:

session - the session

uriInfo - the uri info

identifier - the identifier

Returns:

the jAXB element

Throws:

javax.jcr.RepositoryException - the repository exception

getRecord

public JAXBElement<org.openarchives.oai._2.OAIPMHtype> getRecord(javax.jcr.Session session,
                                                                 javax.ws.rs.core.UriInfo uriInfo,
                                                                 String identifier,
                                                                 String metadataPrefix)
                                                          throws javax.jcr.RepositoryException

Gets record.

Parameters:

session - the session

uriInfo - the uri info

identifier - the identifier

metadataPrefix - the metadata prefix

Returns:

the record

Throws:

javax.jcr.RepositoryException - the repository exception

error

public static JAXBElement<org.openarchives.oai._2.OAIPMHtype> error(org.openarchives.oai._2.VerbType verb,
                                                                    String identifier,
                                                                    String metadataPrefix,
                                                                    org.openarchives.oai._2.OAIPMHerrorcodeType errorCode,
                                                                    String msg)

Creates a OAI error response for JAX-B

Parameters:

verb - the verb

identifier - the identifier

metadataPrefix - the metadata prefix

errorCode - the error code

msg - the msg

Returns:

the jAXB element

listIdentifiers

public JAXBElement<org.openarchives.oai._2.OAIPMHtype> listIdentifiers(javax.jcr.Session session,
                                                                       javax.ws.rs.core.UriInfo uriInfo,
                                                                       String metadataPrefix,
                                                                       String from,
                                                                       String until,
                                                                       String set,
                                                                       int offset)
                                                                throws javax.jcr.RepositoryException

List identifiers.

Parameters:

session - the session

uriInfo - the uri info

metadataPrefix - the metadata prefix

from - the from

until - the until

set - the set

offset - the offset

Returns:

the jAXB element

Throws:

javax.jcr.RepositoryException - the repository exception

encodeResumptionToken

public static String encodeResumptionToken(String verb,
                                           String metadataPrefix,
                                           String from,
                                           String until,
                                           String set,
                                           int offset)
                                    throws UnsupportedEncodingException

Encode resumption token.

Parameters:

verb - the verb

metadataPrefix - the metadata prefix

from - the from

until - the until

set - the set

offset - the offset

Returns:

the string

Throws:

UnsupportedEncodingException - the unsupported encoding exception

urlEncode

public static String urlEncode(String value)
                        throws UnsupportedEncodingException

Url encode.

Parameters:

value - the value

Returns:

the string

Throws:

UnsupportedEncodingException - the unsupported encoding exception

urlDecode

public static String urlDecode(String value)
                        throws UnsupportedEncodingException

Url decode.

Parameters:

value - the value

Returns:

the string

Throws:

UnsupportedEncodingException - the unsupported encoding exception

decodeResumptionToken

public static ResumptionToken decodeResumptionToken(String token)
                                             throws UnsupportedEncodingException

Decode resumption token.

Parameters:

token - the token

Returns:

the resumption token

Throws:

UnsupportedEncodingException - the unsupported encoding exception

listSets

public JAXBElement<org.openarchives.oai._2.OAIPMHtype> listSets(javax.jcr.Session session,
                                                                javax.ws.rs.core.UriInfo uriInfo,
                                                                int offset)
                                                         throws javax.jcr.RepositoryException

List sets.

Parameters:

session - the session

uriInfo - the uri info

offset - the offset

Returns:

the jAXB element

Throws:

javax.jcr.RepositoryException - the repository exception

createSet

public String createSet(javax.jcr.Session session,
                        javax.ws.rs.core.UriInfo uriInfo,
                        InputStream src)
                 throws javax.jcr.RepositoryException

Create set.

Parameters:

session - the session

uriInfo - the uri info

src - the src

Returns:

the string

Throws:

javax.jcr.RepositoryException - the repository exception

listRecords

public JAXBElement<org.openarchives.oai._2.OAIPMHtype> listRecords(javax.jcr.Session session,
                                                                   javax.ws.rs.core.UriInfo uriInfo,
                                                                   String metadataPrefix,
                                                                   String from,
                                                                   String until,
                                                                   String set,
                                                                   int offset)
                                                            throws javax.jcr.RepositoryException

List records.

Parameters:

session - the session

uriInfo - the uri info

metadataPrefix - the metadata prefix

from - the from

until - the until

set - the set

offset - the offset

Returns:

the jAXB element

Throws:

javax.jcr.RepositoryException - the repository exception