org.vivoweb.webapp.controller.freemarker

Class CreateAndLinkResourceController

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

edu.cornell.mannlib.vitro.webapp.controller.VitroHttpServlet

edu.cornell.mannlib.vitro.webapp.controller.freemarker.FreemarkerHttpServlet

org.vivoweb.webapp.controller.freemarker.CreateAndLinkResourceController

All Implemented Interfaces:

edu.cornell.mannlib.vitro.webapp.controller.MultipartRequestWrapper.ParsingStrategy, Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

@WebServlet(name="CreateAndLinkResource",
            urlPatterns="/createAndLink/*")
public class CreateAndLinkResourceController
extends edu.cornell.mannlib.vitro.webapp.controller.freemarker.FreemarkerHttpServlet

Main controller class for claiming (creating and/or linking) resources to a profile

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CreateAndLinkResourceController.PublicationType

Nested classes/interfaces inherited from class edu.cornell.mannlib.vitro.webapp.controller.freemarker.FreemarkerHttpServlet

edu.cornell.mannlib.vitro.webapp.controller.freemarker.FreemarkerHttpServlet.Template

Nested classes/interfaces inherited from class edu.cornell.mannlib.vitro.webapp.controller.VitroHttpServlet

edu.cornell.mannlib.vitro.webapp.controller.VitroHttpServlet.PickListSorter

Field Summary

Fields

Modifier and Type	Field and Description
static String	BIBO_ABSTRACT URIs of types and predicates in the VIVO ontology that we need for creating resources
static String	BIBO_ARTICLE
static String	BIBO_BOOK
static String	BIBO_DOI
static String	BIBO_ISBN10
static String	BIBO_ISBN13
static String	BIBO_ISSN
static String	BIBO_ISSUE
static String	BIBO_JOURNAL
static String	BIBO_PAGE_COUNT
static String	BIBO_PAGE_END
static String	BIBO_PAGE_START
static String	BIBO_PMID
static String	BIBO_VOLUME
static String	FOAF_FIRSTNAME
static String	FOAF_LASTNAME
static String	OBO_BEARER_OF
static String	OBO_CONTACT_INFO_FOR
static String	OBO_HAS_CONTACT_INFO
static String	OBO_INHERES_IN
static String	RDFS_LABEL
static edu.cornell.mannlib.vitro.webapp.auth.requestedAction.AuthorizationRequest	REQUIRED_ACTIONS
static String	VCARD_FAMILYNAME
static String	VCARD_GIVENNAME
static String	VCARD_HAS_NAME
static String	VCARD_HAS_URL
static String	VCARD_INDIVIDUAL
static String	VCARD_KIND
static String	VCARD_NAME
static String	VCARD_URL_CLASS
static String	VCARD_URL_PROPERTY
static String	VIVO_AUTHORSHIP
static String	VIVO_DATETIME
static String	VIVO_DATETIMEPRECISION
static String	VIVO_DATETIMEVALUE
static String	VIVO_EDITORSHIP
static String	VIVO_HASPUBLICATIONVENUE
static String	VIVO_PMCID
static String	VIVO_PUBLICATIONVENUEFOR
static String	VIVO_PUBLISHER
static String	VIVO_PUBLISHER_CLASS
static String	VIVO_PUBLISHER_OF
static String	VIVO_RANK
static String	VIVO_RELATEDBY
static String	VIVO_RELATES

Fields inherited from class edu.cornell.mannlib.vitro.webapp.controller.freemarker.FreemarkerHttpServlet

BODY_TEMPLATE_TYPE, PAGE_TEMPLATE_TYPE

Fields inherited from class edu.cornell.mannlib.vitro.webapp.controller.VitroHttpServlet

HTML_MIMETYPE, JSON_LD_MIMETYPE, JSON_MIMETYPE, N3_MIMETYPE, publicDateFormat, RDFXML_MIMETYPE, TTL_MIMETYPE, XHTML_MIMETYPE

Constructor Summary

Constructors

Constructor and Description
CreateAndLinkResourceController()

Method Summary

Modifier and Type	Method and Description
protected boolean	addDateToResource(edu.cornell.mannlib.vitro.webapp.controller.VitroRequest vreq, org.apache.jena.rdf.model.Resource work, ResourceModel.DateField date) Add a date object to the resource
protected String	createVIVOObject(edu.cornell.mannlib.vitro.webapp.controller.VitroRequest vreq, org.apache.jena.rdf.model.Model model, ResourceModel resourceModel, String typeUri) Create a new resource in VIVO, based on the values of the intermediate model
protected String	findInVIVO(edu.cornell.mannlib.vitro.webapp.controller.VitroRequest vreq, ExternalIdentifiers ids, String profileUri, Citation citation) Try to find a resource in VIVO that defines one of the external identifiers
static Set<String>	getEnabledProviders(edu.cornell.mannlib.vitro.webapp.config.ConfigurationProperties props)
protected org.apache.jena.rdf.model.Model	getExistingResource(edu.cornell.mannlib.vitro.webapp.controller.VitroRequest vreq, String uri) Find an existing resource in VIVO, and return a Model with the appropriate statements
protected String	getPublisherURI(edu.cornell.mannlib.vitro.webapp.controller.VitroRequest vreq, String publisher) Get a URI for the publisher object
protected String	getVCardURI(edu.cornell.mannlib.vitro.webapp.controller.VitroRequest vreq, String familyName, String givenName) Get a URI for a VCARD object
void	init(javax.servlet.ServletConfig config)
protected boolean	isResourceOfType(org.apache.jena.rdf.model.Resource resource, String typeUri) Check that the resource is declared to be of a particular type
protected void	processRelationships(edu.cornell.mannlib.vitro.webapp.controller.VitroRequest vreq, org.apache.jena.rdf.model.Model model, String vivoUri, String userUri, String relationship) Adjust the in-memory model to create the appropriate relationships for the claimed user role (authorship, editorship, etc)
protected edu.cornell.mannlib.vitro.webapp.controller.freemarker.responsevalues.ResponseValues	processRequest(edu.cornell.mannlib.vitro.webapp.controller.VitroRequest vreq) Main method for the resource claiming (create and link) workflow
protected void	proposeAuthorToLink(edu.cornell.mannlib.vitro.webapp.controller.VitroRequest vreq, Citation citation, String profileUri) Method to find an author to propose for linking
static void	registerProviders(edu.cornell.mannlib.vitro.webapp.config.ConfigurationProperties props)
protected void	removeAuthorship(edu.cornell.mannlib.vitro.webapp.controller.VitroRequest vreq, org.apache.jena.rdf.model.Model model, String vivoUri, int rank) Removes an existing authorship at a given position, when that position is claimed by the author
protected void	removeVCard(org.apache.jena.rdf.model.Model model, String vcardUri) Attempt to remove a VCARD from VIVO, ensuring that it is not being used first
protected edu.cornell.mannlib.vitro.webapp.auth.requestedAction.AuthorizationRequest	requiredActions(edu.cornell.mannlib.vitro.webapp.controller.VitroRequest vreq) Ensure that we can only be called if the user has the correct permissions
protected void	writeChanges(edu.cornell.mannlib.vitro.webapp.rdfservice.RDFService rdfService, org.apache.jena.rdf.model.Model existingModel, org.apache.jena.rdf.model.Model updatedModel) Determine the difference between the "existing" and "updated" models, and write the changes to VIVO

Methods inherited from class edu.cornell.mannlib.vitro.webapp.controller.freemarker.FreemarkerHttpServlet

doException, doForward, doGet, doPost, doRdf, doRedirect, doResponse, doTemplate, getBeansWrapper, getDisplayModelMenu, getFreemarkerComponentsForJsp, getPageTemplateName, getPageTemplateValues, getThemeDir, getTitle, handleException, processTemplate, processTemplateToString, wrap, wrap, write, writePage, writeTemplate, writeTemplate

Methods inherited from class edu.cornell.mannlib.vitro.webapp.controller.VitroHttpServlet

dumpRequestParameters, isAuthorizedToDisplayPage, maximumMultipartFileSize, redirectToInsufficientAuthorizationPage, redirectToLoginPage, redirectUnauthorizedRequest, service, sortForPickList, stashFileSizeException

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPut, doTrace, getLastModified, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

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

Field Detail

REQUIRED_ACTIONS

public static final edu.cornell.mannlib.vitro.webapp.auth.requestedAction.AuthorizationRequest REQUIRED_ACTIONS

BIBO_ABSTRACT

public static final String BIBO_ABSTRACT

URIs of types and predicates in the VIVO ontology that we need for creating resources

See Also:

Constant Field Values

BIBO_ARTICLE

public static final String BIBO_ARTICLE

See Also:

Constant Field Values

BIBO_BOOK

public static final String BIBO_BOOK

See Also:

Constant Field Values

BIBO_DOI

public static final String BIBO_DOI

See Also:

Constant Field Values

BIBO_ISBN10

public static final String BIBO_ISBN10

See Also:

Constant Field Values

BIBO_ISBN13

public static final String BIBO_ISBN13

See Also:

Constant Field Values

BIBO_ISSN

public static final String BIBO_ISSN

See Also:

Constant Field Values

BIBO_ISSUE

public static final String BIBO_ISSUE

See Also:

Constant Field Values

BIBO_JOURNAL

public static final String BIBO_JOURNAL

See Also:

Constant Field Values

BIBO_PAGE_COUNT

public static final String BIBO_PAGE_COUNT

See Also:

Constant Field Values

BIBO_PAGE_END

public static final String BIBO_PAGE_END

See Also:

Constant Field Values

BIBO_PAGE_START

public static final String BIBO_PAGE_START

See Also:

Constant Field Values

BIBO_PMID

public static final String BIBO_PMID

See Also:

Constant Field Values

BIBO_VOLUME

public static final String BIBO_VOLUME

See Also:

Constant Field Values

FOAF_FIRSTNAME

public static final String FOAF_FIRSTNAME

See Also:

Constant Field Values

FOAF_LASTNAME

public static final String FOAF_LASTNAME

See Also:

Constant Field Values

OBO_CONTACT_INFO_FOR

public static final String OBO_CONTACT_INFO_FOR

See Also:

Constant Field Values

OBO_HAS_CONTACT_INFO

public static final String OBO_HAS_CONTACT_INFO

See Also:

Constant Field Values

OBO_INHERES_IN

public static final String OBO_INHERES_IN

See Also:

Constant Field Values

OBO_BEARER_OF

public static final String OBO_BEARER_OF

See Also:

Constant Field Values

RDFS_LABEL

public static final String RDFS_LABEL

See Also:

Constant Field Values

VIVO_AUTHORSHIP

public static final String VIVO_AUTHORSHIP

See Also:

Constant Field Values

VIVO_DATETIME

public static final String VIVO_DATETIME

See Also:

Constant Field Values

VIVO_DATETIMEPRECISION

public static final String VIVO_DATETIMEPRECISION

See Also:

Constant Field Values

VIVO_DATETIMEVALUE

public static final String VIVO_DATETIMEVALUE

See Also:

Constant Field Values

VIVO_EDITORSHIP

public static final String VIVO_EDITORSHIP

See Also:

Constant Field Values

VIVO_HASPUBLICATIONVENUE

public static final String VIVO_HASPUBLICATIONVENUE

See Also:

Constant Field Values

VIVO_PMCID

public static final String VIVO_PMCID

See Also:

Constant Field Values

VIVO_PUBLICATIONVENUEFOR

public static final String VIVO_PUBLICATIONVENUEFOR

See Also:

Constant Field Values

VIVO_PUBLISHER

public static final String VIVO_PUBLISHER

See Also:

Constant Field Values

VIVO_PUBLISHER_CLASS

public static final String VIVO_PUBLISHER_CLASS

See Also:

Constant Field Values

VIVO_PUBLISHER_OF

public static final String VIVO_PUBLISHER_OF

See Also:

Constant Field Values

VIVO_RANK

public static final String VIVO_RANK

See Also:

Constant Field Values

VIVO_RELATEDBY

public static final String VIVO_RELATEDBY

See Also:

Constant Field Values

VIVO_RELATES

public static final String VIVO_RELATES

See Also:

Constant Field Values

VCARD_FAMILYNAME

public static final String VCARD_FAMILYNAME

See Also:

Constant Field Values

VCARD_GIVENNAME

public static final String VCARD_GIVENNAME

See Also:

Constant Field Values

VCARD_HAS_NAME

public static final String VCARD_HAS_NAME

See Also:

Constant Field Values

VCARD_HAS_URL

public static final String VCARD_HAS_URL

See Also:

Constant Field Values

VCARD_INDIVIDUAL

public static final String VCARD_INDIVIDUAL

See Also:

Constant Field Values

VCARD_KIND

public static final String VCARD_KIND

See Also:

Constant Field Values

VCARD_NAME

public static final String VCARD_NAME

See Also:

Constant Field Values

VCARD_URL_CLASS

public static final String VCARD_URL_CLASS

See Also:

Constant Field Values

VCARD_URL_PROPERTY

public static final String VCARD_URL_PROPERTY

See Also:

Constant Field Values

Constructor Detail

CreateAndLinkResourceController

public CreateAndLinkResourceController()

Method Detail

init

public void init(javax.servlet.ServletConfig config)
          throws javax.servlet.ServletException

Specified by:

init in interface javax.servlet.Servlet

Overrides:

init in class javax.servlet.GenericServlet

Throws:

javax.servlet.ServletException

getEnabledProviders

public static Set<String> getEnabledProviders(edu.cornell.mannlib.vitro.webapp.config.ConfigurationProperties props)

registerProviders

public static void registerProviders(edu.cornell.mannlib.vitro.webapp.config.ConfigurationProperties props)

requiredActions

protected edu.cornell.mannlib.vitro.webapp.auth.requestedAction.AuthorizationRequest requiredActions(edu.cornell.mannlib.vitro.webapp.controller.VitroRequest vreq)

Ensure that we can only be called if the user has the correct permissions

Overrides:

requiredActions in class edu.cornell.mannlib.vitro.webapp.controller.freemarker.FreemarkerHttpServlet

Parameters:

vreq -

Returns:

processRequest

protected edu.cornell.mannlib.vitro.webapp.controller.freemarker.responsevalues.ResponseValues processRequest(edu.cornell.mannlib.vitro.webapp.controller.VitroRequest vreq)

Main method for the resource claiming (create and link) workflow

Overrides:

processRequest in class edu.cornell.mannlib.vitro.webapp.controller.freemarker.FreemarkerHttpServlet

Parameters:

vreq -

Returns:

proposeAuthorToLink

protected void proposeAuthorToLink(edu.cornell.mannlib.vitro.webapp.controller.VitroRequest vreq,
                                   Citation citation,
                                   String profileUri)

Method to find an author to propose for linking

Parameters:

vreq -

citation -

profileUri -

getExistingResource

protected org.apache.jena.rdf.model.Model getExistingResource(edu.cornell.mannlib.vitro.webapp.controller.VitroRequest vreq,
                                                              String uri)

Find an existing resource in VIVO, and return a Model with the appropriate statements

Parameters:

vreq -

uri -

Returns:

processRelationships

protected void processRelationships(edu.cornell.mannlib.vitro.webapp.controller.VitroRequest vreq,
                                    org.apache.jena.rdf.model.Model model,
                                    String vivoUri,
                                    String userUri,
                                    String relationship)

Adjust the in-memory model to create the appropriate relationships for the claimed user role (authorship, editorship, etc)

Parameters:

vreq -

model -

vivoUri -

userUri -

relationship -

removeAuthorship

protected void removeAuthorship(edu.cornell.mannlib.vitro.webapp.controller.VitroRequest vreq,
                                org.apache.jena.rdf.model.Model model,
                                String vivoUri,
                                int rank)

Removes an existing authorship at a given position, when that position is claimed by the author

Parameters:

model -

rank -

removeVCard

protected void removeVCard(org.apache.jena.rdf.model.Model model,
                           String vcardUri)

Attempt to remove a VCARD from VIVO, ensuring that it is not being used first

Parameters:

model -

vcardUri -

createVIVOObject

protected String createVIVOObject(edu.cornell.mannlib.vitro.webapp.controller.VitroRequest vreq,
                                  org.apache.jena.rdf.model.Model model,
                                  ResourceModel resourceModel,
                                  String typeUri)

Create a new resource in VIVO, based on the values of the intermediate model

Parameters:

vreq -

model -

resourceModel -

Returns:

getPublisherURI

protected String getPublisherURI(edu.cornell.mannlib.vitro.webapp.controller.VitroRequest vreq,
                                 String publisher)

Get a URI for the publisher object

Parameters:

vreq -

publisher -

Returns:

getVCardURI

protected String getVCardURI(edu.cornell.mannlib.vitro.webapp.controller.VitroRequest vreq,
                             String familyName,
                             String givenName)

Get a URI for a VCARD object

Parameters:

vreq -

familyName -

givenName -

Returns:

addDateToResource

protected boolean addDateToResource(edu.cornell.mannlib.vitro.webapp.controller.VitroRequest vreq,
                                    org.apache.jena.rdf.model.Resource work,
                                    ResourceModel.DateField date)

Add a date object to the resource

Parameters:

vreq -

work -

date -

Returns:

findInVIVO

protected String findInVIVO(edu.cornell.mannlib.vitro.webapp.controller.VitroRequest vreq,
                            ExternalIdentifiers ids,
                            String profileUri,
                            Citation citation)

Try to find a resource in VIVO that defines one of the external identifiers

Parameters:

vreq -

ids -

profileUri -

citation -

Returns:

isResourceOfType

protected boolean isResourceOfType(org.apache.jena.rdf.model.Resource resource,
                                   String typeUri)

Check that the resource is declared to be of a particular type

Parameters:

resource -

typeUri -

Returns:

writeChanges

protected void writeChanges(edu.cornell.mannlib.vitro.webapp.rdfservice.RDFService rdfService,
                            org.apache.jena.rdf.model.Model existingModel,
                            org.apache.jena.rdf.model.Model updatedModel)

Determine the difference between the "existing" and "updated" models, and write the changes to VIVO

Parameters:

rdfService -

existingModel -

updatedModel -