hazza/DSpace
1
0
Fork 0
mirror of https://github.com/DSpace/DSpace.git synced 2025-10-16 22:43:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

DS-2604 add some comment

Browse Source
This commit is contained in:
Luigi Andrea Pascarelli
2016-09-26 19:07:47 +02:00
parent c8e49b5624
commit fe624f7f67
3 changed files with 36 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
dspace-api/src/main/java/org/dspace/content/crosswalk/CreativeCommonsTextStreamDisseminationCrosswalk.java
View File

@@ -30,6 +30,8 @@ import org.dspace.license.service.CreativeCommonsService;
* *
* @author Larry Stone * @author Larry Stone
* @version $Revision: 1.0 $ * @version $Revision: 1.0 $
*
* @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)
*/ */
public class CreativeCommonsTextStreamDisseminationCrosswalk public class CreativeCommonsTextStreamDisseminationCrosswalk
implements StreamDisseminationCrosswalk implements StreamDisseminationCrosswalk

7
dspace-api/src/main/java/org/dspace/license/CreativeCommonsServiceImpl.java
View File

@@ -57,10 +57,15 @@ public class CreativeCommonsServiceImpl implements CreativeCommonsService, Initi
/** /**
* Some BitStream Names (BSN) * Some BitStream Names (BSN)
*
* @deprecated use the metadata retrieved at {@link CreativeCommonsService#getCCField(String)} (see https://jira.duraspace.org/browse/DS-2604)
*/ */
@Deprecated @Deprecated
protected static final String BSN_LICENSE_URL = "license_url"; protected static final String BSN_LICENSE_URL = "license_url";
/**
* @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)
*/
@Deprecated @Deprecated
protected static final String BSN_LICENSE_TEXT = "license_text"; protected static final String BSN_LICENSE_TEXT = "license_text";
@@ -244,7 +249,7 @@ public class CreativeCommonsServiceImpl implements CreativeCommonsService, Initi
return licenseUri; return licenseUri;
} }
//backward compatibility // JSPUI backward compatibility see https://jira.duraspace.org/browse/DS-2604
return getStringFromBitstream(context, item, BSN_LICENSE_URL); return getStringFromBitstream(context, item, BSN_LICENSE_URL);
} }

29
dspace-api/src/main/java/org/dspace/license/service/CreativeCommonsService.java
View File

@@ -79,8 +79,9 @@ public interface CreativeCommonsService {
/** /**
* Get Creative Commons license Text, returning Bitstream object. * Get Creative Commons license Text, returning Bitstream object.
* @Deprecated *
* @return bitstream or null. * @return bitstream or null.
* @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)
*/ */
public Bitstream getLicenseTextBitstream(Item item) throws SQLException, public Bitstream getLicenseTextBitstream(Item item) throws SQLException,
IOException, AuthorizeException; IOException, AuthorizeException;
@@ -92,7 +93,33 @@ public interface CreativeCommonsService {
public LicenseMetadataValue getCCField(String fieldId); public LicenseMetadataValue getCCField(String fieldId);
/**
* 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
*
* @param license
* - an element that could be contains as part of your content
* the license rdf
* @return the document license in textual format after the transformation
*/
public String fetchLicenseRDF(Document license); public String fetchLicenseRDF(Document license);
/**
* Remove license information, delete also the bitstream
*
* @param context
* - DSpace Context
* @param uriField
* - the metadata field for license uri
* @param nameField
* - the metadata field for license name
* @param item
* - the item
* @throws AuthorizeException
* @throws IOException
* @throws SQLException
*/
public void removeLicense(Context context, LicenseMetadataValue uriField, public void removeLicense(Context context, LicenseMetadataValue uriField,
LicenseMetadataValue nameField, Item item) throws AuthorizeException, IOException, SQLException; LicenseMetadataValue nameField, Item item) throws AuthorizeException, IOException, SQLException;
} }