org.dspace.license

Class CCLookup

java.lang.Object

org.dspace.license.CCLookup

public class CCLookup
extends java.lang.Object

A wrapper around Creative Commons REST web services.

Author:

Wendy Bossons

Constructor Summary

Constructors

Constructor and Description
CCLookup() Constructs a new instance with the default web services root.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getErrorMessage()
org.jdom.Document	getLicenseDocument()
java.util.Collection<CCLicenseField>	getLicenseFields(java.lang.String license, java.lang.String language) Queries the web service for a set of licenseFields for a particular license class.
java.lang.String	getLicenseId(java.lang.String class_label) Returns the id for a particular CCLicense label.
java.lang.String	getLicenseName() Retrieves the human readable name for the license issued.
java.util.Collection<CCLicense>	getLicenses(java.lang.String language) Queries the web service for the available licenses.
java.lang.String	getLicenseUrl() Retrieves the URI for the license issued.
java.lang.String	getRdf()
boolean	isSuccess()
void	issue(java.lang.String licenseURI) Passes a set of "answers" to the web service and retrieves a license.
void	issue(java.lang.String licenseId, java.util.Map answers, java.lang.String lang) Passes a set of "answers" to the web service and retrieves a license.

Methods inherited from class java.lang.Object

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

Constructor Detail

CCLookup

public CCLookup()

Constructs a new instance with the default web services root.

Method Detail

getLicenseId

public java.lang.String getLicenseId(java.lang.String class_label)

Returns the id for a particular CCLicense label. Returns an empty string if no match is found.

Parameters:

class_label - The CCLicense label to find.

Returns:

Returns a String containing the License class ID if the label is found; if not found, returns an empty string.

See Also:

CCLicense

getLicenses

public java.util.Collection<CCLicense> getLicenses(java.lang.String language)

Queries the web service for the available licenses.

Parameters:

language - The language to request labels and description strings in.

Returns:

Returns a Map of CCLicense objects.

See Also:

Map, CCLicense

getLicenseFields

public java.util.Collection<CCLicenseField> getLicenseFields(java.lang.String license,
                                                    java.lang.String language)

Queries the web service for a set of licenseFields for a particular license class.

Parameters:

license - A String specifying the CCLicense identifier to retrieve fields for.

Returns:

A Collection of LicenseField objects.

See Also:

CCLicense

issue

public void issue(java.lang.String licenseId,
         java.util.Map answers,
         java.lang.String lang)
           throws java.io.IOException

Passes a set of "answers" to the web service and retrieves a license.

Parameters:

licenseId - The identifier of the license class being requested.

answers - A Map containing the answers to the license fields; each key is the identifier of a LicenseField, with the value containing the user-supplied answer.

lang - The language to request localized elements in.

Throws:

java.io.IOException

See Also:

CCLicense, Map

issue

public void issue(java.lang.String licenseURI)
           throws java.io.IOException

Passes a set of "answers" to the web service and retrieves a license.

Parameters:

licenseURI - The uri of the license. Note: does not support localization in 1.5 -- not yet

Throws:

java.io.IOException

See Also:

CCLicense, Map

getLicenseUrl

public java.lang.String getLicenseUrl()

Retrieves the URI for the license issued.

Returns:

A String containing the URI for the license issued.

getLicenseName

public java.lang.String getLicenseName()

Retrieves the human readable name for the license issued.

Returns:

A String containing the license name.

getLicenseDocument

public org.jdom.Document getLicenseDocument()

getRdf

public java.lang.String getRdf()
                        throws java.io.IOException

Throws:

java.io.IOException

isSuccess

public boolean isSuccess()

getErrorMessage

public java.lang.String getErrorMessage()