org.duracloud.durastore.rest

Class BaseRest

java.lang.Object

org.duracloud.durastore.rest.BaseRest

Direct Known Subclasses:

AuditLogRest, BitIntegrityReportRest, ContentRest, InitRest, ManifestRest, SecurityRest, SpaceRest, StoreRest, TaskRest

public abstract class BaseRest
extends Object

Base REST resource

Author:

Bill Branan

Field Summary

Fields

Modifier and Type	Field and Description
static String	APP_NAME
static javax.ws.rs.core.MediaType	APPLICATION_XML
static String	CONTENT_MIMETYPE_HEADER
static String	COPY_SOURCE_HEADER
static String	COPY_SOURCE_STORE_HEADER
static String	DEFAULT_MIME
static String	HEADER_PREFIX
static String	HTML
static String	SPACE_ACL_HEADER
static javax.ws.rs.core.MediaType	TEXT_PLAIN
static String	XML

Constructor Summary

Constructors

Constructor and Description
BaseRest()

Method Summary

Methods

Modifier and Type	Method and Description
protected Map<String,org.duracloud.common.model.AclType>	getSpaceACLs()
protected String	getSubdomain()
protected Map<String,String>	getUserProperties()
protected Map<String,String>	getUserProperties(String... exclusions) Looks through the request headers and pulls out user properties.
protected javax.ws.rs.core.Response	responseBad(Exception e)
protected javax.ws.rs.core.Response	responseBad(Exception e, javax.ws.rs.core.Response.Status status)
protected javax.ws.rs.core.Response	responseBad(String msg, javax.ws.rs.core.Response.Status status)
protected javax.ws.rs.core.Response	responseBadRequest(Exception e)
protected javax.ws.rs.core.Response	responseNotFound()
protected javax.ws.rs.core.Response	responseNotFound(String msg)
protected javax.ws.rs.core.Response	responseOk()
protected javax.ws.rs.core.Response	responseOk(String text)
protected javax.ws.rs.core.Response	responseOkStream(InputStream text)
protected javax.ws.rs.core.Response	responseOkXml(String xml)
protected javax.ws.rs.core.Response	responseOkXmlStream(InputStream xml)

Methods inherited from class java.lang.Object

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

Field Detail

XML

public static final String XML

See Also:

Constant Field Values

HTML

public static final String HTML

See Also:

Constant Field Values

APPLICATION_XML

public static final javax.ws.rs.core.MediaType APPLICATION_XML

TEXT_PLAIN

public static final javax.ws.rs.core.MediaType TEXT_PLAIN

DEFAULT_MIME

public static final String DEFAULT_MIME

See Also:

Constant Field Values

HEADER_PREFIX

public static final String HEADER_PREFIX

See Also:

Constant Field Values

SPACE_ACL_HEADER

public static final String SPACE_ACL_HEADER

See Also:

Constant Field Values

CONTENT_MIMETYPE_HEADER

public static final String CONTENT_MIMETYPE_HEADER

See Also:

Constant Field Values

COPY_SOURCE_HEADER

public static final String COPY_SOURCE_HEADER

See Also:

Constant Field Values

COPY_SOURCE_STORE_HEADER

public static final String COPY_SOURCE_STORE_HEADER

See Also:

Constant Field Values

APP_NAME

public static final String APP_NAME

See Also:

Constant Field Values

Constructor Detail

BaseRest

public BaseRest()

Method Detail

getUserProperties

protected Map<String,String> getUserProperties(String... exclusions)

Looks through the request headers and pulls out user properties. Only includes items which are not in the exclusions list.

getUserProperties

protected Map<String,String> getUserProperties()

getSpaceACLs

protected Map<String,org.duracloud.common.model.AclType> getSpaceACLs()

responseOk

protected javax.ws.rs.core.Response responseOk()

responseOk

protected javax.ws.rs.core.Response responseOk(String text)

responseOkStream

protected javax.ws.rs.core.Response responseOkStream(InputStream text)

responseOkXml

protected javax.ws.rs.core.Response responseOkXml(String xml)

responseOkXmlStream

protected javax.ws.rs.core.Response responseOkXmlStream(InputStream xml)

responseNotFound

protected javax.ws.rs.core.Response responseNotFound()

responseNotFound

protected javax.ws.rs.core.Response responseNotFound(String msg)

responseBadRequest

protected javax.ws.rs.core.Response responseBadRequest(Exception e)

responseBad

protected javax.ws.rs.core.Response responseBad(Exception e)

responseBad

protected javax.ws.rs.core.Response responseBad(Exception e,
                                    javax.ws.rs.core.Response.Status status)

responseBad

protected javax.ws.rs.core.Response responseBad(String msg,
                                    javax.ws.rs.core.Response.Status status)

getSubdomain

protected String getSubdomain()