A B C D F G H I L M O P R S T U V W

A

addBitstreamPolicy(Integer, ResourcePolicy, String, String, String, HttpHeaders, HttpServletRequest) - Method in class org.dspace.rest.BitstreamResource

Add bitstream policy to all bundles containing the bitstream.

addCollectionItem(Integer, Item, String, String, String, HttpHeaders, HttpServletRequest) - Method in class org.dspace.rest.CollectionsResource

Create item in collection.

addCommunityCollection(Integer, Collection, String, String, String, HttpHeaders, HttpServletRequest) - Method in class org.dspace.rest.CommunitiesResource

Create collection in community.

addCommunityCommunity(Integer, Community, String, String, String, HttpHeaders, HttpServletRequest) - Method in class org.dspace.rest.CommunitiesResource

Create subcommunity in community.

addExpand(String) - Method in class org.dspace.rest.common.DSpaceObject

addItemBitstream(Integer, InputStream, String, String, Integer, Integer, Integer, Integer, String, String, String, HttpHeaders, HttpServletRequest) - Method in class org.dspace.rest.ItemsResource

Create bitstream in item.

addItemMetadata(Integer, List<MetadataEntry>, String, String, String, HttpHeaders, HttpServletRequest) - Method in class org.dspace.rest.ItemsResource

Adding metadata fields to item.

addParentCommunityList(Community) - Method in class org.dspace.rest.common.Collection

B

Bitstream - Class in org.dspace.rest.common

Created with IntelliJ IDEA.

Bitstream() - Constructor for class org.dspace.rest.common.Bitstream

Bitstream(Bitstream, String) - Constructor for class org.dspace.rest.common.Bitstream

BitstreamResource - Class in org.dspace.rest

BitstreamResource() - Constructor for class org.dspace.rest.BitstreamResource

C

CheckSum - Class in org.dspace.rest.common

CheckSum() - Constructor for class org.dspace.rest.common.CheckSum

Collection - Class in org.dspace.rest.common

Created with IntelliJ IDEA.

Collection() - Constructor for class org.dspace.rest.common.Collection

Collection(Collection, String, Context, Integer, Integer) - Constructor for class org.dspace.rest.common.Collection

CollectionsResource - Class in org.dspace.rest

This class provides all CRUD operation over collections.

CollectionsResource() - Constructor for class org.dspace.rest.CollectionsResource

CommunitiesResource - Class in org.dspace.rest

Class which provides CRUD methods over communities.

CommunitiesResource() - Constructor for class org.dspace.rest.CommunitiesResource

Community - Class in org.dspace.rest.common

Created with IntelliJ IDEA.

Community() - Constructor for class org.dspace.rest.common.Community

Community(Community, String, Context) - Constructor for class org.dspace.rest.common.Community

ContextException - Exception in org.dspace.rest.exceptions

Simple exception which only encapsulate classic exception.

ContextException(String, Exception) - Constructor for exception org.dspace.rest.exceptions.ContextException

createCommunity(Community, String, String, String, HttpHeaders, HttpServletRequest) - Method in class org.dspace.rest.CommunitiesResource

Create community at top level.

createContext(EPerson) - Static method in class org.dspace.rest.Resource

Create context to work with DSpace database.

D

deleteBitstream(Integer, String, String, String, HttpHeaders, HttpServletRequest) - Method in class org.dspace.rest.BitstreamResource

Delete bitstream from all bundles in DSpace.

deleteBitstreamPolicy(Integer, Integer, String, String, String, HttpHeaders, HttpServletRequest) - Method in class org.dspace.rest.BitstreamResource

Delete policy.

deleteCollection(Integer, String, String, String, HttpHeaders, HttpServletRequest) - Method in class org.dspace.rest.CollectionsResource

Delete collection.

deleteCollectionItem(Integer, Integer, String, String, String, HttpHeaders, HttpServletRequest) - Method in class org.dspace.rest.CollectionsResource

Delete item in collection.

deleteCommunity(Integer, String, String, String, HttpHeaders, HttpServletRequest) - Method in class org.dspace.rest.CommunitiesResource

Delete community from DSpace.

deleteCommunityCollection(Integer, Integer, String, String, String, HttpHeaders, HttpServletRequest) - Method in class org.dspace.rest.CommunitiesResource

Delete collection in community.

deleteCommunityCommunity(Integer, Integer, String, String, String, HttpHeaders, HttpServletRequest) - Method in class org.dspace.rest.CommunitiesResource

Delete subcommunity in community.

deleteItem(Integer, String, String, String, HttpHeaders, HttpServletRequest) - Method in class org.dspace.rest.ItemsResource

Delete item from DSpace.

deleteItemBitstream(Integer, Integer, String, String, String, HttpHeaders, HttpServletRequest) - Method in class org.dspace.rest.ItemsResource

Delete bitstream from item bundle.

deleteItemMetadata(Integer, String, String, String, HttpHeaders, HttpServletRequest) - Method in class org.dspace.rest.ItemsResource

Delete all item metadata.

DSpaceObject - Class in org.dspace.rest.common

Created with IntelliJ IDEA.

DSpaceObject() - Constructor for class org.dspace.rest.common.DSpaceObject

DSpaceObject(DSpaceObject) - Constructor for class org.dspace.rest.common.DSpaceObject

F

findCollectionByName(String, HttpHeaders) - Method in class org.dspace.rest.CollectionsResource

Search for first collection with passed name.

findItemsByMetadataField(MetadataEntry, String, String, String, String, HttpHeaders, HttpServletRequest) - Method in class org.dspace.rest.ItemsResource

Find items by one metadada field.

G

getAction() - Method in class org.dspace.rest.common.ResourcePolicy

getActionInt() - Method in class org.dspace.rest.common.ResourcePolicy

getActionString(int) - Method in class org.dspace.rest.Resource

Return string representation of values org.dspace.core.Constants.{READ,WRITE,DELETE}.

getArchived() - Method in class org.dspace.rest.common.Item

getBitstream(Integer, String, String, String, String, HttpHeaders, HttpServletRequest) - Method in class org.dspace.rest.BitstreamResource

Return bitstream properties without file data.

getBitstreamData(Integer, String, String, String, HttpHeaders, HttpServletRequest) - Method in class org.dspace.rest.BitstreamResource

Read bitstream data.

getBitstreamPolicies(Integer, HttpHeaders) - Method in class org.dspace.rest.BitstreamResource

Return all bitstream resource policies from all bundles, in which the bitstream is present.

getBitstreams(String, Integer, Integer, String, String, String, HttpHeaders, HttpServletRequest) - Method in class org.dspace.rest.BitstreamResource

Read list of bitstreams.

getBitstreams() - Method in class org.dspace.rest.common.Item

getBundleName() - Method in class org.dspace.rest.common.Bitstream

getCausedBy() - Method in exception org.dspace.rest.exceptions.ContextException

getCheckSum() - Method in class org.dspace.rest.common.Bitstream

getCheckSumAlgorith() - Method in class org.dspace.rest.common.CheckSum

getCollection(Integer, String, Integer, Integer, String, String, String, HttpHeaders, HttpServletRequest) - Method in class org.dspace.rest.CollectionsResource

Return instance of collection with passed id.

getCollectionItems(Integer, String, Integer, Integer, String, String, String, HttpHeaders, HttpServletRequest) - Method in class org.dspace.rest.CollectionsResource

Return array of items in collection.

getCollections(String, Integer, Integer, String, String, String, HttpHeaders, HttpServletRequest) - Method in class org.dspace.rest.CollectionsResource

Return array of all collections in DSpace.

getCollections() - Method in class org.dspace.rest.common.Community

getCommunities(String, Integer, Integer, String, String, String, HttpHeaders, HttpServletRequest) - Method in class org.dspace.rest.CommunitiesResource

Return all communities in DSpace.

getCommunity(Integer, String, String, String, String, HttpHeaders, HttpServletRequest) - Method in class org.dspace.rest.CommunitiesResource

Returns community with basic properties.

getCommunityCollections(Integer, String, Integer, Integer, String, String, String, HttpHeaders, HttpServletRequest) - Method in class org.dspace.rest.CommunitiesResource

Return all collections of community.

getCommunityCommunities(Integer, String, Integer, Integer, String, String, String, HttpHeaders, HttpServletRequest) - Method in class org.dspace.rest.CommunitiesResource

Return all subcommunities of community.

getCopyrightText() - Method in class org.dspace.rest.common.Collection

getCopyrightText() - Method in class org.dspace.rest.common.Community

getCountItems() - Method in class org.dspace.rest.common.Community

getDescription() - Method in class org.dspace.rest.common.Bitstream

getEmail() - Method in class org.dspace.rest.common.Status

getEmail() - Method in class org.dspace.rest.common.User

getEndDate() - Method in class org.dspace.rest.common.ResourcePolicy

getEPerson(String) - Static method in class org.dspace.rest.TokenHolder

Return EPerson for log into context.

getEpersonId() - Method in class org.dspace.rest.common.ResourcePolicy

getExpand() - Method in class org.dspace.rest.common.DSpaceObject

getFormat() - Method in class org.dspace.rest.common.Bitstream

getFullname() - Method in class org.dspace.rest.common.Status

getGroupId() - Method in class org.dspace.rest.common.ResourcePolicy

getHandle() - Method in class org.dspace.rest.common.DSpaceObject

getId() - Method in class org.dspace.rest.common.DSpaceObject

getId() - Method in class org.dspace.rest.common.ResourcePolicy

getIntroductoryText() - Method in class org.dspace.rest.common.Collection

getIntroductoryText() - Method in class org.dspace.rest.common.Community

getItem(Integer, String, String, String, String, HttpHeaders, HttpServletRequest) - Method in class org.dspace.rest.ItemsResource

Return item properties without metadata and bitstreams.

getItemBitstreams(Integer, Integer, Integer, String, String, String, HttpHeaders, HttpServletRequest) - Method in class org.dspace.rest.ItemsResource

Return array of bitstreams in item.

getItemMetadata(Integer, String, String, String, HttpHeaders, HttpServletRequest) - Method in class org.dspace.rest.ItemsResource

Returns item metadata in list.

getItems() - Method in class org.dspace.rest.common.Collection

getItems(String, Integer, Integer, String, String, String, HttpHeaders, HttpServletRequest) - Method in class org.dspace.rest.ItemsResource

It returns an array of items in DSpace.

getKey() - Method in class org.dspace.rest.common.MetadataEntry

getLanguage() - Method in class org.dspace.rest.common.MetadataEntry

getLastModified() - Method in class org.dspace.rest.common.Item

getLicense() - Method in class org.dspace.rest.common.Collection

getLink() - Method in class org.dspace.rest.common.DSpaceObject

getLogo() - Method in class org.dspace.rest.common.Collection

getLogo() - Method in class org.dspace.rest.common.Community

getMetadata() - Method in class org.dspace.rest.common.Item

getMimeType() - Method in class org.dspace.rest.common.Bitstream

getName() - Method in class org.dspace.rest.common.DSpaceObject

getNumberItems() - Method in class org.dspace.rest.common.Collection

getObject(String, String, String, HttpHeaders) - Method in class org.dspace.rest.HandleResource

getParentCollection() - Method in class org.dspace.rest.common.Item

getParentCollectionList() - Method in class org.dspace.rest.common.Item

getParentCommunity() - Method in class org.dspace.rest.common.Collection

getParentCommunity() - Method in class org.dspace.rest.common.Community

getParentCommunityList() - Method in class org.dspace.rest.common.Collection

getParentCommunityList() - Method in class org.dspace.rest.common.Item

getParentObject() - Method in class org.dspace.rest.common.Bitstream

getPassword() - Method in class org.dspace.rest.common.User

getPolicies() - Method in class org.dspace.rest.common.Bitstream

getResourceId() - Method in class org.dspace.rest.common.ResourcePolicy

getResourceType() - Method in class org.dspace.rest.common.ResourcePolicy

getRetrieveLink() - Method in class org.dspace.rest.common.Bitstream

getRpDescription() - Method in class org.dspace.rest.common.ResourcePolicy

getRpName() - Method in class org.dspace.rest.common.ResourcePolicy

getRpType() - Method in class org.dspace.rest.common.ResourcePolicy

getSequenceId() - Method in class org.dspace.rest.common.Bitstream

getServletContextPath() - Static method in class org.dspace.rest.Resource

getShortDescription() - Method in class org.dspace.rest.common.Collection

getShortDescription() - Method in class org.dspace.rest.common.Community

getSidebarText() - Method in class org.dspace.rest.common.Collection

getSidebarText() - Method in class org.dspace.rest.common.Community

getSizeBytes() - Method in class org.dspace.rest.common.Bitstream

getStartDate() - Method in class org.dspace.rest.common.ResourcePolicy

getSubcommunities() - Method in class org.dspace.rest.common.Community

getToken() - Method in class org.dspace.rest.common.Status

getToken(HttpHeaders) - Static method in class org.dspace.rest.Resource

getTopCommunities(String, Integer, Integer, String, String, String, HttpHeaders, HttpServletRequest) - Method in class org.dspace.rest.CommunitiesResource

Return all top communities in DSpace.

getType() - Method in class org.dspace.rest.common.DSpaceObject

getUser(HttpHeaders) - Static method in class org.dspace.rest.Resource

Return EPerson based on stored token in headers under "rest-dspace-token".

getValue() - Method in class org.dspace.rest.common.CheckSum

getValue() - Method in class org.dspace.rest.common.MetadataEntry

getWithdrawn() - Method in class org.dspace.rest.common.Item

H

HandleResource - Class in org.dspace.rest

Created with IntelliJ IDEA.

HandleResource() - Constructor for class org.dspace.rest.HandleResource

I

isAuthenticated() - Method in class org.dspace.rest.common.Status

isOkay() - Method in class org.dspace.rest.common.Status

Item - Class in org.dspace.rest.common

Created with IntelliJ IDEA.

Item() - Constructor for class org.dspace.rest.common.Item

Item(Item, String, Context) - Constructor for class org.dspace.rest.common.Item

ItemsResource - Class in org.dspace.rest

Class which provide all CRUD methods over items.

ItemsResource() - Constructor for class org.dspace.rest.ItemsResource

L

login(User) - Method in class org.dspace.rest.RestIndex

Method to login a user into REST API.

login(User) - Static method in class org.dspace.rest.TokenHolder

Login user into rest api.

logout(HttpHeaders) - Method in class org.dspace.rest.RestIndex

Method to logout a user from DSpace REST API.

logout(String) - Static method in class org.dspace.rest.TokenHolder

Logout user from rest api.

M

MetadataEntry - Class in org.dspace.rest.common

MetadataEntry() - Constructor for class org.dspace.rest.common.MetadataEntry

MetadataEntry(String, String, String) - Constructor for class org.dspace.rest.common.MetadataEntry

mySplit(String) - Method in class org.dspace.rest.Resource

Split string with regex ".".

O

org.dspace.rest - package org.dspace.rest

org.dspace.rest.common - package org.dspace.rest.common

org.dspace.rest.exceptions - package org.dspace.rest.exceptions

P

processException(String, Context) - Static method in class org.dspace.rest.Resource

Process exception, print message to logger error stream and abort DSpace context.

processFinally(Context) - Method in class org.dspace.rest.Resource

Process finally statement.

R

Resource - Class in org.dspace.rest

Superclass of all resource classes in REST API.

Resource() - Constructor for class org.dspace.rest.Resource

ResourcePolicy - Class in org.dspace.rest.common

ResourcePolicy() - Constructor for class org.dspace.rest.common.ResourcePolicy

ResourcePolicy(ResourcePolicy) - Constructor for class org.dspace.rest.common.ResourcePolicy

ResourcePolicy.Action - Enum in org.dspace.rest.common

RestIndex - Class in org.dspace.rest

Root of RESTful api.

RestIndex() - Constructor for class org.dspace.rest.RestIndex

S

sayHtmlHello() - Method in class org.dspace.rest.RestIndex

Return html page with information about REST api.

servletContext - Static variable in class org.dspace.rest.Resource

servletContext - Static variable in class org.dspace.rest.RestIndex

setAction(ResourcePolicy.Action) - Method in class org.dspace.rest.common.ResourcePolicy

setArchived(String) - Method in class org.dspace.rest.common.Item

setAuthenticated(boolean) - Method in class org.dspace.rest.common.Status

setBitstreams(List<Bitstream>) - Method in class org.dspace.rest.common.Item

setBundleName(String) - Method in class org.dspace.rest.common.Bitstream

setCheckSum(CheckSum) - Method in class org.dspace.rest.common.Bitstream

setCheckSumAlgorith(String) - Method in class org.dspace.rest.common.CheckSum

setCollections(List<Collection>) - Method in class org.dspace.rest.common.Community

setCopyrightText(String) - Method in class org.dspace.rest.common.Collection

setCopyrightText(String) - Method in class org.dspace.rest.common.Community

setCountItems(Integer) - Method in class org.dspace.rest.common.Community

setDescription(String) - Method in class org.dspace.rest.common.Bitstream

setEmail(String) - Method in class org.dspace.rest.common.Status

setEmail(String) - Method in class org.dspace.rest.common.User

setEndDate(Date) - Method in class org.dspace.rest.common.ResourcePolicy

setEpersonId(Integer) - Method in class org.dspace.rest.common.ResourcePolicy

setExpand(ArrayList<String>) - Method in class org.dspace.rest.common.DSpaceObject

setFormat(String) - Method in class org.dspace.rest.common.Bitstream

setFullname(String) - Method in class org.dspace.rest.common.Status

setGroupId(Integer) - Method in class org.dspace.rest.common.ResourcePolicy

setHandle(String) - Method in class org.dspace.rest.common.DSpaceObject

setId(Integer) - Method in class org.dspace.rest.common.DSpaceObject

setId(Integer) - Method in class org.dspace.rest.common.ResourcePolicy

setIntroductoryText(String) - Method in class org.dspace.rest.common.Collection

setIntroductoryText(String) - Method in class org.dspace.rest.common.Community

setItems(List<Item>) - Method in class org.dspace.rest.common.Collection

setKey(String) - Method in class org.dspace.rest.common.MetadataEntry

setLanguage(String) - Method in class org.dspace.rest.common.MetadataEntry

setLastModified(String) - Method in class org.dspace.rest.common.Item

setLicense(String) - Method in class org.dspace.rest.common.Collection

setLogo(Bitstream) - Method in class org.dspace.rest.common.Community

setMetadata(List<MetadataEntry>) - Method in class org.dspace.rest.common.Item

setMimeType(String) - Method in class org.dspace.rest.common.Bitstream

setName(String) - Method in class org.dspace.rest.common.DSpaceObject

setNumberItems(Integer) - Method in class org.dspace.rest.common.Collection

setOkay(boolean) - Method in class org.dspace.rest.common.Status

setParentCollection(Collection) - Method in class org.dspace.rest.common.Item

setParentCollectionList(List<Collection>) - Method in class org.dspace.rest.common.Item

setParentCommunity(Community) - Method in class org.dspace.rest.common.Collection

setParentCommunity(Community) - Method in class org.dspace.rest.common.Community

setParentCommunityList(List<Community>) - Method in class org.dspace.rest.common.Collection

setParentCommunityList(List<Community>) - Method in class org.dspace.rest.common.Item

setParentObject(DSpaceObject) - Method in class org.dspace.rest.common.Bitstream

setPassword(String) - Method in class org.dspace.rest.common.User

setPolicies(ResourcePolicy[]) - Method in class org.dspace.rest.common.Bitstream

setResourceId(Integer) - Method in class org.dspace.rest.common.ResourcePolicy

setResourceType(String) - Method in class org.dspace.rest.common.ResourcePolicy

setRetrieveLink(String) - Method in class org.dspace.rest.common.Bitstream

setRpDescription(String) - Method in class org.dspace.rest.common.ResourcePolicy

setRpName(String) - Method in class org.dspace.rest.common.ResourcePolicy

setRpType(String) - Method in class org.dspace.rest.common.ResourcePolicy

setSequenceId(Integer) - Method in class org.dspace.rest.common.Bitstream

setShortDescription(String) - Method in class org.dspace.rest.common.Collection

setShortDescription(String) - Method in class org.dspace.rest.common.Community

setSidebarText(String) - Method in class org.dspace.rest.common.Collection

setSidebarText(String) - Method in class org.dspace.rest.common.Community

setSizeBytes(Long) - Method in class org.dspace.rest.common.Bitstream

setStartDate(Date) - Method in class org.dspace.rest.common.ResourcePolicy

setSubcommunities(List<Community>) - Method in class org.dspace.rest.common.Community

setToken(String) - Method in class org.dspace.rest.common.Status

setType(String) - Method in class org.dspace.rest.common.DSpaceObject

setup(Bitstream, String) - Method in class org.dspace.rest.common.Bitstream

setValue(String) - Method in class org.dspace.rest.common.CheckSum

setValue(String) - Method in class org.dspace.rest.common.MetadataEntry

setWithdrawn(String) - Method in class org.dspace.rest.common.Item

Status - Class in org.dspace.rest.common

Used to handle/determine status of REST API.

Status() - Constructor for class org.dspace.rest.common.Status

Status(String, String, String) - Constructor for class org.dspace.rest.common.Status

Status(EPerson, String) - Constructor for class org.dspace.rest.common.Status

status(HttpHeaders) - Method in class org.dspace.rest.RestIndex

Method to check current status of the service and logged in user.

T

test() - Method in class org.dspace.rest.RestIndex

Method only for testing whether the REST API is running.

TOKEN_HEADER - Static variable in class org.dspace.rest.TokenHolder

TokenHolder - Class in org.dspace.rest

This class provide token generation, token holding and logging user into rest api.

TokenHolder() - Constructor for class org.dspace.rest.TokenHolder

U

updateBitstream(Integer, Bitstream, String, String, String, HttpHeaders, HttpServletRequest) - Method in class org.dspace.rest.BitstreamResource

Update bitstream metadata.

updateBitstreamData(Integer, InputStream, String, String, String, HttpHeaders, HttpServletRequest) - Method in class org.dspace.rest.BitstreamResource

Update bitstream data.

updateCollection(Integer, Collection, String, String, String, HttpHeaders, HttpServletRequest) - Method in class org.dspace.rest.CollectionsResource

Update collection.

updateCommunity(Integer, Community, String, String, String, HttpHeaders, HttpServletRequest) - Method in class org.dspace.rest.CommunitiesResource

Update community.

updateItemMetadata(Integer, MetadataEntry[], String, String, String, HttpHeaders, HttpServletRequest) - Method in class org.dspace.rest.ItemsResource

Replace all metadata in item with new passed metadata.

User - Class in org.dspace.rest.common

Class for handle login information for POST request.

User() - Constructor for class org.dspace.rest.common.User

User(String, String) - Constructor for class org.dspace.rest.common.User

V

valueOf(String) - Static method in enum org.dspace.rest.common.ResourcePolicy.Action

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.dspace.rest.common.ResourcePolicy.Action

Returns an array containing the constants of this enum type, in the order they are declared.

W

writeStats(DSpaceObject, UsageEvent.Action, String, String, String, HttpHeaders, HttpServletRequest, Context) - Method in class org.dspace.rest.Resource

Records a statistics event about an object used via REST API.

A B C D F G H I L M O P R S T U V W