Package de.ipk_gatersleben.bit.bi.edal.primary_data.file.implementation

Class ApprovalServiceProviderImplementation

java.lang.Object

de.ipk_gatersleben.bit.bi.edal.primary_data.file.implementation.ApprovalServiceProviderImplementation

All Implemented Interfaces:

ApprovalServiceProvider

public class ApprovalServiceProviderImplementation
extends java.lang.Object
implements ApprovalServiceProvider

Implementation of ApprovalServiceProvider for the storage back end.

Constructor Summary

Constructors

Constructor	Description
ApprovalServiceProviderImplementation()

Method Summary

Modifier and Type	Method	Description
void	accept(java.lang.String ticket, int reviewerID)	Accept a PublicReference and publish to public.
void	acceptTicketByUser(java.lang.String ticket, int reviewerHashCode)	Accept an open ticket by the user who requested the data publication to get a final persistent ID
void	approve(PublicReference reference, javax.mail.internet.InternetAddress emailNotificationAddress)	Initialize a request to approve a PublicReference.
void	checkOpenReviews(java.util.Map<PublicReference,java.util.List<ReviewStatus>> results)	Check all ReviewStatus of the given PublicReference by calling ReviewProcess.review(List).
java.util.Map<PublicReference,java.util.List<ReviewStatus>>	getAllOpenReviews()	Load all open PublicReferences that are not yet accepted or rejected.
java.lang.String	getNewURL(PublicReference reference)	Create an new URL for a PublicReference for URLReference
PublicReference	getPublicReferenceByInternalId(java.lang.String internalId)	Get a PublicReference object by the internal UUID for generating HTML template
void	reject(java.lang.String ticket, int reviewerID)	Reject a PublicReference.
void	rejectTicketByUser(java.lang.String ticket, int reviewerHashCode)	Reject an open ticket by the user who requested to discard the process and not getting a persistent ID
java.lang.String	storePersistentID(PublicReference reference, java.lang.String doi, int year)	Store the generated DataCiteReference in to the eDAL system.

Methods inherited from class java.lang.Object

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

Constructor Detail

ApprovalServiceProviderImplementation

public ApprovalServiceProviderImplementation()

Method Detail

accept

public void accept(java.lang.String ticket,
                   int reviewerID)
            throws EdalApprovalException

Accept a PublicReference and publish to public.

Specified by:

accept in interface ApprovalServiceProvider

Parameters:

ticket - the ticket number to identify the approved PublicReference.

reviewerID - the ID to identify the reviewer.

Throws:

EdalApprovalException - if unable to accept the ticket.

acceptTicketByUser

public void acceptTicketByUser(java.lang.String ticket,
                               int reviewerHashCode)
                        throws EdalApprovalException

Description copied from interface: ApprovalServiceProvider

Accept an open ticket by the user who requested the data publication to get a final persistent ID

Specified by:

acceptTicketByUser in interface ApprovalServiceProvider

Parameters:

ticket - the ticket of the open request

reviewerHashCode - the id of the reviewer

Throws:

EdalApprovalException - if unable to accept the request

approve

public void approve(PublicReference reference,
                    javax.mail.internet.InternetAddress emailNotificationAddress)
             throws EdalApprovalException

Initialize a request to approve a PublicReference.

Specified by:

approve in interface ApprovalServiceProvider

Parameters:

reference - the PublicReference to approve.

emailNotificationAddress - the eMail address of the requesting user

Throws:

EdalApprovalException - if unable to initialize the approval request.

checkOpenReviews

public void checkOpenReviews(java.util.Map<PublicReference,java.util.List<ReviewStatus>> results)
                      throws EdalApprovalException

Check all ReviewStatus of the given PublicReference by calling ReviewProcess.review(List).

Specified by:

checkOpenReviews in interface ApprovalServiceProvider

Parameters:

results - a Map with all open PublicReferences and their ReviewStatus.

Throws:

EdalApprovalException - if unable to check open review processes.

getAllOpenReviews

public java.util.Map<PublicReference,java.util.List<ReviewStatus>> getAllOpenReviews()

Load all open PublicReferences that are not yet accepted or rejected.

Specified by:

getAllOpenReviews in interface ApprovalServiceProvider

Returns:

a Map with all open PublicReferences and the corresponding List with the ReviewStatus.

getNewURL

public java.lang.String getNewURL(PublicReference reference)
                           throws EdalApprovalException

Description copied from interface: ApprovalServiceProvider

Create an new URL for a PublicReference for URLReference

Specified by:

getNewURL in interface ApprovalServiceProvider

Parameters:

reference - the PublicReference to get a URL

Returns:

a new URL as String

Throws:

EdalApprovalException - if unable to get a URL

getPublicReferenceByInternalId

public PublicReference getPublicReferenceByInternalId(java.lang.String internalId)
                                               throws EdalException

Description copied from interface: ApprovalServiceProvider

Get a PublicReference object by the internal UUID for generating HTML template

Specified by:

getPublicReferenceByInternalId in interface ApprovalServiceProvider

Parameters:

internalId - as String

Returns:

the corresponding PublicReference

Throws:

EdalException - if unable get PublicReference

reject

public void reject(java.lang.String ticket,
                   int reviewerID)
            throws EdalApprovalException

Reject a PublicReference.

Specified by:

reject in interface ApprovalServiceProvider

Parameters:

ticket - the ticket number to identify the rejected PublicReference.

reviewerID - the ID to identify the reviewer.

Throws:

EdalApprovalException - if unable to reject the ticket.

rejectTicketByUser

public void rejectTicketByUser(java.lang.String ticket,
                               int reviewerHashCode)
                        throws EdalApprovalException

Description copied from interface: ApprovalServiceProvider

Reject an open ticket by the user who requested to discard the process and not getting a persistent ID

Specified by:

rejectTicketByUser in interface ApprovalServiceProvider

Parameters:

ticket - the ticket of the open request

reviewerHashCode - the id of the reviewer

Throws:

EdalApprovalException - if unable to accept the request

storePersistentID

public java.lang.String storePersistentID(PublicReference reference,
                                          java.lang.String doi,
                                          int year)
                                   throws EdalApprovalException

Description copied from interface: ApprovalServiceProvider

Store the generated DataCiteReference in to the eDAL system.

Specified by:

storePersistentID in interface ApprovalServiceProvider

Parameters:

reference - the corresponding PublicReference

doi - the ID as String

year - the year of the ID

Returns:

the final ID as String

Throws:

EdalApprovalException - if unable to store the ID