Package org.dspace.content

Class BundleServiceImpl

java.lang.Object

org.dspace.content.DSpaceObjectServiceImpl<Bundle>

org.dspace.content.BundleServiceImpl

All Implemented Interfaces:

BundleService, DSpaceObjectLegacySupportService<Bundle>, DSpaceObjectService<Bundle>

public class BundleServiceImpl
extends DSpaceObjectServiceImpl<Bundle>
implements BundleService

Service implementation for the Bundle object. This class is responsible for all business logic calls for the Bundle object and is autowired by spring. This class should never be accessed directly.

Author:

kevinvandevelde at atmire.com

Field Summary

Fields

Modifier and Type	Field	Description
protected AuthorizeService	authorizeService
protected BitstreamService	bitstreamService
protected BundleDAO	bundleDAO
protected ItemService	itemService
protected ResourcePolicyService	resourcePolicyService

Fields inherited from class org.dspace.content.DSpaceObjectServiceImpl

choiceAuthorityService, handleService, metadataAuthorityService, metadataFieldService, metadataValueService, relationshipService

Fields inherited from interface org.dspace.content.service.DSpaceObjectService

MD_COPYRIGHT_TEXT, MD_INTRODUCTORY_TEXT, MD_LICENSE, MD_NAME, MD_PROVENANCE_DESCRIPTION, MD_SHORT_DESCRIPTION, MD_SIDEBAR_TEXT, MD_SOURCE, MD_USER_FORMAT_DESCRIPTION

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BundleServiceImpl()

Method Summary

Modifier and Type	Method	Description
void	addBitstream(Context context, Bundle bundle, Bitstream bitstream)	Add an existing bitstream to this bundle
int	countTotal(Context context)
Bundle	create(Context context, Item item, String name)	Create a new bundle, with a new ID and link it to the provided item
void	delete(Context context, Bundle bundle)
Bundle	find(Context context, UUID id)	Generic find for when the precise type of an Entity is not known
Bundle	findByIdOrLegacyId(Context context, String id)
Bundle	findByLegacyId(Context context, int id)	Generic find for when the precise type of a DSO is not known, just the a pair of type number and database ID.
DSpaceObject	getAdminObject(Context context, Bundle bundle, int action)	Return the dspace object where an ADMIN action right is sufficient to grant the initial authorize check.
Bitstream	getBitstreamByName(Bundle bundle, String name)
List<ResourcePolicy>	getBitstreamPolicies(Context context, Bundle bundle)
List<ResourcePolicy>	getBundlePolicies(Context context, Bundle bundle)
DSpaceObject	getParentObject(Context context, Bundle bundle)	Return the dspace object that "own" the current object in the hierarchy.
int	getSupportsTypeConstant()	Returns the Constants which this service supports
void	inheritCollectionDefaultPolicies(Context context, Bundle bundle, Collection collection)	remove all policies on the bundle and its contents, and replace them with the DEFAULT_BITSTREAM_READ policies belonging to the collection.
void	moveBitstreamToBundle(Context context, Bundle targetBundle, Bitstream bitstream)	Moves a bitstream from its current bundle to a new target bundle
void	removeBitstream(Context context, Bundle bundle, Bitstream bitstream)	Remove a bitstream from this bundle - the bitstream is only deleted if this was the last reference to it
void	replaceAllBitstreamPolicies(Context context, Bundle bundle, List<ResourcePolicy> newpolicies)	remove all of the policies for the bundle and bitstream contents and replace them with a new list of policies
void	setOrder(Context context, Bundle bundle, UUID[] bitstreamIds)	Changes bitstream order according to the array
void	update(Context context, Bundle bundle)
void	updateBitstreamOrder(Context context, Bundle bundle, int from, int to)	Moves a bitstream within a bundle from one place to another, shifting all other bitstreams in the process
void	updateLastModified(Context context, Bundle dso)

Methods inherited from class org.dspace.content.DSpaceObjectServiceImpl

addAndShiftRightMetadata, addMetadata, addMetadata, addMetadata, addMetadata, addMetadata, addMetadata, addMetadata, addMetadata, addMetadata, addMetadata, clearMetadata, getAuthoritiesAndConfidences, getElements, getElementsFilled, getIdentifiers, getMDValueByField, getMDValueByLegacyField, getMetadata, getMetadata, getMetadata, getMetadata, getMetadataByMetadataString, getMetadataFirstValue, getMetadataFirstValue, getMetadataValuePlace, getName, getTypeText, match, moveMetadata, moveSingleMetadataValue, removeMetadataValues, replaceMetadata, setMetadataModified, setMetadataSingleValue, setMetadataSingleValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.dspace.content.service.DSpaceObjectService

addAndShiftRightMetadata, addMetadata, addMetadata, addMetadata, addMetadata, addMetadata, addMetadata, addMetadata, addMetadata, addMetadata, clearMetadata, getIdentifiers, getMetadata, getMetadata, getMetadata, getMetadata, getMetadataByMetadataString, getMetadataFirstValue, getMetadataFirstValue, getName, getTypeText, moveMetadata, removeMetadataValues, replaceMetadata, setMetadataModified, setMetadataSingleValue, setMetadataSingleValue

Field Detail

bundleDAO

@Autowired(required=true)
protected BundleDAO bundleDAO

bitstreamService

@Autowired(required=true)
protected BitstreamService bitstreamService

itemService

@Autowired(required=true)
protected ItemService itemService

authorizeService

@Autowired(required=true)
protected AuthorizeService authorizeService

resourcePolicyService

@Autowired(required=true)
protected ResourcePolicyService resourcePolicyService

Constructor Detail

BundleServiceImpl

protected BundleServiceImpl()

Method Detail

find

public Bundle find(Context context,
                   UUID id)
            throws SQLException

Description copied from interface: DSpaceObjectService

Generic find for when the precise type of an Entity is not known

Specified by:

find in interface DSpaceObjectService<Bundle>

Parameters:

context - - the context

id - - uuid within table of typed dspace objects

Returns:

the dspace object found, or null if it does not exist.

Throws:

SQLException - only upon failure accessing the database.

create

public Bundle create(Context context,
                     Item item,
                     String name)
              throws SQLException,
                     AuthorizeException

Description copied from interface: BundleService

Create a new bundle, with a new ID and link it to the provided item

Specified by:

create in interface BundleService

Parameters:

context - DSpace context object

item - DSpace item

name - bundle name

Returns:

the newly created bundle

Throws:

SQLException - if database error

AuthorizeException - if authorization error

getBitstreamByName

public Bitstream getBitstreamByName(Bundle bundle,
                                    String name)

Specified by:

getBitstreamByName in interface BundleService

addBitstream

public void addBitstream(Context context,
                         Bundle bundle,
                         Bitstream bitstream)
                  throws SQLException,
                         AuthorizeException

Description copied from interface: BundleService

Add an existing bitstream to this bundle

Specified by:

addBitstream in interface BundleService

Parameters:

context - DSpace Context

bundle - the bitstream bundle

bitstream - the bitstream to add

Throws:

SQLException - if database error

AuthorizeException - if authorization error

removeBitstream

public void removeBitstream(Context context,
                            Bundle bundle,
                            Bitstream bitstream)
                     throws AuthorizeException,
                            SQLException,
                            IOException

Description copied from interface: BundleService

Remove a bitstream from this bundle - the bitstream is only deleted if this was the last reference to it

If the bitstream in question is the primary bitstream recorded for the bundle the primary bitstream field is unset in order to free the bitstream from the foreign key constraint so that the cleanup process can run normally.

Specified by:

removeBitstream in interface BundleService

Parameters:

context - DSpace Context

bundle - the bitstream bundle

bitstream - the bitstream to remove

Throws:

AuthorizeException - if authorization error

SQLException - if database error

IOException - if IO error

inheritCollectionDefaultPolicies

public void inheritCollectionDefaultPolicies(Context context,
                                             Bundle bundle,
                                             Collection collection)
                                      throws SQLException,
                                             AuthorizeException

Description copied from interface: BundleService

remove all policies on the bundle and its contents, and replace them with the DEFAULT_BITSTREAM_READ policies belonging to the collection.

Specified by:

inheritCollectionDefaultPolicies in interface BundleService

Parameters:

context - DSpace Context

bundle - the bitstream bundle

collection - Collection

Throws:

SQLException - if an SQL error or if no default policies found. It's a bit draconian, but default policies must be enforced.

AuthorizeException - if authorization error

replaceAllBitstreamPolicies

public void replaceAllBitstreamPolicies(Context context,
                                        Bundle bundle,
                                        List<ResourcePolicy> newpolicies)
                                 throws SQLException,
                                        AuthorizeException

Description copied from interface: BundleService

remove all of the policies for the bundle and bitstream contents and replace them with a new list of policies

Specified by:

replaceAllBitstreamPolicies in interface BundleService

Parameters:

context - DSpace Context

bundle - the bitstream bundle

newpolicies - - this will be all of the new policies for the bundle and bitstream contents

Throws:

SQLException - if database error

AuthorizeException - if authorization error

getBitstreamPolicies

public List<ResourcePolicy> getBitstreamPolicies(Context context,
                                                 Bundle bundle)
                                          throws SQLException

Specified by:

getBitstreamPolicies in interface BundleService

Throws:

SQLException

getBundlePolicies

public List<ResourcePolicy> getBundlePolicies(Context context,
                                              Bundle bundle)
                                       throws SQLException

Specified by:

getBundlePolicies in interface BundleService

Throws:

SQLException

updateBitstreamOrder

public void updateBitstreamOrder(Context context,
                                 Bundle bundle,
                                 int from,
                                 int to)
                          throws AuthorizeException,
                                 SQLException

Description copied from interface: BundleService

Moves a bitstream within a bundle from one place to another, shifting all other bitstreams in the process

Specified by:

updateBitstreamOrder in interface BundleService

Parameters:

context - DSpace Context

bundle - The bitstream bundle

from - The index of the bitstream to move

to - The index to move the bitstream to

Throws:

AuthorizeException - when an SQL error has occurred (querying DSpace)

SQLException - If the user can't make the changes

moveBitstreamToBundle

public void moveBitstreamToBundle(Context context,
                                  Bundle targetBundle,
                                  Bitstream bitstream)
                           throws SQLException,
                                  AuthorizeException,
                                  IOException

Description copied from interface: BundleService

Moves a bitstream from its current bundle to a new target bundle

Specified by:

moveBitstreamToBundle in interface BundleService

Parameters:

context - DSpace Context

targetBundle - The target bundle where bitstream will be moved to

bitstream - The bitstream being moved

Throws:

SQLException - if database error

AuthorizeException - if authorization error

IOException - if IO error

setOrder

public void setOrder(Context context,
                     Bundle bundle,
                     UUID[] bitstreamIds)
              throws AuthorizeException,
                     SQLException

Description copied from interface: BundleService

Changes bitstream order according to the array

Specified by:

setOrder in interface BundleService

Parameters:

context - DSpace Context

bundle - the bitstream bundle

bitstreamIds - the identifiers in the order they are to be set

Throws:

AuthorizeException - If the user can't make the changes

SQLException - when an SQL error has occurred (querying DSpace)

getAdminObject

public DSpaceObject getAdminObject(Context context,
                                   Bundle bundle,
                                   int action)
                            throws SQLException

Description copied from interface: DSpaceObjectService

Return the dspace object where an ADMIN action right is sufficient to grant the initial authorize check.

Default behaviour is ADMIN right on the object grant right on all other action on the object itself. Subclass should override this method as needed.

Specified by:

getAdminObject in interface DSpaceObjectService<Bundle>

Overrides:

getAdminObject in class DSpaceObjectServiceImpl<Bundle>

Parameters:

context - DSpace context

bundle - DSpaceObject

action - ID of action being attempted, from org.dspace.core.Constants. The ADMIN action is not a valid parameter for this method, an IllegalArgumentException should be thrown

Returns:

the dspace object, if any, where an ADMIN action is sufficient to grant the original action

Throws:

SQLException - if database error

getParentObject

public DSpaceObject getParentObject(Context context,
                                    Bundle bundle)
                             throws SQLException

Description copied from interface: DSpaceObjectService

Return the dspace object that "own" the current object in the hierarchy. Note that this method has a meaning slightly different from the getAdminObject because it is independent of the action but it is in a way related to it. It defines the "first" dspace object OTHER then the current one, where allowed ADMIN actions imply allowed ADMIN actions on the object self.

Specified by:

getParentObject in interface DSpaceObjectService<Bundle>

Overrides:

getParentObject in class DSpaceObjectServiceImpl<Bundle>

Parameters:

context - DSpace context

bundle - DSpaceObject

Returns:

the dspace object that "own" the current object in the hierarchy

Throws:

SQLException - if database error

updateLastModified

public void updateLastModified(Context context,
                               Bundle dso)

Specified by:

updateLastModified in interface DSpaceObjectService<Bundle>

update

public void update(Context context,
                   Bundle bundle)
            throws SQLException,
                   AuthorizeException

Specified by:

update in interface DSpaceObjectService<Bundle>

Overrides:

update in class DSpaceObjectServiceImpl<Bundle>

Throws:

SQLException

AuthorizeException

delete

public void delete(Context context,
                   Bundle bundle)
            throws SQLException,
                   AuthorizeException,
                   IOException

Specified by:

delete in interface DSpaceObjectService<Bundle>

Throws:

SQLException

AuthorizeException

IOException

getSupportsTypeConstant

public int getSupportsTypeConstant()

Description copied from interface: DSpaceObjectService

Returns the Constants which this service supports

Specified by:

getSupportsTypeConstant in interface DSpaceObjectLegacySupportService<Bundle>

Specified by:

getSupportsTypeConstant in interface DSpaceObjectService<Bundle>

Returns:

a org.dspace.core.Constants that represents a IndexableObject type

findByIdOrLegacyId

public Bundle findByIdOrLegacyId(Context context,
                                 String id)
                          throws SQLException

Specified by:

findByIdOrLegacyId in interface DSpaceObjectLegacySupportService<Bundle>

Throws:

SQLException

findByLegacyId

public Bundle findByLegacyId(Context context,
                             int id)
                      throws SQLException

Description copied from interface: DSpaceObjectLegacySupportService

Generic find for when the precise type of a DSO is not known, just the a pair of type number and database ID.

Specified by:

findByLegacyId in interface DSpaceObjectLegacySupportService<Bundle>

Parameters:

context - - the context

id - - the legacy id within table of type'd objects

Returns:

the object found, or null if it does not exist.

Throws:

SQLException - only upon failure accessing the database.

countTotal

public int countTotal(Context context)
               throws SQLException

Specified by:

countTotal in interface BundleService

Throws:

SQLException