org.fcrepo.server.rest
Class DescribeRepositoryResource

java.lang.Object
  org.fcrepo.server.rest.BaseRestResource
      org.fcrepo.server.rest.DescribeRepositoryResource

All Implemented Interfaces:

Constants

@Component
public class DescribeRepositoryResource
extends BaseRestResource
implements Constants

Implements the "describeRepository" functionality of the Fedora Access LITE (API-A-LITE) interface using a java servlet front end. The syntax defined by API-A-LITE has for getting a description of the repository has the following binding:

1. describeRepository URL syntax: protocol://hostname:port/fedora/describe[?xml=BOOLEAN] This syntax requests information about the repository. The xml parameter determines the type of output returned. If the parameter is omitted or has a value of "false", a MIME-typed stream consisting of an html table is returned providing a browser-savvy means of viewing the object profile. If the value specified is "true", then a MIME-typed stream consisting of XML is returned.
• protocol - either http or https.
• hostname - required hostname of the Fedora server.
• port - required port number on which the Fedora server is running.
• fedora - required name of the Fedora access service.
• describe - required verb of the Fedora service.
• xml - an optional parameter indicating the requested output format. A value of "true" indicates a return type of text/xml; the absence of the xml parameter or a value of "false" indicates format is to be text/html.

Version:

$Id$

Author:

Ross Wayland, Benjamin Armintor armintor@gmail.com

Nested Class Summary

class	DescribeRepositoryResource.HtmlTransformation
class	DescribeRepositoryResource.ReposInfoSerializer Serializes RepositoryInfo object into XML.

Nested classes/interfaces inherited from interface org.fcrepo.common.Constants

Constants.FedoraHome

Field Summary

Fields inherited from class org.fcrepo.server.rest.BaseRestResource

APP_ZIP, FORM, HTML, m_access, m_datastreamFilenameHelper, m_headers, m_hostname, m_management, m_mapper, m_server, m_servletRequest, m_uriInfo, TEXT_HTML, TEXT_XML, VALID_PID_PART, XML, ZIP

Fields inherited from interface org.fcrepo.common.Constants

ACCESS, ACTION, API, ATOM_APIM1_0, ATOM_ZIP1_1, ATOM1_1, AUDIT, AUDIT1_0, BATCH_MODIFY, BATCH_MODIFY1_1, BE_SECURITY, BE_SECURITY1_0, BINDING_SPEC, DATASTREAM, DC, DISSEMINATOR, DS_COMPOSITE_MODEL, DS_COMPOSITE_MODEL1_0, DS_INPUT_SPEC1_0, DS_INPUT_SPEC1_1, ENVIRONMENT, FCFG, FEDORA, FEDORA_APP_CONTEXT_NAME, FEDORA_DEFAULT_APP_CONTEXT, FEDORA_HOME, FOXML, FOXML1_0, FOXML1_0_LEGACY, FOXML1_1, HTTP_REQUEST, MANAGEMENT, METHOD_MAP, METS, METS_EXT, METS_EXT1_0, METS_EXT1_0_LEGACY, METS_EXT1_1, MODEL, MULGARA, OAI_DC, OAI_DC2_0, OAI_FRIENDS, OAI_FRIENDS2_0, OAI_IDENTIFIER, OAI_IDENTIFIER2_0, OAI_PMH, OAI_PMH2_0, OAI_PROV, OAI_PROV2_0, OBJ_DATASTREAMS1_0, OBJ_HISTORY1_0, OBJ_ITEMS1_0, OBJ_METHODS1_0, OBJ_PROFILE1_0, OBJ_VALIDATION1_0, OBJECT, OLD_XLINK, PID_LIST1_0, RDF, RDF_XSD, RECOVERY, RELS_EXT, RELS_EXT1_0, RELS_INT1_0, REPO_DESC1_0, RESOURCE, SDEF, SDEF_METHOD_MAP1_0, SDEP, SDEP_METHOD_MAP1_0, SDEP_METHOD_MAP1_1, SERVICE_PROFILE, SOAP, SOAP_ENC, SUBJECT, TYPES, VIEW, WSDL, WSDL_HTTP, WSDL_MIME, XACML_POLICY, XACML_POLICY1_0, XLINK, XML_XSD, XMLNS, XSI

Constructor Summary

DescribeRepositoryResource(Server server)


Method Summary

javax.ws.rs.core.Response	describe(boolean xml) Process Fedora Access Request.
javax.ws.rs.core.Response	describeRepository(Context context, boolean xml)
javax.ws.rs.core.Response	postDescribe(boolean xml)

Methods inherited from class org.fcrepo.server.rest.BaseRestResource

buildResponse, getContext, getSerializer, handleException, transform

Methods inherited from class java.lang.Object

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

Constructor Detail

DescribeRepositoryResource

public DescribeRepositoryResource(Server server)

Method Detail

describe

public javax.ws.rs.core.Response describe(boolean xml)
                                   throws javax.servlet.ServletException,
                                          IOException

Process Fedora Access Request. Parse and validate the servlet input parameters and then execute the specified request.

Parameters:

request - The servlet request.

response - servlet The servlet response.

Throws:

javax.servlet.ServletException - If an error occurs that effects the servlet's basic operation.

IOException - If an error occurs with an input or output operation.

postDescribe

public javax.ws.rs.core.Response postDescribe(boolean xml)
                                       throws javax.servlet.ServletException,
                                              IOException

Throws:

javax.servlet.ServletException

IOException

describeRepository

public javax.ws.rs.core.Response describeRepository(Context context,
                                                    boolean xml)
                                             throws ServerException

Throws:

ServerException