com.yourmediashelf.fedora.client.request

Class DescribeRepository

java.lang.Object

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

com.yourmediashelf.fedora.client.request.DescribeRepository

public class DescribeRepository
extends FedoraRequest<DescribeRepository>

Builder for the DescribeRepository method.

As there is currently no REST-API implementation of DescribeRepository, this request will be executed using the API-A-Lite interface.

Author:

Edwin Shin

Constructor Summary

Constructors

Constructor and Description
DescribeRepository()

Method Summary

Methods

Modifier and Type	Method and Description
DescribeRepositoryResponse	execute() Executes this request against the FedoraRequest.DEFAULT_CLIENT
DescribeRepositoryResponse	execute(FedoraClient fedora) Execute this request using the supplied FedoraClient instance.
DescribeRepository	xml(boolean xml) Format the response as XML.

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

DescribeRepository

public DescribeRepository()

Method Detail

xml

public DescribeRepository xml(boolean xml)

Format the response as XML. Defaults to "true".

Parameters:

xml - Defaults to true.

Returns:

this builder

execute

public DescribeRepositoryResponse execute()
                                   throws FedoraClientException

Description copied from class: FedoraRequest

Executes this request against the FedoraRequest.DEFAULT_CLIENT

Overrides:

execute in class FedoraRequest<DescribeRepository>

Returns:

the FedoraResponse to this request

Throws:

FedoraClientException - if FedoraRequest.DEFAULT_CLIENT is null

execute

public DescribeRepositoryResponse execute(FedoraClient fedora)
                                   throws FedoraClientException

Description copied from class: FedoraRequest

Execute this request using the supplied FedoraClient instance.

Specified by:

execute in class FedoraRequest<DescribeRepository>

Parameters:

fedora - an instance of FedoraClient

Returns:

the response

Throws:

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