org.dspace.app.rest.utils

Class Utils

java.lang.Object

org.dspace.app.rest.utils.Utils

@Component
public class Utils
extends Object

Collection of utility methods

Author:

Andrea Bollini (andrea.bollini at 4science.it)

Constructor Summary

Constructors

Constructor and Description
Utils()

Method Summary

Modifier and Type	Method and Description
List<DSpaceObject>	constructDSpaceObjectList(Context context, List<String> list) This method will construct a List of DSpaceObjects by executing the method Utils#readFromRequest(HttpServletRequest) and fetching the List of Strings from the request.
static File	getFile(org.springframework.web.multipart.MultipartFile multipartFile, String prefixTempName, String suffixTempName) Create a temporary file from a multipart file upload
static String	getFileName(org.springframework.web.multipart.MultipartFile multipartFile) Return the filename part from a multipartFile upload that could eventually contains the fullpath on the client filesystem
LinkRestRepository	getLinkResourceRepository(String apiCategory, String modelPlural, String rel) Retrieve the LinkRestRepository associated with a specific link from the apiCategory and model specified in the parameters.
LinkRest	getLinkRest(String rel, Class<RestAddressableModel> domainClass)
String	getMetadataKey(String schema, String element, String qualifier) Build the canonical representation of a metadata key in DSpace.
<T> org.springframework.data.domain.Page<T>	getPage(List<T> fullContents, org.springframework.data.domain.Pageable pageable)
String[]	getRepositories()
DSpaceRestRepository	getResourceRepository(String apiCategory, String modelPlural)
List<String>	getStringListFromRequest(javax.servlet.http.HttpServletRequest request) This method will retrieve a list of DSpaceObjects from the Request by reading in the Request's InputStream with a Scanner and searching the InputStream for UUIDs which will then be resolved to a DSpaceObject.
org.springframework.hateoas.Link	linkToSingleResource(DSpaceResource r, String rel)
org.springframework.hateoas.Link	linkToSingleResource(RestAddressableModel data, String rel)
org.springframework.hateoas.Link	linkToSubResource(RestAddressableModel data, String rel)
org.springframework.hateoas.Link	linkToSubResource(RestAddressableModel data, String rel, String path)
static String	makeSingular(String modelPlural)

Methods inherited from class java.lang.Object

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

Constructor Detail

Utils

public Utils()

Method Detail

getPage

public <T> org.springframework.data.domain.Page<T> getPage(List<T> fullContents,
                                                           org.springframework.data.domain.Pageable pageable)

linkToSingleResource

public org.springframework.hateoas.Link linkToSingleResource(DSpaceResource r,
                                                             String rel)

linkToSingleResource

public org.springframework.hateoas.Link linkToSingleResource(RestAddressableModel data,
                                                             String rel)

linkToSubResource

public org.springframework.hateoas.Link linkToSubResource(RestAddressableModel data,
                                                          String rel)

linkToSubResource

public org.springframework.hateoas.Link linkToSubResource(RestAddressableModel data,
                                                          String rel,
                                                          String path)

getResourceRepository

public DSpaceRestRepository getResourceRepository(String apiCategory,
                                                  String modelPlural)

getRepositories

public String[] getRepositories()

makeSingular

public static String makeSingular(String modelPlural)

getLinkResourceRepository

public LinkRestRepository getLinkResourceRepository(String apiCategory,
                                                    String modelPlural,
                                                    String rel)

Retrieve the LinkRestRepository associated with a specific link from the apiCategory and model specified in the parameters.

Parameters:

apiCategory - the apiCategory

modelPlural - the model name in its plural form

rel - the name of the relation

Returns:

getLinkRest

public LinkRest getLinkRest(String rel,
                            Class<RestAddressableModel> domainClass)

Parameters:

rel -

domainClass -

Returns:

the LinkRest annotation corresponding to the specified rel in the domainClass. Null if not found

getMetadataKey

public String getMetadataKey(String schema,
                             String element,
                             String qualifier)

Build the canonical representation of a metadata key in DSpace. ie .[.]

Parameters:

schema -

element -

object -

Returns:

getFile

public static File getFile(org.springframework.web.multipart.MultipartFile multipartFile,
                           String prefixTempName,
                           String suffixTempName)
                    throws IOException,
                           FileNotFoundException

Create a temporary file from a multipart file upload

Parameters:

multipartFile - the multipartFile representing the uploaded file. Please note that it is a complex object including additional information other than the binary like the orginal file name and the mimetype

prefixTempName - the prefix to use to generate the filename of the temporary file

suffixTempName - the suffic to use to generate the filename of the temporary file

Returns:

the temporary file on the server

Throws:

IOException

FileNotFoundException

getFileName

public static String getFileName(org.springframework.web.multipart.MultipartFile multipartFile)
                          throws IOException,
                                 FileNotFoundException

Return the filename part from a multipartFile upload that could eventually contains the fullpath on the client filesystem

Parameters:

multipartFile - the file uploaded

Returns:

the filename part of the file on the client filesystem

Throws:

IOException

FileNotFoundException

constructDSpaceObjectList

public List<DSpaceObject> constructDSpaceObjectList(Context context,
                                                    List<String> list)

This method will construct a List of DSpaceObjects by executing the method Utils#readFromRequest(HttpServletRequest) and fetching the List of Strings from the request. The method will iterate over this list of Strings and parse the String to retrieve the UUID from it. It will then look through all the DSpaceObjectServices to try and match this UUID to a DSpaceObject. If one is found, this DSpaceObject is added to the List of DSpaceObjects that we will return.

Parameters:

context - The relevant DSpace context

request - The request out of which we'll create the List of DSpaceObjects

Returns:

The resulting list of DSpaceObjects that we parsed out of the request

getStringListFromRequest

public List<String> getStringListFromRequest(javax.servlet.http.HttpServletRequest request)

This method will retrieve a list of DSpaceObjects from the Request by reading in the Request's InputStream with a Scanner and searching the InputStream for UUIDs which will then be resolved to a DSpaceObject. These will all be added to a list and returned by this method.

Parameters:

request - The request of which the InputStream will be used

Returns:

The list of DSpaceObjects that we could find in the InputStream

Throws:

IOException - If something goes wrong