org.eclipse.lyo.oslc4j.trs.client.handlers

Class TrsProviderHandler

java.lang.Object

org.eclipse.lyo.oslc4j.trs.client.handlers.TRSTaskHandler

org.eclipse.lyo.oslc4j.trs.client.handlers.TrsProviderHandler

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

ConcurrentTrsProviderHandler

public class TrsProviderHandler
extends TRSTaskHandler

Base class for every TRS provider. Handles all periodic operations for a TRS provider. This is the first version which was developed of a TRS provider which does not support any multi threading of A TRS provider's opreations The TRSProviderMultiThreaded class extends this class with support for multithreading.

Author:

Omar

Field Summary

Fields

Modifier and Type	Field and Description
protected URI	lastProcessedChangeEventUri The URI of the last processed change event
protected ChangeEventListener	listener
protected String	trsUriBase The entry point URI for the tracked resource set of this provider

Fields inherited from class org.eclipse.lyo.oslc4j.trs.client.handlers.TRSTaskHandler

baseAuth_pwd, baseAuth_userName, oslcClient, sparql_baseAuth_pwd, sparql_baseAuth_userName, sparqlQueryService, sparqlUpdateService, threadName

Constructor Summary

Constructors

Constructor and Description
TrsProviderHandler(String trsUriBase, org.eclipse.lyo.oslc4j.client.OslcClient client, String sparqlUpdateService, String sparqlQueryService, String sparqlUsername, String sparqlPassword, String providerUsername, String providerPassword)

Method Summary

Modifier and Type	Method and Description
void	attachListener(ChangeEventListener listener)
protected void	baseChangeEventsOptimization(List<org.eclipse.lyo.core.trs.ChangeEvent> compressedChangesList, List<URI> baseMembers) Deprecated.
protected List<URI>	baseChangeEventsOptimizationSafe(List<org.eclipse.lyo.core.trs.ChangeEvent> compressedChangesList, List<URI> baseMembers)
boolean	changeLogContainsEvent(URI syncPointUri, org.eclipse.lyo.core.trs.ChangeLog changeLog) returns true if the change log pojo contains the change event with the given uri and false otherwise
protected List<org.eclipse.lyo.core.trs.ChangeEvent>	compressChanges(List<org.eclipse.lyo.core.trs.ChangeEvent> changesToProcess) takes an ordered list of change events to be processed and compressed the list by removing multiple change events for the same resource and keeping only the latest event for that resource
boolean	fetchRemoteChangeLogs(org.eclipse.lyo.core.trs.ChangeLog currentChangeLog, List<org.eclipse.lyo.core.trs.ChangeLog> changeLogs) Request the pages of the change log from the TRS provider sequentially through the traversal of the paging information until the last processed change event is found.
List<org.eclipse.lyo.core.trs.ChangeLog>	fetchUpdatedChangeLogs(org.eclipse.lyo.core.trs.TrackedResourceSet updatedTrs) Return a list of change Lo objects corresponding to the pages of the change log after requesting them from the change log url.
void	pollAndProcessChanges() The main method for a TRS provider.
void	processChangeEvent(org.eclipse.lyo.core.trs.ChangeEvent changeEvent) Create the necessary sparql update for processing the change events and send it to the sparql update service
protected void	processTRSTask() Implementation of the method inherited from the TRSTaskHandler class.
String	toString()
List<org.eclipse.lyo.core.trs.Base>	updateBases(org.eclipse.lyo.core.trs.TrackedResourceSet updatedTrs) Return a list of base objects corresponding to the pages of the base after requesting them from the base url.

Methods inherited from class org.eclipse.lyo.oslc4j.trs.client.handlers.TRSTaskHandler

fetchTRSRemoteResource, run

Methods inherited from class java.lang.Object

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

Field Detail

lastProcessedChangeEventUri

protected URI lastProcessedChangeEventUri

The URI of the last processed change event

trsUriBase

protected String trsUriBase

The entry point URI for the tracked resource set of this provider

listener

protected ChangeEventListener listener

Constructor Detail

TrsProviderHandler

public TrsProviderHandler(String trsUriBase,
                          org.eclipse.lyo.oslc4j.client.OslcClient client,
                          String sparqlUpdateService,
                          String sparqlQueryService,
                          String sparqlUsername,
                          String sparqlPassword,
                          String providerUsername,
                          String providerPassword)

Parameters:

sparqlUpdateService - Set to null to disable the triplestore update

Method Detail

toString

public String toString()

Overrides:

toString in class Object

attachListener

public void attachListener(ChangeEventListener listener)

processTRSTask

protected void processTRSTask()

Implementation of the method inherited from the TRSTaskHandler class. a call to the periodic processing of the change events is done. If an exception is thrown it's logged and the uri of the last processed change event is set to null. This means that during the next period the processing of the base will be done all over again

Specified by:

processTRSTask in class TRSTaskHandler

updateBases

public List<org.eclipse.lyo.core.trs.Base> updateBases(org.eclipse.lyo.core.trs.TrackedResourceSet updatedTrs)
                                                throws JenaModelException,
                                                       IOException,
                                                       URISyntaxException

Return a list of base objects corresponding to the pages of the base after requesting them from the base url. The base url is retrieved from the trs object passes as a parameter.

Parameters:

updatedTrs - the trs object retrieved after retrieving it using the trs uri

Returns:

the pages of the base of this trs provider

Throws:

JenaModelException

IOException

URISyntaxException

fetchUpdatedChangeLogs

public List<org.eclipse.lyo.core.trs.ChangeLog> fetchUpdatedChangeLogs(org.eclipse.lyo.core.trs.TrackedResourceSet updatedTrs)
                                                                throws ServerRollBackException,
                                                                       IOException,
                                                                       JenaModelException,
                                                                       URISyntaxException

Return a list of change Lo objects corresponding to the pages of the change log after requesting them from the change log url. The pages of the change log will be requested using the change log segmentation until the last change event which was processed is found. The change log url is retrieved from the trs object passes as a parameter.

Parameters:

updatedTrs - the trs object retrieved after retrieving it using the trs uri

Returns:

the pages of the change log of this trs provider

Throws:

ServerRollBackException

IOException

JenaModelException

URISyntaxException

fetchRemoteChangeLogs

public boolean fetchRemoteChangeLogs(org.eclipse.lyo.core.trs.ChangeLog currentChangeLog,
                                     List<org.eclipse.lyo.core.trs.ChangeLog> changeLogs)
                              throws JenaModelException,
                                     IOException,
                                     URISyntaxException

Request the pages of the change log from the TRS provider sequentially through the traversal of the paging information until the last processed change event is found. Add the fetched change logs to the changeLogs argument. In case the last processed change event is found true is returned otherwise false is returned

Parameters:

currentChangeLog - the first change log from which the next page will be retrieved to retrieve the other pages of the change log

changeLogs - the list of change logs which will be filled with the pages of the change log

Returns:

true if the last processed change event is found, false otherwise

Throws:

JenaModelException

IOException

URISyntaxException

changeLogContainsEvent

public boolean changeLogContainsEvent(URI syncPointUri,
                                      org.eclipse.lyo.core.trs.ChangeLog changeLog)

returns true if the change log pojo contains the change event with the given uri and false otherwise

baseChangeEventsOptimization

@Deprecated
protected void baseChangeEventsOptimization(List<org.eclipse.lyo.core.trs.ChangeEvent> compressedChangesList,
                                                        List<URI> baseMembers)

Deprecated.

remove from the URI list the resources for which an event is already present in the change event list. Done to avoid processing base members uselessly

Parameters:

compressedChangesList - the optimized list of change events

baseMembers - the members of the base

pollAndProcessChanges

public void pollAndProcessChanges()
                           throws URISyntaxException,
                                  JenaModelException,
                                  IOException,
                                  ServerRollBackException,
                                  RepresentationRetrievalException

The main method for a TRS provider. This method consists on the periodic process of processing the new change events since last time and the processing of the base in case this is the first time the TRS provider thread is ran

Throws:

URISyntaxException

JenaModelException

IOException

ServerRollBackException

RepresentationRetrievalException

processChangeEvent

public void processChangeEvent(org.eclipse.lyo.core.trs.ChangeEvent changeEvent)
                        throws IOException,
                               URISyntaxException

Create the necessary sparql update for processing the change events and send it to the sparql update service

Parameters:

changeEvent - the change event to be processed

Throws:

IOException

URISyntaxException

baseChangeEventsOptimizationSafe

protected List<URI> baseChangeEventsOptimizationSafe(List<org.eclipse.lyo.core.trs.ChangeEvent> compressedChangesList,
                                                     List<URI> baseMembers)

compressChanges

protected List<org.eclipse.lyo.core.trs.ChangeEvent> compressChanges(List<org.eclipse.lyo.core.trs.ChangeEvent> changesToProcess)

takes an ordered list of change events to be processed and compressed the list by removing multiple change events for the same resource and keeping only the latest event for that resource

Returns:

an ordered optimized list of change events