Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
B
- blockWrite(ProceedingJoinPoint) - Method in class org.cruk.clarity.api.playback.ClarityAPIPlaybackAspect
-
Join point around methods that would cause a change in Clarity (create, update, delete, upload).
C
- ClarityAPIPlaybackAspect - Class in org.cruk.clarity.api.playback
-
Aspect for replaying server exchanges from a directory containing XML representations of entities as would be returned from a real Clarity server.
- ClarityAPIPlaybackAspect() - Constructor for class org.cruk.clarity.api.playback.ClarityAPIPlaybackAspect
-
Constructor.
- ClarityAPIPlaybackAspect(File) - Constructor for class org.cruk.clarity.api.playback.ClarityAPIPlaybackAspect
-
Constructor.
- ClarityAPIRecordingAspect - Class in org.cruk.clarity.api.record
-
Aspect for recording server exchanges with a real Clarity server as XML files to a directory on disk.
- ClarityAPIRecordingAspect() - Constructor for class org.cruk.clarity.api.record.ClarityAPIRecordingAspect
-
Constructor.
- ClarityAPIRecordingAspect(File) - Constructor for class org.cruk.clarity.api.record.ClarityAPIRecordingAspect
-
Constructor.
D
- doFind(ProceedingJoinPoint) - Method in class org.cruk.clarity.api.playback.ClarityAPIPlaybackAspect
-
Join point around the Clarity client's
find()
method. - doFind(ProceedingJoinPoint) - Method in class org.cruk.clarity.api.record.ClarityAPIRecordingAspect
-
Join point around the Clarity client's
find()
method. - doGet(ProceedingJoinPoint) - Method in class org.cruk.clarity.api.playback.ClarityAPIPlaybackAspect
-
Join point around the Spring REST client's
getForObject()
methods. - doGetEntity(ProceedingJoinPoint) - Method in class org.cruk.clarity.api.playback.ClarityAPIPlaybackAspect
-
Join point around the Spring REST client's
getForEntity()
methods. - doList(ProceedingJoinPoint) - Method in class org.cruk.clarity.api.playback.ClarityAPIPlaybackAspect
-
Join point around the
listAll
andlistSome
methods load the list of links from a serialisedBatch
object in XML file in the messages directory. - doList(ProceedingJoinPoint) - Method in class org.cruk.clarity.api.record.ClarityAPIRecordingAspect
-
Join point around the
listAll
andlistSome
methods that recreate theBatch
object that holds the list of links to the real things and writes that list to an XML file in the messages directory. - doLoad(ProceedingJoinPoint) - Method in class org.cruk.clarity.api.record.ClarityAPIRecordingAspect
-
Join point around the Clarity client's
load()
andretrieve()
methods. - doLoadAll(ProceedingJoinPoint) - Method in class org.cruk.clarity.api.playback.ClarityAPIPlaybackAspect
-
Join point around calls to the API's
loadAll
method. - doLoadAll(ProceedingJoinPoint) - Method in class org.cruk.clarity.api.record.ClarityAPIRecordingAspect
-
Join point around the Clarity client's
loadAll()
method. - doUpdate(ProceedingJoinPoint) - Method in class org.cruk.clarity.api.playback.ClarityAPIPlaybackAspect
-
Join point around the Clarity client's
update()
method. - doUpdateAll(ProceedingJoinPoint) - Method in class org.cruk.clarity.api.playback.ClarityAPIPlaybackAspect
-
Join point around the Clarity client's
updateAll()
method.
E
- equals(Object) - Method in class org.cruk.clarity.api.search.SearchTerms
-
Test whether the given object is equal to these SearchTerms.
F
- FILENAME_PATTERN - Static variable in class org.cruk.clarity.api.record.ClarityAPIRecordingAspect
-
Template for the file name pattern.
G
- getEntityClass() - Method in class org.cruk.clarity.api.search.SearchTerms
-
Get the class being searched for.
- getMessageDirectory() - Method in class org.cruk.clarity.api.playback.ClarityAPIPlaybackAspect
-
Get the directory the messages are being read from.
- getMessageDirectory() - Method in class org.cruk.clarity.api.record.ClarityAPIRecordingAspect
-
Get the directory the messages are being written to.
- getResults() - Method in class org.cruk.clarity.api.search.Search
-
Get the results of the search.
- getSearchFileName() - Method in class org.cruk.clarity.api.search.Search
-
Get the name of the file that will store the result of this search.
- getSearchFileName(SearchTerms<?>) - Static method in class org.cruk.clarity.api.search.Search
-
Get the name of the file that will store the result of the given search.
- getSearchTerms() - Method in class org.cruk.clarity.api.search.Search
-
Get the parameters of this search.
- getSearchTerms() - Method in class org.cruk.clarity.api.search.SearchTerms
-
Get the parameters of the search.
- getUpdatesDirectory() - Method in class org.cruk.clarity.api.playback.ClarityAPIPlaybackAspect
-
Get the directory the updated entities are being written to.
H
- hashCode() - Method in class org.cruk.clarity.api.search.SearchTerms
-
Override of hash code.
I
- isFailOnMissingSearch() - Method in class org.cruk.clarity.api.playback.ClarityAPIPlaybackAspect
-
Whether to fail if there is no result recorded for a search, or whether to simply return no results.
- isRecordSearchesWithoutResults() - Method in class org.cruk.clarity.api.record.ClarityAPIRecordingAspect
-
Whether to record a search that returns no results.
L
- limsIdFromObject(Object) - Static method in class org.cruk.clarity.api.record.ClarityAPIRecordingAspect
-
Shared method to get the LIMS id from an object, which must at least implement
Locatable
. - limsIdFromUri(Class<?>, String) - Static method in class org.cruk.clarity.api.record.ClarityAPIRecordingAspect
-
Shared method to get the LIMS id out of a URI, public to let the playback aspect use it.
M
- merge(Search<E>) - Method in class org.cruk.clarity.api.search.Search
-
Merge the results of another search into this search's results.
N
- NoRecordingException - Exception in org.cruk.clarity.api.playback
-
Exception thrown when an entity or search is requested that has no recording in the playback message directory.
- NoRecordingException(String) - Constructor for exception org.cruk.clarity.api.playback.NoRecordingException
-
Constructor.
O
- org.cruk.clarity.api.playback - package org.cruk.clarity.api.playback
-
The classes necessary to replay server calls from entity XML files on disk.
- org.cruk.clarity.api.record - package org.cruk.clarity.api.record
-
The classes necessary to record entities returned from a Clarity server to XML files on disk.
- org.cruk.clarity.api.recorder - module org.cruk.clarity.api.recorder
-
The Clarity Java client recorder for Clarity 6+.
- org.cruk.clarity.api.search - package org.cruk.clarity.api.search
-
Classes supporting the recording of searches for record and playback.
S
- Search<E extends Locatable> - Class in org.cruk.clarity.api.search
-
A class holding both the parameters of a search and the links returned from that search.
- Search(Map<String, ?>, Class<E>) - Constructor for class org.cruk.clarity.api.search.Search
-
Constructor that takes the parameters from a call to the API's
find
method. - Search(SearchTerms<E>) - Constructor for class org.cruk.clarity.api.search.Search
-
Constructor that accepts an already created
SearchTerms
object. - SEARCH_FILE_PATTERN - Static variable in class org.cruk.clarity.api.search.Search
-
The default name for search files.
- SearchTerms<E extends Locatable> - Class in org.cruk.clarity.api.search
-
Class recording the parameters and entity class of a call to the API's
find
method. - SearchTerms(Map<String, ?>, Class<E>) - Constructor for class org.cruk.clarity.api.search.SearchTerms
-
Creates a new SearchTerms object with the given values (as have been passed to find).
- setClarityAPI(ClarityAPI) - Method in class org.cruk.clarity.api.playback.ClarityAPIPlaybackAspect
-
Set the public interface access to the API.
- setFailOnMissingSearch(boolean) - Method in class org.cruk.clarity.api.playback.ClarityAPIPlaybackAspect
-
Get whether this aspect should fail if a search doesn't have a recording.
- setInternalClarityAPI(ClarityAPIInternal) - Method in class org.cruk.clarity.api.playback.ClarityAPIPlaybackAspect
-
Set the internal interface access to the API.
- setInternalClarityAPI(ClarityAPIInternal) - Method in class org.cruk.clarity.api.record.ClarityAPIRecordingAspect
-
Set the internal interface access to the API.
- setJaxbMarshaller(Jaxb2Marshaller) - Method in class org.cruk.clarity.api.playback.ClarityAPIPlaybackAspect
-
Inject the JAXB marshaller.
- setJaxbMarshaller(Jaxb2Marshaller) - Method in class org.cruk.clarity.api.record.ClarityAPIRecordingAspect
-
Inject the JAXB marshaller.
- setMessageDirectory(File) - Method in class org.cruk.clarity.api.playback.ClarityAPIPlaybackAspect
-
Set the directory the messages are being written to.
- setMessageDirectory(File) - Method in class org.cruk.clarity.api.record.ClarityAPIRecordingAspect
-
Set the directory the messages are being written to.
- setRecordSearchesWithoutResults(boolean) - Method in class org.cruk.clarity.api.record.ClarityAPIRecordingAspect
-
Set whether to record a search with zero results or not.
- setResults(List<LimsLink<E>>) - Method in class org.cruk.clarity.api.search.Search
-
Set the results of the search.
- setUpdatesDirectory(File) - Method in class org.cruk.clarity.api.playback.ClarityAPIPlaybackAspect
-
Set the directory the updated entities are being written to.
T
- toString() - Method in class org.cruk.clarity.api.search.Search
-
Get a human readable representation of this object.
- toString() - Method in class org.cruk.clarity.api.search.SearchTerms
-
Get a human readable representation of this object.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form