Package org.dspace.app.ldn.service.impl

Class LDNMessageServiceImpl

java.lang.Object

org.dspace.app.ldn.service.impl.LDNMessageServiceImpl

All Implemented Interfaces:

LDNMessageService

public class LDNMessageServiceImpl
extends Object
implements LDNMessageService

Implementation of LDNMessageService

Author:

Mohamed Eskander (mohamed.eskander at 4science dot it)

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LDNMessageServiceImpl()

Method Summary

Modifier and Type	Method	Description
int	checkQueueMessageTimeout(Context context)	Find all messages in the queue with the Processing status but timed-out and modify their queue_status considering the queue_attempts
LDNMessageEntity	create(Context context, String id)	Creates a new LDNMessage
LDNMessageEntity	create(Context context, Notification notification, String sourceIp)	Creates a new LDNMessage
void	delete(Context context, LDNMessageEntity ldnMessage)	delete the provided ldn message
int	extractAndProcessMessageFromQueue(Context context)	Elaborates the oldest enqueued message
LDNMessageEntity	find(Context context, String id)	find the ldn message by id
List<LDNMessageEntity>	findAll(Context context)	find all ldn messages
String	findEndorsementOrReviewResubmissionIdByItem(Context context, Item item, NotifyServiceEntity service)	find the UUID of a previous tentativeReject notification associated with a new resubmission (Endorsement or Review patterns only)
List<LDNMessageEntity>	findMessagesToBeReprocessed(Context context)	find the ldn messages to be reprocessed
NotifyServiceEntity	findNotifyService(Context context, Service service)	find the related notify service entity
List<LDNMessageEntity>	findOldestMessagesToProcess(Context context)	Find the oldest queued LDNMessages that still can be elaborated
List<LDNMessageEntity>	findProcessingTimedoutMessages(Context context)	Find all messages in the queue with the Processing status but timed-out
NotifyRequestStatus	findRequestsByItem(Context context, Item item)	find the ldn messages of Requests by item uuid
Optional<LDNMessageEntity>	getSingleMessageEntity(Collection<LDNMessageEntity> messages)
boolean	isTargetCurrent(Notification notification)	check if the notification is targeting the current system
boolean	isValidIp(NotifyServiceEntity origin, String sourceIp)	check if IP number is included in the configured ip-range on the Notify Service
void	update(Context context, LDNMessageEntity ldnMessage)	Update the provided LDNMessage

Methods inherited from class java.lang.Object

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

Constructor Details

LDNMessageServiceImpl

protected LDNMessageServiceImpl()

Method Details

find

public LDNMessageEntity find(Context context,
 String id)
                      throws SQLException

Description copied from interface: LDNMessageService

find the ldn message by id

Specified by:

find in interface LDNMessageService

Parameters:

context - the context

id - the uri

Returns:

the ldn message by id

Throws:

SQLException - If something goes wrong in the database

findAll

public List<LDNMessageEntity> findAll(Context context)
                               throws SQLException

Description copied from interface: LDNMessageService

find all ldn messages

Specified by:

findAll in interface LDNMessageService

Parameters:

context - the context

Returns:

all ldn messages by id

Throws:

SQLException - If something goes wrong in the database

create

public LDNMessageEntity create(Context context,
 String id)
                        throws SQLException

Description copied from interface: LDNMessageService

Creates a new LDNMessage

Specified by:

create in interface LDNMessageService

Parameters:

context - The DSpace context

id - the uri

Returns:

the created LDN Message

Throws:

SQLException - If something goes wrong in the database

create

public LDNMessageEntity create(Context context,
 Notification notification,
 String sourceIp)
                        throws SQLException

Description copied from interface: LDNMessageService

Creates a new LDNMessage

Specified by:

create in interface LDNMessageService

Parameters:

context - The DSpace context

notification - the requested notification

sourceIp - the source ip

Returns:

the created LDN Message

Throws:

SQLException - If something goes wrong in the database

isValidIp

public boolean isValidIp(NotifyServiceEntity origin,
 String sourceIp)

Description copied from interface: LDNMessageService

check if IP number is included in the configured ip-range on the Notify Service

Specified by:

isValidIp in interface LDNMessageService

Parameters:

origin - the Notify Service entity

sourceIp - the ip to evaluate

update

public void update(Context context,
 LDNMessageEntity ldnMessage)
            throws SQLException

Description copied from interface: LDNMessageService

Update the provided LDNMessage

Specified by:

update in interface LDNMessageService

Parameters:

context - The DSpace context

ldnMessage - the LDNMessage

Throws:

SQLException - If something goes wrong in the database

findNotifyService

public NotifyServiceEntity findNotifyService(Context context,
 Service service)
                                      throws SQLException

Description copied from interface: LDNMessageService

find the related notify service entity

Specified by:

findNotifyService in interface LDNMessageService

Parameters:

context - the context

service - the service

Returns:

the NotifyServiceEntity

Throws:

SQLException - if something goes wrong

findOldestMessagesToProcess

public List<LDNMessageEntity> findOldestMessagesToProcess(Context context)
                                                   throws SQLException

Description copied from interface: LDNMessageService

Find the oldest queued LDNMessages that still can be elaborated

Specified by:

findOldestMessagesToProcess in interface LDNMessageService

Parameters:

context - The DSpace context

Returns:

list of LDN messages

Throws:

SQLException - If something goes wrong in the database

findMessagesToBeReprocessed

public List<LDNMessageEntity> findMessagesToBeReprocessed(Context context)
                                                   throws SQLException

Description copied from interface: LDNMessageService

find the ldn messages to be reprocessed

Specified by:

findMessagesToBeReprocessed in interface LDNMessageService

Parameters:

context - the context

Throws:

SQLException - if something goes wrong

findProcessingTimedoutMessages

public List<LDNMessageEntity> findProcessingTimedoutMessages(Context context)
                                                      throws SQLException

Description copied from interface: LDNMessageService

Find all messages in the queue with the Processing status but timed-out

Specified by:

findProcessingTimedoutMessages in interface LDNMessageService

Parameters:

context - The DSpace context

Returns:

all the LDN Messages to be fixed on their queue_ attributes

Throws:

SQLException - If something goes wrong in the database

extractAndProcessMessageFromQueue

public int extractAndProcessMessageFromQueue(Context context)
                                      throws SQLException

Description copied from interface: LDNMessageService

Elaborates the oldest enqueued message

Specified by:

extractAndProcessMessageFromQueue in interface LDNMessageService

Parameters:

context - The DSpace context

Returns:

number of messages fixed

Throws:

SQLException

checkQueueMessageTimeout

public int checkQueueMessageTimeout(Context context)
                             throws SQLException

Description copied from interface: LDNMessageService

Find all messages in the queue with the Processing status but timed-out and modify their queue_status considering the queue_attempts

Specified by:

checkQueueMessageTimeout in interface LDNMessageService

Parameters:

context - The DSpace context

Returns:

number of messages fixed

Throws:

SQLException

getSingleMessageEntity

public Optional<LDNMessageEntity> getSingleMessageEntity(Collection<LDNMessageEntity> messages)

findRequestsByItem

public NotifyRequestStatus findRequestsByItem(Context context,
 Item item)
                                       throws SQLException

Description copied from interface: LDNMessageService

find the ldn messages of Requests by item uuid

Specified by:

findRequestsByItem in interface LDNMessageService

Parameters:

context - the context

item - the item

Returns:

the item requests object

Throws:

SQLException - If something goes wrong in the database

findEndorsementOrReviewResubmissionIdByItem

public String findEndorsementOrReviewResubmissionIdByItem(Context context,
 Item item,
 NotifyServiceEntity service)
                                                   throws SQLException

Description copied from interface: LDNMessageService

find the UUID of a previous tentativeReject notification associated with a new resubmission (Endorsement or Review patterns only)

Specified by:

findEndorsementOrReviewResubmissionIdByItem in interface LDNMessageService

Parameters:

context - the context

item - the previousVersion item associated with a potential resubmission

Returns:

the UUID of a previous tentativeReject notification associated with a potential resubmission if found

Throws:

SQLException

delete

public void delete(Context context,
 LDNMessageEntity ldnMessage)
            throws SQLException

Description copied from interface: LDNMessageService

delete the provided ldn message

Specified by:

delete in interface LDNMessageService

Parameters:

context - the context

ldnMessage - the ldn message

Throws:

SQLException - if something goes wrong

isTargetCurrent

public boolean isTargetCurrent(Notification notification)

Description copied from interface: LDNMessageService

check if the notification is targeting the current system

Specified by:

isTargetCurrent in interface LDNMessageService

Parameters:

notification - the LDN Message entity