org.dspace.license

Class CreativeCommons

java.lang.Object

org.dspace.license.CreativeCommons

public class CreativeCommons
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CreativeCommons.MdField Helper class for using CC-related Metadata fields

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CC_BUNDLE_NAME The Bundle Name
protected static javax.xml.transform.Templates	templates

Constructor Summary

Constructors

Constructor and Description
CreativeCommons()

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.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.
static CreativeCommons.MdField	getCCField(java.lang.String fieldId) Returns a metadata field handle for given field Id
static java.lang.String	getLicenseRDF(Item item)
static Bitstream	getLicenseRdfBitstream(Item item) Get Creative Commons license RDF, returning Bitstream object.
static java.lang.String	getLicenseText(Item item) 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)
static Bitstream	getLicenseTextBitstream(Item item) 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)
static java.lang.String	getLicenseURL(Item item)
static boolean	hasLicense(Context context, Item item)
static boolean	isEnabled() Simple accessor for enabling of CC
static void	removeLicense(Context context, CreativeCommons.MdField uriField, CreativeCommons.MdField nameField, Item item) Remove license information, delete also the bitstream
static void	removeLicense(Context context, Item item)
static void	setLicense(Context context, Item item, java.io.InputStream licenseStm, java.lang.String mimeType) Used by DSpaceMetsIngester
static void	setLicenseRDF(Context context, Item item, java.lang.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_BUNDLE_NAME

public static final java.lang.String CC_BUNDLE_NAME

The Bundle Name

See Also:

Constant Field Values

templates

protected static final javax.xml.transform.Templates templates

Constructor Detail

CreativeCommons

public CreativeCommons()

Method Detail

isEnabled

public static boolean isEnabled()

Simple accessor for enabling of CC

setLicenseRDF

public static void setLicenseRDF(Context context,
                 Item item,
                 java.lang.String licenseRdf)
                          throws java.sql.SQLException,
                                 java.io.IOException,
                                 AuthorizeException

setLicenseRDF CC Web Service method for setting the RDF bitstream

Throws:

java.sql.SQLException

java.io.IOException

AuthorizeException

setLicense

public static void setLicense(Context context,
              Item item,
              java.io.InputStream licenseStm,
              java.lang.String mimeType)
                       throws java.sql.SQLException,
                              java.io.IOException,
                              AuthorizeException

Used by DSpaceMetsIngester

Parameters:

context -

item -

licenseStm -

mimeType -

Throws:

java.sql.SQLException

java.io.IOException

AuthorizeException - * // PATCHED 12/01 FROM JIRA re: mimetypes for CCLicense and License RDF wjb

removeLicense

public static void removeLicense(Context context,
                 Item item)
                          throws java.sql.SQLException,
                                 java.io.IOException,
                                 AuthorizeException

Throws:

java.sql.SQLException

java.io.IOException

AuthorizeException

hasLicense

public static boolean hasLicense(Context context,
                 Item item)
                          throws java.sql.SQLException,
                                 java.io.IOException

Throws:

java.sql.SQLException

java.io.IOException

getLicenseRDF

public static java.lang.String getLicenseRDF(Item item)
                                      throws java.sql.SQLException,
                                             java.io.IOException,
                                             AuthorizeException

Throws:

java.sql.SQLException

java.io.IOException

AuthorizeException

getLicenseRdfBitstream

public static Bitstream getLicenseRdfBitstream(Item item)
                                        throws java.sql.SQLException,
                                               java.io.IOException,
                                               AuthorizeException

Get Creative Commons license RDF, returning Bitstream object.

Returns:

bitstream or null.

Throws:

java.sql.SQLException

java.io.IOException

AuthorizeException

getLicenseTextBitstream

@Deprecated
public static Bitstream getLicenseTextBitstream(Item item)
                                         throws java.sql.SQLException,
                                                java.io.IOException,
                                                AuthorizeException

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)

Get Creative Commons license Text, returning Bitstream object.

Returns:

bitstream or null.

Throws:

java.sql.SQLException

java.io.IOException

AuthorizeException

getLicenseText

public static java.lang.String getLicenseText(Item item)
                                       throws java.sql.SQLException,
                                              java.io.IOException,
                                              AuthorizeException

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)

Retrieve the license text

Parameters:

item - - the item

Returns:

the license in textual format

Throws:

java.sql.SQLException

java.io.IOException

AuthorizeException

getLicenseURL

public static java.lang.String getLicenseURL(Item item)
                                      throws java.sql.SQLException,
                                             java.io.IOException,
                                             AuthorizeException

Throws:

java.sql.SQLException

java.io.IOException

AuthorizeException

fetchLicenseRDF

public static java.lang.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. If no transformation is needed then take in consideration to empty the CreativeCommons.xml

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

getCCField

public static CreativeCommons.MdField getCCField(java.lang.String fieldId)

Returns a metadata field handle for given field Id

removeLicense

public static void removeLicense(Context context,
                 CreativeCommons.MdField uriField,
                 CreativeCommons.MdField nameField,
                 Item item)
                          throws AuthorizeException,
                                 java.io.IOException,
                                 java.sql.SQLException

Remove license information, delete also the bitstream

Parameters:

context - - DSpace Context

uriField - - the metadata field for license uri

nameField - - the metadata field for license name

item - - the item

Throws:

AuthorizeException

java.io.IOException

java.sql.SQLException