Package org.dspace.app.rest.repository

Class ScriptRestRepository

java.lang.Object

org.dspace.app.rest.repository.AbstractDSpaceRestRepository

org.dspace.app.rest.repository.DSpaceRestRepository<ScriptRest,String>

org.dspace.app.rest.repository.ScriptRestRepository

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.data.repository.CrudRepository<ScriptRest,String>, org.springframework.data.repository.PagingAndSortingRepository<ScriptRest,String>, org.springframework.data.repository.Repository<ScriptRest,String>

@Component("system.script")
public class ScriptRestRepository
extends DSpaceRestRepository<ScriptRest,String>

This is the REST repository dealing with the Script logic

Field Summary

Fields inherited from class org.dspace.app.rest.repository.AbstractDSpaceRestRepository

converter, requestService, utils

Constructor Summary

Constructors

Constructor	Description
ScriptRestRepository()

Method Summary

Modifier and Type	Method	Description
org.springframework.data.domain.Page<ScriptRest>	findAll(Context context, org.springframework.data.domain.Pageable pageable)	Method to implement to support scroll of entity instances from the collection resource endpoint
ScriptRest	findOne(Context context, String name)	Method to implement to support retrieval of a specific REST object instance
Class<ScriptRest>	getDomainClass()	The REST model supported by the repository
ProcessRest	startProcess(Context context, String scriptName, List<org.springframework.web.multipart.MultipartFile> files)	This method will take a String scriptname parameter and it'll try to resolve this to a script known by DSpace.

Methods inherited from class org.dspace.app.rest.repository.DSpaceRestRepository

action, action, count, createAndReturn, createAndReturn, createAndReturn, createAndReturn, createAndReturn, createAndReturn, delete, delete, deleteAll, deleteAll, deleteAllById, deleteById, existsById, findAll, findAll, findAll, findAllById, findById, patch, patch, put, put, put, put, save, save, saveAll, setBeanName, upload, upload, upload

Methods inherited from class org.dspace.app.rest.repository.AbstractDSpaceRestRepository

getRequestService, obtainContext

Methods inherited from class java.lang.Object

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

Constructor Details

ScriptRestRepository

public ScriptRestRepository()

Method Details

findOne

@PreAuthorize("hasAuthority(\'AUTHENTICATED\')")
public ScriptRest findOne(Context context,
 String name)

Description copied from class: DSpaceRestRepository

Method to implement to support retrieval of a specific REST object instance

Specified by:

findOne in class DSpaceRestRepository<ScriptRest,String>

Parameters:

context - the dspace context

name - the rest object id

Returns:

the REST object identified by its ID

findAll

@PreAuthorize("hasAuthority(\'AUTHENTICATED\')")
public org.springframework.data.domain.Page<ScriptRest> findAll(Context context,
 org.springframework.data.domain.Pageable pageable)

Description copied from class: DSpaceRestRepository

Method to implement to support scroll of entity instances from the collection resource endpoint

Specified by:

findAll in class DSpaceRestRepository<ScriptRest,String>

Parameters:

context - the dspace context

pageable - object embedding the requested pagination info

Returns:

getDomainClass

public Class<ScriptRest> getDomainClass()

Description copied from class: DSpaceRestRepository

The REST model supported by the repository

Specified by:

getDomainClass in class DSpaceRestRepository<ScriptRest,String>

startProcess

public ProcessRest startProcess(Context context,
 String scriptName,
 List<org.springframework.web.multipart.MultipartFile> files)
                         throws SQLException,
IOException,
AuthorizeException,
IllegalAccessException,
InstantiationException

This method will take a String scriptname parameter and it'll try to resolve this to a script known by DSpace. If a script is found, it'll start a process for this script with the given properties to this request

Parameters:

scriptName - The name of the script that will try to be resolved and started

Returns:

A ProcessRest object representing the started process for this script

Throws:

SQLException - If something goes wrong

IOException - If something goes wrong

AuthorizeException

IllegalAccessException

InstantiationException