org.dspace.license

Class CreativeCommonsServiceImpl

java.lang.Object

org.dspace.license.CreativeCommonsServiceImpl

All Implemented Interfaces:

CreativeCommonsService, org.springframework.beans.factory.InitializingBean

public class CreativeCommonsServiceImpl
extends Object
implements CreativeCommonsService, org.springframework.beans.factory.InitializingBean

Field Summary

Fields

Modifier and Type	Field and Description
protected BitstreamFormatService	bitstreamFormatService
protected BitstreamService	bitstreamService
protected static String	BSN_LICENSE_RDF
protected static String	BSN_LICENSE_TEXT Deprecated. to make uniform JSPUI and XMLUI approach the bitstream with the license in the textual format it is no longer stored (see https://jira.duraspace.org/browse/DS-2604)
protected static String	BSN_LICENSE_URL Deprecated. use the metadata retrieved at CreativeCommonsService.getCCField(String) (see https://jira .duraspace.org/browse/DS-2604)
protected BundleService	bundleService
protected static String	CC_BS_SOURCE The Bundle Name
protected ConfigurationService	configurationService
protected ItemService	itemService
protected Templates	templates

Fields inherited from interface org.dspace.license.service.CreativeCommonsService

CC_BUNDLE_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CreativeCommonsServiceImpl()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
String	fetchLicenseRDF(org.jdom.Document license) Apply same transformation on the document to retrieve only the most relevant part of the document passed as parameter.
protected Bitstream	getBitstream(Item item, String bitstream_name) This helper method retrieves the bytes of a bitstream for an item under the CC bundle, with the given bitstream name
protected byte[]	getBytesFromBitstream(Context context, Item item, String bitstream_name)
protected Bundle	getCcBundle(Context context, Item item)
LicenseMetadataValue	getCCField(String fieldId) Returns a metadata field handle for given field Id
String	getLicenseRDF(Context context, Item item)
Bitstream	getLicenseRdfBitstream(Item item) Get Creative Commons license RDF, returning Bitstream object.
Bitstream	getLicenseTextBitstream(Item item) Deprecated.
String	getLicenseURL(Context context, Item item)
protected String	getStringFromBitstream(Context context, Item item, String bitstream_name) This helper method wraps a String around a byte array returned from the bitstream method further down Note: This helper method assumes that the CC bitstreams are short and easily expressed as byte arrays in RAM
boolean	hasLicense(Context context, Item item)
boolean	isEnabled() Simple accessor for enabling of CC
void	removeLicense(Context context, Item item)
void	removeLicense(Context context, LicenseMetadataValue uriField, LicenseMetadataValue nameField, Item item) Remove license information, delete also the bitstream
protected void	setBitstreamFromBytes(Context context, Item item, Bundle bundle, String bitstream_name, BitstreamFormat format, byte[] bytes) This helper method takes some bytes and stores them as a bitstream for an item, under the CC bundle, with the given bitstream name Note: This helper method assumes that the CC bitstreams are short and easily expressed as byte arrays in RAM
void	setLicense(Context context, Item item, InputStream licenseStm, String mimeType) Used by DSpaceMetsIngester
void	setLicenseRDF(Context context, Item item, String licenseRdf) setLicenseRDF CC Web Service method for setting the RDF bitstream

Methods inherited from class java.lang.Object

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

Field Detail

CC_BS_SOURCE

protected static final String CC_BS_SOURCE

The Bundle Name

See Also:

Constant Field Values

BSN_LICENSE_URL

@Deprecated
protected static final String BSN_LICENSE_URL

Deprecated. use the metadata retrieved at CreativeCommonsService.getCCField(String) (see https://jira .duraspace.org/browse/DS-2604)

Some BitStream Names (BSN)

See Also:

Constant Field Values

BSN_LICENSE_TEXT

@Deprecated
protected static final String BSN_LICENSE_TEXT

Deprecated. to make uniform JSPUI and XMLUI approach the bitstream with the license in the textual format it is no longer stored (see https://jira.duraspace.org/browse/DS-2604)

See Also:

Constant Field Values

BSN_LICENSE_RDF

protected static final String BSN_LICENSE_RDF

See Also:

Constant Field Values

templates

protected Templates templates

bitstreamService

@Autowired(required=true)
protected BitstreamService bitstreamService

bitstreamFormatService

@Autowired(required=true)
protected BitstreamFormatService bitstreamFormatService

bundleService

@Autowired(required=true)
protected BundleService bundleService

itemService

@Autowired(required=true)
protected ItemService itemService

configurationService

protected ConfigurationService configurationService

Constructor Detail

CreativeCommonsServiceImpl

protected CreativeCommonsServiceImpl()

Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

isEnabled

public boolean isEnabled()

Description copied from interface: CreativeCommonsService

Simple accessor for enabling of CC

Specified by:

isEnabled in interface CreativeCommonsService

Returns:

is CC enabled?

getCcBundle

protected Bundle getCcBundle(Context context,
                             Item item)
                      throws SQLException,
                             AuthorizeException,
                             IOException

Throws:

SQLException

AuthorizeException

IOException

setLicenseRDF

public void setLicenseRDF(Context context,
                          Item item,
                          String licenseRdf)
                   throws SQLException,
                          IOException,
                          AuthorizeException

Description copied from interface: CreativeCommonsService

setLicenseRDF CC Web Service method for setting the RDF bitstream

Specified by:

setLicenseRDF in interface CreativeCommonsService

Parameters:

context - The relevant DSpace Context.

item - The item to set license on.

licenseRdf - license RDF string

Throws:

SQLException - An exception that provides information on a database access error or other errors.

IOException - A general class of exceptions produced by failed or interrupted I/O operations.

AuthorizeException - Exception indicating the current user of the context does not have permission to perform a particular action.

setLicense

public void setLicense(Context context,
                       Item item,
                       InputStream licenseStm,
                       String mimeType)
                throws SQLException,
                       IOException,
                       AuthorizeException

Description copied from interface: CreativeCommonsService

Used by DSpaceMetsIngester

Specified by:

setLicense in interface CreativeCommonsService

Parameters:

context - The relevant DSpace Context.

item - The item to set license on.

licenseStm - InputStream with the license text.

mimeType - License text file MIME type ("text/xml", "text/rdf" or generic)

Throws:

SQLException - if database error An exception that provides information on a database access error or other errors.

IOException - if IO error A general class of exceptions produced by failed or interrupted I/O operations.

AuthorizeException - if authorization error Exception indicating the current user of the context does not have permission to perform a particular action. * // PATCHED 12/01 FROM JIRA re: mimetypes for CCLicense and License RDF wjb

removeLicense

public void removeLicense(Context context,
                          Item item)
                   throws SQLException,
                          IOException,
                          AuthorizeException

Specified by:

removeLicense in interface CreativeCommonsService

Throws:

SQLException

IOException

AuthorizeException

hasLicense

public boolean hasLicense(Context context,
                          Item item)
                   throws SQLException,
                          IOException

Specified by:

hasLicense in interface CreativeCommonsService

Throws:

SQLException

IOException

getLicenseRDF

public String getLicenseRDF(Context context,
                            Item item)
                     throws SQLException,
                            IOException,
                            AuthorizeException

Specified by:

getLicenseRDF in interface CreativeCommonsService

Throws:

SQLException

IOException

AuthorizeException

getLicenseRdfBitstream

public Bitstream getLicenseRdfBitstream(Item item)
                                 throws SQLException,
                                        IOException,
                                        AuthorizeException

Description copied from interface: CreativeCommonsService

Get Creative Commons license RDF, returning Bitstream object.

Specified by:

getLicenseRdfBitstream in interface CreativeCommonsService

Parameters:

item - bitstream's parent item

Returns:

bitstream or null.

Throws:

SQLException - An exception that provides information on a database access error or other errors.

IOException - A general class of exceptions produced by failed or interrupted I/O operations.

AuthorizeException - Exception indicating the current user of the context does not have permission to perform a particular action.

getLicenseTextBitstream

@Deprecated
public Bitstream getLicenseTextBitstream(Item item)
                                               throws SQLException,
                                                      IOException,
                                                      AuthorizeException

Deprecated.

Description copied from interface: CreativeCommonsService

Get Creative Commons license Text, returning Bitstream object.

Specified by:

getLicenseTextBitstream in interface CreativeCommonsService

Parameters:

item - bitstream's parent item

Returns:

bitstream or null.

Throws:

SQLException - An exception that provides information on a database access error or other errors.

IOException - A general class of exceptions produced by failed or interrupted I/O operations.

AuthorizeException - Exception indicating the current user of the context does not have permission to perform a particular action.

getLicenseURL

public String getLicenseURL(Context context,
                            Item item)
                     throws SQLException,
                            IOException,
                            AuthorizeException

Specified by:

getLicenseURL in interface CreativeCommonsService

Throws:

SQLException

IOException

AuthorizeException

fetchLicenseRDF

public String fetchLicenseRDF(org.jdom.Document license)

Description copied from interface: CreativeCommonsService

Apply same transformation on the document to retrieve only the most relevant part of the document passed as parameter. If no transformation is needed then take in consideration to empty the CreativeCommons.xml

Specified by:

fetchLicenseRDF in interface CreativeCommonsService

Parameters:

license - - an element that could be contains as part of your content the license rdf

Returns:

the document license in textual format after the transformation

setBitstreamFromBytes

protected void setBitstreamFromBytes(Context context,
                                     Item item,
                                     Bundle bundle,
                                     String bitstream_name,
                                     BitstreamFormat format,
                                     byte[] bytes)
                              throws SQLException,
                                     IOException,
                                     AuthorizeException

This helper method takes some bytes and stores them as a bitstream for an item, under the CC bundle, with the given bitstream name Note: This helper method assumes that the CC bitstreams are short and easily expressed as byte arrays in RAM

Parameters:

context - The relevant DSpace Context.

item - parent item

bundle - parent bundle

bitstream_name - bitstream name to set

format - bitstream format

bytes - bitstream data

Throws:

IOException - A general class of exceptions produced by failed or interrupted I/O operations.

SQLException - An exception that provides information on a database access error or other errors.

AuthorizeException - Exception indicating the current user of the context does not have permission to perform a particular action.

getStringFromBitstream

protected String getStringFromBitstream(Context context,
                                        Item item,
                                        String bitstream_name)
                                 throws SQLException,
                                        IOException,
                                        AuthorizeException

This helper method wraps a String around a byte array returned from the bitstream method further down Note: This helper method assumes that the CC bitstreams are short and easily expressed as byte arrays in RAM

Parameters:

context - The relevant DSpace Context.

item - parent item

bitstream_name - bitstream name to set

Returns:

the bitstream as string

Throws:

IOException - A general class of exceptions produced by failed or interrupted I/O operations.

SQLException - An exception that provides information on a database access error or other errors.

AuthorizeException - Exception indicating the current user of the context does not have permission to perform a particular action.

getBitstream

protected Bitstream getBitstream(Item item,
                                 String bitstream_name)
                          throws SQLException,
                                 IOException,
                                 AuthorizeException

This helper method retrieves the bytes of a bitstream for an item under the CC bundle, with the given bitstream name

Parameters:

item - parent item

bitstream_name - bitstream name to set

Returns:

the bitstream

Throws:

IOException - A general class of exceptions produced by failed or interrupted I/O operations.

SQLException - An exception that provides information on a database access error or other errors.

AuthorizeException - Exception indicating the current user of the context does not have permission to perform a particular action.

getBytesFromBitstream

protected byte[] getBytesFromBitstream(Context context,
                                       Item item,
                                       String bitstream_name)
                                throws SQLException,
                                       IOException,
                                       AuthorizeException

Throws:

SQLException

IOException

AuthorizeException

getCCField

public LicenseMetadataValue getCCField(String fieldId)

Returns a metadata field handle for given field Id

Specified by:

getCCField in interface CreativeCommonsService

Parameters:

fieldId - name of the property.

Returns:

its value.

removeLicense

public void removeLicense(Context context,
                          LicenseMetadataValue uriField,
                          LicenseMetadataValue nameField,
                          Item item)
                   throws AuthorizeException,
                          IOException,
                          SQLException

Description copied from interface: CreativeCommonsService

Remove license information, delete also the bitstream

Specified by:

removeLicense in interface CreativeCommonsService

Parameters:

context - - DSpace Context

uriField - - the metadata field for license uri

nameField - - the metadata field for license name

item - - the item

Throws:

AuthorizeException - Exception indicating the current user of the context does not have permission to perform a particular action.

IOException - A general class of exceptions produced by failed or interrupted I/O operations.

SQLException - An exception that provides information on a database access error or other errors.