org.eclipse.lyo.oslc4j.trs.server

Class ChangeHistories

java.lang.Object

org.eclipse.lyo.oslc4j.trs.server.ChangeHistories

public abstract class ChangeHistories
extends Object

This class is the backbone of the Tracked resource set service class. This class is extended by oslc adapters wishing to implement an OSLC TRS interface. The implementing classes need to implement one method returning the change history of the resources living in the tool exposed by the OSLC adapter

Since:

2.3.0

Version:

$version-stub$

Field Summary

Fields

Modifier and Type	Field and Description
protected List<HistoryData>	allHistories Saved History data
protected boolean	artificialTRS A flag which should be turned on to true in case the inheriting class will be exposing artificial TRS data which using the utility method of the ArtificialTRSMaker class.
protected ArtificialTRSMaker	artificialTRSMaker Mutex used for managing concurrent accesses to TRS information
static Comparator<org.eclipse.lyo.core.trs.ChangeEvent>	changeEventComparator
protected boolean	hasBeenTweaked This flag should be set to true by the implementing class in case it generates TRS data for its TRS interface using the artifical TRS maker class functionality.
static Comparator<HistoryData>	histDataComparator Comparators for change events and history data
protected boolean	periodicArtificialTRS If this flag is turned on, artificial history data will be periodically added for the existing base resources
protected String	serviceBase url prefix for the trs url e.g http://host/services/ will imply the trs uri shall be of the type http://host/services/trs
protected long	UPDATEINTERVAL interval for updating the base resources

Constructor Summary

Constructors

Constructor and Description
ChangeHistories()
ChangeHistories(long UPDATEINTERVAL, String serviceBase)

Method Summary

Modifier and Type	Method and Description
void	buildBaseResourcesAndChangeLogs(javax.servlet.http.HttpServletRequest httpServletRequest) A synchronized call to the buildBaseResourcesAndChangeLogsInternal to manage concurrent calls to the TRS service
org.eclipse.lyo.core.trs.Base	getBaseResource(String pagenum, javax.servlet.http.HttpServletRequest httpServletRequest) Return pagenum's Base resource
org.eclipse.lyo.core.trs.ChangeLog	getChangeLog(String pagenum, javax.servlet.http.HttpServletRequest httpServletRequest) Return pagenum's ChangeLog
abstract HistoryData[]	getHistory(javax.servlet.http.HttpServletRequest httpServletRequest, Date dateAfter) Implemented by inheriting classes.
HistoryData[]	getOrderedHistory(javax.servlet.http.HttpServletRequest httpServletRequest, Date dateAfter) Order the history data returned by the getHistory method to use it in the rest of the class
String	getServiceBase()
long	getUPDATEINTERVAL()
void	setServiceBase(String serviceBase)
void	setUPDATEINTERVAL(long uPDATEINTERVAL)
void	updateHistories(List<HistoryData> hd)
void	updateHistories(String changeType, List<URI> changedUris) add a list of changes to the existing history data list.

Methods inherited from class java.lang.Object

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

Field Detail

histDataComparator

public static Comparator<HistoryData> histDataComparator

Comparators for change events and history data

changeEventComparator

public static Comparator<org.eclipse.lyo.core.trs.ChangeEvent> changeEventComparator

artificialTRSMaker

protected ArtificialTRSMaker artificialTRSMaker

Mutex used for managing concurrent accesses to TRS information

allHistories

protected List<HistoryData> allHistories

Saved History data

UPDATEINTERVAL

protected long UPDATEINTERVAL

interval for updating the base resources

artificialTRS

protected boolean artificialTRS

A flag which should be turned on to true in case the inheriting class will be exposing artificial TRS data which using the utility method of the ArtificialTRSMaker class.

periodicArtificialTRS

protected boolean periodicArtificialTRS

If this flag is turned on, artificial history data will be periodically added for the existing base resources

hasBeenTweaked

protected boolean hasBeenTweaked

This flag should be set to true by the implementing class in case it generates TRS data for its TRS interface using the artifical TRS maker class functionality.

serviceBase

protected String serviceBase

url prefix for the trs url e.g http://host/services/ will imply the trs uri shall be of the type http://host/services/trs

Constructor Detail

ChangeHistories

public ChangeHistories(long UPDATEINTERVAL,
                       String serviceBase)

ChangeHistories

public ChangeHistories()

Method Detail

getHistory

public abstract HistoryData[] getHistory(javax.servlet.http.HttpServletRequest httpServletRequest,
                                         Date dateAfter)

Implemented by inheriting classes. returns the changes through time to the resources exposes by the adapter starting from the given point in time

Parameters:

dateAfter - the date starting from which the change data is returned

updateHistories

public void updateHistories(String changeType,
                            List<URI> changedUris)

add a list of changes to the existing history data list.

Parameters:

changeType - the type of change to be added: modification, creation or deletion

changedUris - the uris of the changed objects

updateHistories

public void updateHistories(List<HistoryData> hd)

getOrderedHistory

public HistoryData[] getOrderedHistory(javax.servlet.http.HttpServletRequest httpServletRequest,
                                       Date dateAfter)

Order the history data returned by the getHistory method to use it in the rest of the class

buildBaseResourcesAndChangeLogs

public void buildBaseResourcesAndChangeLogs(javax.servlet.http.HttpServletRequest httpServletRequest)
                                     throws URISyntaxException

A synchronized call to the buildBaseResourcesAndChangeLogsInternal to manage concurrent calls to the TRS service

Throws:

URISyntaxException

getBaseResource

public org.eclipse.lyo.core.trs.Base getBaseResource(String pagenum,
                                                     javax.servlet.http.HttpServletRequest httpServletRequest)
                                              throws URISyntaxException

Return pagenum's Base resource

Parameters:

pagenum - the required page of the base

httpServletRequest - the http request for the base page

Returns:

the required page of the base

Throws:

URISyntaxException - propagated from called method throwing same exception

getChangeLog

public org.eclipse.lyo.core.trs.ChangeLog getChangeLog(String pagenum,
                                                       javax.servlet.http.HttpServletRequest httpServletRequest)
                                                throws URISyntaxException

Return pagenum's ChangeLog

Parameters:

pagenum - the required page of the change log

httpServletRequest - the http request for the change log page

Returns:

the required page of the change log

Throws:

URISyntaxException - propagated from called method throwing same exception

getServiceBase

public String getServiceBase()

setServiceBase

public void setServiceBase(String serviceBase)

getUPDATEINTERVAL

public long getUPDATEINTERVAL()

setUPDATEINTERVAL

public void setUPDATEINTERVAL(long uPDATEINTERVAL)