Package org.dspace.license

Class CCLicenseConnectorServiceImpl

java.lang.Object

org.dspace.license.CCLicenseConnectorServiceImpl

All Implemented Interfaces:

CCLicenseConnectorService, InitializingBean

public class CCLicenseConnectorServiceImpl
extends Object
implements CCLicenseConnectorService, InitializingBean

Implementation for the Creative commons license connector service. This class is responsible for all the calls to the CC license API and parsing the response

Field Summary

Fields

Modifier and Type	Field	Description
protected org.jdom2.input.SAXBuilder	parser

Constructor Summary

Constructors

Constructor	Description
CCLicenseConnectorServiceImpl()

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
String	retrieveLicenseName(org.jdom2.Document doc)	Retrieve the license Name from the license document
org.jdom2.Document	retrieveLicenseRDFDoc(String licenseURI)	Retrieve the license RDF document based on the license URI
Map<String,CCLicense>	retrieveLicenses(String language)	Retrieves the CC Licenses for the provided language from the CC License API
String	retrieveRightsByQuestion(String licenseId, String language, Map<String,String> answerMap)	Retrieve the CC License URI based on the provided license id, language and answers to the field questions from the CC License API

Methods inherited from class java.lang.Object

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

Field Details

parser

protected org.jdom2.input.SAXBuilder parser

Constructor Details

CCLicenseConnectorServiceImpl

public CCLicenseConnectorServiceImpl()

Method Details

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface InitializingBean

Throws:

Exception

retrieveLicenses

public Map<String,CCLicense> retrieveLicenses(String language)

Retrieves the CC Licenses for the provided language from the CC License API

Specified by:

retrieveLicenses in interface CCLicenseConnectorService

Parameters:

language - - the language to retrieve the licenses for

Returns:

a map of licenses with the id and the license for the provided language

retrieveRightsByQuestion

public String retrieveRightsByQuestion(String licenseId,
 String language,
 Map<String,String> answerMap)

Retrieve the CC License URI based on the provided license id, language and answers to the field questions from the CC License API

Specified by:

retrieveRightsByQuestion in interface CCLicenseConnectorService

Parameters:

licenseId - - the ID of the license

language - - the language for which to retrieve the full answerMap

answerMap - - the answers to the different field questions

Returns:

the CC License URI

retrieveLicenseRDFDoc

public org.jdom2.Document retrieveLicenseRDFDoc(String licenseURI)
                                         throws IOException

Retrieve the license RDF document based on the license URI

Specified by:

retrieveLicenseRDFDoc in interface CCLicenseConnectorService

Parameters:

licenseURI - - The license URI for which to retrieve the license RDF document

Returns:

the license RDF document

Throws:

IOException

retrieveLicenseName

public String retrieveLicenseName(org.jdom2.Document doc)

Retrieve the license Name from the license document

Specified by:

retrieveLicenseName in interface CCLicenseConnectorService

Parameters:

doc - - The license document from which to retrieve the license name

Returns:

the license name