The interface of the Slice service. More...

Inheritance diagram for de.zib.gndms.common.dspace.service.SliceService:

Public Member Functions
ResponseEntity< Void >	setSliceConfiguration (String subspace, String sliceKind, String slice, Configuration config, String dn)
	Updates a slice with a new configuration.
ResponseEntity< Specifier< Void > >	transformSlice (String subspace, String sliceKind, String slice, Specifier< Void > newSliceKind, String dn)
	Changes the slice kind of a slice.
ResponseEntity< Specifier < Facets > >	deleteSlice (String subspace, String sliceKind, String slice, String dn)
	Deletes a whole slice.
ResponseEntity< List< FileStats > >	listFiles (String subspace, String sliceKind, String slice, String dn)
	Lists all files of a slice fulfilling the specified attributes.
ResponseEntity< Void >	deleteFiles (String subspace, String sliceKind, String slice, String dn)
	Deletes all files of a slice.
ResponseEntity< String >	getGridFtpUrl (String subspace, String sliceKind, String slice, String dn)
	Returns the URL of the slice for GridFTP access.
ResponseEntity< Void >	listFileContent (String subspace, String sliceKind, String slice, String fileName, List< String > attrs, String dn, OutputStream out)
	Selects a specific file.
ResponseEntity< Void >	setFileContent (String subspace, String sliceKind, String slice, String fileName, MultipartFile file, String dn)
	Selects a specific file.
ResponseEntity< Void >	deleteFile (String subspace, String sliceKind, String slice, String fileName, String dn)
	Deletes a specific file.
Package Functions
ResponseEntity< Facets >	listSliceFacets (String subspace, String sliceKind, String slice, String dn)
	Lists the facet of a slice.

Detailed Description

The interface of the Slice service.

Clients and resources which should provide the Slice service should implement this interface.

Some general remarks on the parameters:

The dn parameter is a identifier for the user responsible for the method invocation. It is required to check if the user has the necessary permissions for the call.
Using REST the attribute should be provided using a http-header property called "DN".

Author:: Ulrike Golas

Member Function Documentation

ResponseEntity<Void> de.zib.gndms.common.dspace.service.SliceService.deleteFile	(	String	subspace,
		String	sliceKind,
		String	slice,
		String	fileName,
		String	dn
	)

Deletes a specific file.

Parameters:

subspace	The subspace identifier.
sliceKind	The slice kind identifier.
slice	The slice identifier.
fileName	The file name.
dn	The dn of the user invoking the method.

Returns:: A confirmation.

ResponseEntity<Void> de.zib.gndms.common.dspace.service.SliceService.deleteFiles	(	String	subspace,
		String	sliceKind,
		String	slice,
		String	dn
	)

Deletes all files of a slice.

Parameters:

subspace	The subspace identifier.
sliceKind	The slice kind identifier.
slice	The slice identifier.
dn	The dn of the user invoking the method.

Returns:: A confirmation.

ResponseEntity<Specifier<Facets> > de.zib.gndms.common.dspace.service.SliceService.deleteSlice	(	String	subspace,
		String	sliceKind,
		String	slice,
		String	dn
	)

Deletes a whole slice.

Parameters:

subspace	The subspace identifier.
sliceKind	The slice kind identifier.
slice	The slice identifier.
dn	The dn of the user invoking the method.

Returns:: A task specifier.

ResponseEntity<String> de.zib.gndms.common.dspace.service.SliceService.getGridFtpUrl	(	String	subspace,
		String	sliceKind,
		String	slice,
		String	dn
	)

Returns the URL of the slice for GridFTP access.

Parameters:

subspace	The subspace identifier.
sliceKind	The slice kind identifier.
slice	The slice identifier.
dn	The dn of the user invoking the method.

Returns:: The URL.

ResponseEntity<Void> de.zib.gndms.common.dspace.service.SliceService.listFileContent	(	String	subspace,
		String	sliceKind,
		String	slice,
		String	fileName,
		List< String >	attrs,
		String	dn,
		OutputStream	out
	)

Selects a specific file.

Parameters:

subspace	The subspace identifier.
sliceKind	The slice kind identifier.
slice	The slice identifier.
fileName	The file name.
attrs	The attributed to be shown.
dn	The dn of the user invoking the method.
out	The outputstream the file information shall be written to.

Returns:: The file.

ResponseEntity< List< FileStats > > de.zib.gndms.common.dspace.service.SliceService.listFiles	(	String	subspace,
		String	sliceKind,
		String	slice,
		String	dn
	)

Lists all files of a slice fulfilling the specified attributes.

Parameters:

subspace	The subspace identifier.
sliceKind	The slice kind identifier.
slice	The slice identifier.
attr	The requested attributes.
dn	The dn of the user invoking the method.

Returns:: The list of files.

ResponseEntity< Facets > de.zib.gndms.common.dspace.service.SliceService.listSliceFacets	(	String	subspace,
		String	sliceKind,
		String	slice,
		String	dn
	)		`[package]`

Lists the facet of a slice.

Parameters:

subspace	The subspace identifier.
sliceKind	The slice kind identifier.
slice	The slice identifier.
dn	The dn of the user invoking the method.

Returns:: The slice configuration and the available facets.

ResponseEntity<Void> de.zib.gndms.common.dspace.service.SliceService.setFileContent	(	String	subspace,
		String	sliceKind,
		String	slice,
		String	fileName,
		MultipartFile	file,
		String	dn
	)

Selects a specific file.

Parameters:

subspace	The subspace identifier.
sliceKind	The slice kind identifier.
slice	The slice identifier.
fileName	The file name.
file	The content of the file.
dn	The dn of the user invoking the method.

Returns:: A confirmation.

ResponseEntity<Void> de.zib.gndms.common.dspace.service.SliceService.setSliceConfiguration	(	String	subspace,
		String	sliceKind,
		String	slice,
		Configuration	config,
		String	dn
	)

Updates a slice with a new configuration.

Parameters:

subspace	The subspace identifier.
sliceKind	The slice kind identifier.
slice	The slice identifier.
config	The configuration of the slice.
dn	The dn of the user invoking the method.

Returns:: A confirmation.

ResponseEntity<Specifier<Void> > de.zib.gndms.common.dspace.service.SliceService.transformSlice	(	String	subspace,
		String	sliceKind,
		String	slice,
		Specifier< Void >	newSliceKind,
		String	dn
	)

Changes the slice kind of a slice.

Parameters:

subspace	The subspace identifier.
sliceKind	The slice kind identifier.
slice	The slice identifier.
newSliceKind	The specifier of the target slice kind for the slice.
dn	The dn of the user invoking the method.

Returns:: The slice specifier.

The documentation for this interface was generated from the following file:

common/src/de/zib/gndms/common/dspace/service/SliceService.java

de.zib.gndms.common.dspace.service.SliceService Interface Reference

Public Member Functions

Package Functions

Detailed Description

Member Function Documentation