com.yourmediashelf.fedora.client.request

Class GetObjectProfile

java.lang.Object

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

com.yourmediashelf.fedora.client.request.GetObjectProfile

public class GetObjectProfile
extends FedoraRequest<GetObjectProfile>

Builder for the GetObjectProfile method.

Author:

Edwin Shin

Constructor Summary

Constructors

Constructor and Description
GetObjectProfile(String pid)

Method Summary

Methods

Modifier and Type	Method and Description
GetObjectProfile	asOfDateTime(String asOfDateTime)
GetObjectProfileResponse	execute() Executes this request against the FedoraRequest.DEFAULT_CLIENT
GetObjectProfileResponse	execute(FedoraClient fedora) Execute this request using the supplied FedoraClient instance.
GetObjectProfile	format(String format) The format of the response.

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

GetObjectProfile

public GetObjectProfile(String pid)

Parameters:

pid - persistent identifier of the digital object

Method Detail

asOfDateTime

public GetObjectProfile asOfDateTime(String asOfDateTime)

Parameters:

asOfDateTime - yyyy-MM-dd or yyyy-MM-ddTHH:mm:ssZ

Returns:

this builder

format

public GetObjectProfile format(String format)

The format of the response. Defaults to "xml".

The Fedora REST API default is "html", but fedora-client will set "xml" as the default in order to parse the response. If "html" is selected, the caller is responsible for parsing the raw HTTP response as most of the FedoraResponse convenience methods rely on an XML response.

Parameters:

format - "html" or "xml". Defaults to "xml".

Returns:

this builder

execute

public GetObjectProfileResponse execute()
                                 throws FedoraClientException

Description copied from class: FedoraRequest

Executes this request against the FedoraRequest.DEFAULT_CLIENT

Overrides:

execute in class FedoraRequest<GetObjectProfile>

Returns:

the FedoraResponse to this request

Throws:

FedoraClientException - if FedoraRequest.DEFAULT_CLIENT is null

execute

public GetObjectProfileResponse execute(FedoraClient fedora)
                                 throws FedoraClientException

Description copied from class: FedoraRequest

Execute this request using the supplied FedoraClient instance.

Specified by:

execute in class FedoraRequest<GetObjectProfile>

Parameters:

fedora - an instance of FedoraClient

Returns:

the response

Throws:

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