TestBOLoader (MyTISM API Documentation)

java.lang.Object
- de.ipcon.db.testing.TestBOLoader

All Implemented Interfaces:

BLOBLoaderI, BOLoaderI, BOQueryLoaderI, ExpiringTokenStorageProviderI, GrooqlBOLoaderI, SchemaProviderI
```
public class TestBOLoader
extends java.lang.Object
implements BOLoaderI, ExpiringTokenStorageProviderI
```
A minimalist BOLoaderI implementation for testing without having an actual running MyTISM server.

Nested Class Summary
- Nested classes/interfaces inherited from interface de.ipcon.db.core.BOQueryLoaderI
  BOQueryLoaderI.InternalHelper

Field Summary
- Fields inherited from interface de.ipcon.db.core.BOLoaderI
  rootPaneToLockOnConnectionInterrupt

Constructor Summary

Constructors
Constructor and Description

TestBOLoader(SchemaI _schema)

TestBOLoader(java.lang.String schemaPath)

Constructors
Constructor and Description
`TestBOLoader(SchemaI _schema)`
`TestBOLoader(java.lang.String schemaPath)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addQueryInterceptor(java.lang.String query, TestQueryInterceptorI qi)` Adds a Queryinterceptor to this BOLoader, which allows to explicitly execute certain code to calculate the response to this query.
`void`	`clearQueryInterceptors()` Clears the list of interceptable Queries
`java.lang.String`	`createExpiringToken(java.lang.String serviceName, byte[] value, long expiryms)` Works like @see #createExpiringToken(String,String,byte[],long), but creates a non-conflicting tokenName within the store, stores the value and returns the chosen tokenName.
`void`	`createExpiringToken(java.lang.String serviceName, java.lang.String tokenName, byte[] value, long expiryms)` ExpiringTokenStorageProviderI (copy of the minimal code from DBMan)
`TestTransaction`	`createInstrumentedTransaction()`
`TestTransaction`	`createInstrumentedTransaction(java.lang.String description)`
`TestTransaction`	`createInstrumentedTransaction(java.lang.String description, TemporaryIdSupplierI tempIdSupplier)`
`TestTransaction`	`createTransaction()` Creates and returns a new Transaction of type TestTransaction.
`TestTransaction`	`createTransaction(java.lang.String description)`
`TestTransaction`	`createTransaction(java.lang.String description, TemporaryIdSupplierI tempIdSupplier)`
`TestTransaction`	`createTransactionDescWithInitialDataFor(java.lang.String txDescription, java.lang.Object[] namesOrClasses)`
`TestTransaction`	`createTransactionWithInitialDataFor(java.lang.Object[] namesOrClasses)` Creates or returns a cached transaction with the provided names or classes.
`byte[]`	`destroyExpiringToken(java.lang.String serviceName, java.lang.String tokenName)` Destroys a time limited token immediately
`void`	`drain()` If this BOLoader has a cache, we request it to empty it.
`void`	`execute(BatchedBackendRequestI[] srs)`
`boolean`	`exists(java.lang.Long $44)` wrapper for exists(id, null).
`boolean`	`exists(java.lang.Long $42, java.lang.Class<? extends BOI> $43)` Returns true if a BO with the given id exists.
`BO`	`frapFromCache(BO bo)` Put a BO instance to further use in this BOLoader, cloning it in case it's unknown, giving back a cached instance in case it's cached, in any way returning an instance without making further reloads (which would make the effort of caching it useless).
`byte[]`	`getBLOB(java.lang.Long boid)` get the BLOB belonging to BO[id].
`long`	`getBLOB(java.lang.Long $31, java.io.DataOutput $32)` Writes the BLOB belonging to BO[id] to the passed DataOutput.
`long`	`getBLOB(java.lang.Long $33, java.io.DataOutput $34, boolean $35)` Writes the BLOB belonging to BO[id] to the passed DataOutput.
`long`	`getBLOB(java.lang.Long $36, java.io.DataOutput $37, boolean $38, java.lang.Long $39)` Writes the BLOB belonging to BO[id] to the passed DataOutput.
`byte[]`	`getBLOB(java.lang.Long boid, java.lang.Long backuppingBPId)` get the BLOB belonging to BO[id].
`long`	`getBLOB(java.lang.Long $22, java.io.OutputStream $23)` Writes the BLOB belonging to BO[id] to the passed OutputStream.
`long`	`getBLOB(java.lang.Long $24, java.io.OutputStream $25, boolean $26)` Writes the BLOB belonging to BO[id] to the passed OutputStream.
`long`	`getBLOB(java.lang.Long $27, java.io.OutputStream $28, boolean $29, java.lang.Long $30)` Writes the BLOB belonging to BO[id] to the passed OutputStream.
`VFile`	`getBLOBInfo(java.lang.Long id)` gathers information about the BLOB belonging to BO[i].
`VFile`	`getBLOBInfo(java.lang.Long id, java.lang.Long backuppingBPId)` gathers information about the BLOB belonging to BO[i].
`BO`	`getBO(java.lang.Long id)` wrapper for getBO(id, null).
`BO`	`getBO(java.lang.Long id, java.lang.Class<? extends BOI> classtip)` Returns the BO with the given id.
`BO[]`	`getBOs(long[] ids)` wrapper for getBOs(ids, null)
`BO[]`	`getBOs(java.lang.Long[] ids)` wrapper for getBOs(ids, null)
`BO[]`	`getBOs(long[] ids, java.lang.Class<? extends BOI> classtip)` returns the BOs with the given ids.
`BO[]`	`getBOs(java.lang.Long[] ids, java.lang.Class<? extends BOI> classtip)` returns the BOs with the given ids.
`BOT`	`getBOT(java.lang.Class<? extends BOI> $47)`
`BO`	`getBOUncached(java.lang.Long id)`
`BO`	`getBOUncached(java.lang.Long id, java.lang.Class<? extends BOI> classtip)` Loads and returns the BO with this Id with a non caching BOLoader.
`CryptoHandlerI`	`getCryptoHandler()` get a reference to the CryptoHandler used.
`DBManEventProviderI`	`getEventProvider()` Returns the DBManEventProviderI of this BOLoader, if any.
`FeatureManagerI`	`getFeatureManager()`
`FileVaultI`	`getFileVault()`
`java.lang.Long`	`getNextId()` get a unique Long id from the backend.
`BOLoaderI`	`getParentLoader()` returns the BOLoader which this BOLoader uses to load its objects.
`BO[]`	`getRelationBOs(java.lang.Long id, java.lang.Class<? extends BOI> classtip, java.lang.String attributeName)` this method is used by the lazy loading map/list implementation to load related objects when needed.
`BOLoaderI`	`getRootLoader()` Returns the root BOLoader of this BOLoader or this if there is no more parent loader.
`SchemaI`	`getSchema()` gets a reference to the schema which is used by this BOLoader.
`java.lang.String`	`getTraceQueryOnEntity()`
`TestTransaction`	`getTx()`
`boolean`	`hasBLOB(java.lang.Long id)`
`boolean`	`hasBLOB(java.lang.Long id, java.lang.Long backuppingBPId)`
`void`	`injectAdditionalPersistentBOs(java.util.Collection<BO> bos)` Adds the given `BO` instances to the set of "persistent" `BO`s known to this loader (which is the set of `BO`s known to the most recently created `Transaction` with this loader).
`boolean`	`isCaching()` If true, then this BOLoaderI uses an internal cache, holding all BOs hat were loaded or frapped into it.
`java.lang.Boolean`	`isLoggedIn(Benutzer $40)` Tells if the given Benutzer is currently logged in.
`boolean`	`isLoggedInNN(Benutzer $41)` Tells if the given Benutzer is currently logged in.
`boolean`	`isRecording()` Returns true if this BOLoaderI records changes.
`boolean`	`isTesting()` Returns true if this BOLoaderI is for testing only, i.e. used in JUnit testing environments only.
`static CBOSchema`	`loadSchema(java.lang.String schemaPath)`
`static void`	`main(java.lang.String[] args)`
`static TestBOLoader`	`of(java.lang.String projectPath)` Builder for a new TestBOLoader based on a mix from a package or file path.
`java.util.List<BO>`	`parseQueryAndFetchBOs(java.lang.String query)` Try to parse and anwser this query (generic method).
`java.util.List<BO>`	`parseQueryAndFetchBOs(java.lang.String query, java.lang.Object[] pvals)`
`BatchedBackendRequestI`	`prepareQuery(java.lang.String s)`
`BatchedBackendRequestI`	`prepareQuery(java.lang.String s, java.lang.Object[] o)`
`de.ipcon.db.core.QueryResultsI`	`query(BOQuery _eq)` query objects in an iterative way to hide backend processing time.
`de.ipcon.db.core.QueryResultsI`	`query(java.lang.String query)` wrapper for query(t, Object[0])
`de.ipcon.db.core.QueryResultsI`	`query(java.lang.String query, java.lang.Object[] pvals)` query objects in an iterative way to hide backend processing time.
`java.util.List`	`queryBO(BOQuery _eq)` query objects and block until all objects are transferred, returns Objects as a List.
`java.util.List<BO>`	`queryBO(java.lang.String query)` wrapper for queryBO(String, Object[0])
`java.util.List<BO>`	`queryBO(java.lang.String query, java.lang.Object[] pvals)` query objects and block until all objects are transferred, returns Objects as a List.
`de.ipcon.db.core.QueryResultsI`	`queryRelation(long $48, java.lang.Class<? extends BOI> $49, java.lang.String $50)` does the same as @see #getRelationBOs, but returns a QueryResultsI like @see #query.
`TestQueryInterceptorI`	`removeQueryInterceptor(java.lang.String query)` Removes the Interceptor that handles this query from the list of possible Interceptors and returns it.
`byte[]`	`retrieveExpiringToken(java.lang.String serviceName, java.lang.String tokenName)` Retrieves a time limited token
`void`	`setSchema(SchemaI $51)`
`void`	`setTraceQueryOnEntity(java.lang.String $53)`
`void`	`setTx(TestTransaction $52)`
`java.lang.Long`	`testAuth(Anmeldung $45)` Tests wether given credentials can be verified.
`boolean`	`testAuth(de.ipcon.db.core.PasswortUeberpruefung $46)` Tests wether given credentials can be verified.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface de.ipcon.db.core.BOLoaderI
frapBOArrayFromCache, frapBOIArrayFromCache, frapBOsFromCache, frapFromCache, isAncestorOf, isRootLoader, isServerSide, prepareQuery

Methods inherited from interface de.ipcon.db.blob.BLOBLoaderI
haveBLOB, haveBLOB, haveBLOB

Methods inherited from interface de.ipcon.db.core.BOQueryLoaderI
getBOByAttr, getBOByAttr, getBOByAttr, getBOByAttrs, getBOByAttrs, getBOByAttrs, getBOsByAttrs, getBOsByAttrs, getBOsByAttrs, getBOsByAttrs, getOneBOByAttr, getUniqueBOByAttr

- Constructor Detail
  - TestBOLoader
```
public TestBOLoader(java.lang.String schemaPath)
```
  - TestBOLoader
```
public TestBOLoader(SchemaI _schema)
```
- Method Detail
  - main
```
public static void main(java.lang.String[] args)
```
  - isTesting
```
public boolean isTesting()
```
    Description copied from interface: BOLoaderI
    
    Returns true if this BOLoaderI is for testing only, i.e. used in JUnit testing environments only.
    
    Specified by:
    
    isTesting in interface BOLoaderI
  - injectAdditionalPersistentBOs
```
public void injectAdditionalPersistentBOs(java.util.Collection<BO> bos)
```
    Adds the given BO instances to the set of "persistent" BOs known to this loader (which is the set of BOs known to the most recently created Transaction with this loader).
  - of
```
public static TestBOLoader of(java.lang.String projectPath)
```
    Builder for a new TestBOLoader based on a mix from a package or file path. The parameters are concatenated to generate the full schemaPath used for the constructor. Will not work if the projectPath name contains a dot - which shouldn't be possible anywawy due to the way the projects are structured. Expected usage: TestBOLoader.of('@PRJPACK@')
    Additional supported usages, e.g.: TestBOLoader.of('@PRJPACK@', '/schema/schema.xml')
    TestBOLoader.of('@PRJPACK@/schema', '/schema.xml')
    TestBOLoader.of('com.myproject') TestBOLoader.of('com/myproject', '/schema/schema.xml')
    TestBOLoader.of('com('com.myproject', 'schema.schema.xml')
    
    Parameters:
    
    schemaPath - the path to the schema file itself. Defaults to '/schema/schema.xml'
    
    Returns:
    
    the TestBOLoader for this projects schema
  - loadSchema
```
public static CBOSchema loadSchema(java.lang.String schemaPath)
```
  - getNextId
```
public java.lang.Long getNextId()
```
    Description copied from interface: BOLoaderI
    
    get a unique Long id from the backend. Please note that the ids drawn here are considered 'consumed'. An intentional delay in the backend safeguards that the process of consuming all usable ids from an instance will take at least about 29247120867 years.
    
    Specified by:
    
    getNextId in interface BOLoaderI
    
    Returns:
    
    Long id which is guaranteed to be unique within the whole cluster.
  - createTransaction
```
public TestTransaction createTransaction()
```
    Creates and returns a new Transaction of type TestTransaction. The Transaction created last is implicitly used in BO lookups.
    
    Parameters:
    
    description - description for the TX, if null a default description will be generated
    
    tempIdSupplier - FIXME! 2022-05-11: Ignored, not used
  - createTransaction
```
public TestTransaction createTransaction(java.lang.String description)
```
  - createTransaction
```
public TestTransaction createTransaction(java.lang.String description,
                                         TemporaryIdSupplierI tempIdSupplier)
```
  - createTransactionWithInitialDataFor
```
public TestTransaction createTransactionWithInitialDataFor(java.lang.Object[] namesOrClasses)
```
    Creates or returns a cached transaction with the provided names or classes. Will NOT call the initEnviroment methods of the BOs, which can cause Objects from previous tests leaking into the current test, in case a class uses static variables for caching - FIXME. See tx.injectInitialDataFor(Class...) (from TestingExtensions#injectInitialDataFor) for a non caching, clean init.
  - createTransactionDescWithInitialDataFor
```
public TestTransaction createTransactionDescWithInitialDataFor(java.lang.String txDescription,
                                                               java.lang.Object[] namesOrClasses)
```
  - createInstrumentedTransaction
```
public TestTransaction createInstrumentedTransaction()
```
    Returns:
    
    a new test transaction with a freshly created instrumented schema
  - createInstrumentedTransaction
```
public TestTransaction createInstrumentedTransaction(java.lang.String description)
```
  - createInstrumentedTransaction
```
public TestTransaction createInstrumentedTransaction(java.lang.String description,
                                                     TemporaryIdSupplierI tempIdSupplier)
```
  - getBO
```
public BO getBO(java.lang.Long id)
         throws ObjectNotPersistentException
```
    Description copied from interface: BOLoaderI
    
    wrapper for getBO(id, null). FIXME!! TT 2023-05-11: This method can probably return null in a few cases but I have no information what exactly these might be and it also depends on the actual implementing class. Also some implementations (DBMan for example) will throw ObjectNotPersistentException if no matching BO is found, while other implementations will not. Some classes - for example Mandant from crm-accounts module - will rely in ObjectNotPersistentException being thrown.
    
    Specified by:
    
    getBO in interface BOLoaderI
    
    Throws:
    
    ObjectNotPersistentException
    
    See Also:
    
    BOLoaderI.getBO(Long, Class)
  - getBO
```
public BO getBO(java.lang.Long id,
                java.lang.Class<? extends BOI> classtip)
         throws ObjectNotPersistentException
```
    Description copied from interface: BOLoaderI
    
    Returns the BO with the given id. If the BOLoader instance has an instance cache (like the Transaction class), then multiple calls to this method with the same id will return the exact same object, which means getBO(id,...)==getBO(id,...). The class tip is just what the name suggests, just a tip and will only have performance consequences if a wrong or null value is passed. FIXME!! TT 2023-05-11: This method can probably return null in a few cases but I have no information what exactly these might be and it also depends on the actual implementing class. Also some implementations (DBMan for example) will throw ObjectNotPersistentException if no matching BO is found, while other implementations will not. Some classes - for example Mandant from crm-accounts module - will rely in ObjectNotPersistentException being thrown.
    
    Specified by:
    
    getBO in interface BOLoaderI
    
    Parameters:
    
    id - the id of the BO
    
    classtip - a guess which class the object has. May be null.
    
    Returns:
    
    BO with the given id.
    
    Throws:
    
    ObjectNotPersistentException
  - getBOs
```
public BO[] getBOs(java.lang.Long[] ids,
                   java.lang.Class<? extends BOI> classtip)
```
    Description copied from interface: BOLoaderI
    
    returns the BOs with the given ids. If the BOLoader instance has an instance cache (like the Transaction class), then multiple calls to this method will return an array with the exact same objects. The class tip is common for all objects within this call and may be null.
    
    Specified by:
    
    getBOs in interface BOLoaderI
    
    Parameters:
    
    ids - array of Longs with ids for the requested BOs.
    
    classtip - guess for classes which the BOs belong to, may be null.
    
    Returns:
    
    BO[] with the requested BOs.
    
    See Also:
    
    Transaction
  - getBOs
```
public BO[] getBOs(java.lang.Long[] ids)
```
    Description copied from interface: BOLoaderI
    
    wrapper for getBOs(ids, null)
    
    Specified by:
    
    getBOs in interface BOLoaderI
    
    See Also:
    
    BOLoaderI.getBOs(Long[],Class)
  - getBOs
```
public BO[] getBOs(long[] ids,
                   java.lang.Class<? extends BOI> classtip)
```
    Description copied from interface: BOLoaderI
    
    returns the BOs with the given ids. If the BOLoader instance has an instance cache (like the Transaction class), then multiple calls to this method will return an array with the exact same objects. The class tip is common for all objects within this call and may be null.
    
    Specified by:
    
    getBOs in interface BOLoaderI
    
    Parameters:
    
    ids - array of longs with ids for the requested BOs.
    
    classtip - guess for classes which the BOs belong to, may be null.
    
    Returns:
    
    BO[] with the requested BOs.
    
    See Also:
    
    Transaction
  - getBOs
```
public BO[] getBOs(long[] ids)
```
    Description copied from interface: BOLoaderI
    
    wrapper for getBOs(ids, null)
    
    Specified by:
    
    getBOs in interface BOLoaderI
    
    See Also:
    
    BOLoaderI.getBOs(long[],Class)
  - getBOUncached
```
public BO getBOUncached(java.lang.Long id)
```
    Specified by:
    
    getBOUncached in interface BOLoaderI
  - getBOUncached
```
public BO getBOUncached(java.lang.Long id,
                        java.lang.Class<? extends BOI> classtip)
```
    Description copied from interface: BOLoaderI
    
    Loads and returns the BO with this Id with a non caching BOLoader. The BOLoader of the returned BO can (but doesn't have to) be different than the BOLoader this method was called on, e.g. BOLoaderI.isCaching() BOLoaderI instances.
    
    Specified by:
    
    getBOUncached in interface BOLoaderI
  - getRelationBOs
```
public BO[] getRelationBOs(java.lang.Long id,
                           java.lang.Class<? extends BOI> classtip,
                           java.lang.String attributeName)
```
    Description copied from interface: BOLoaderI
    
    this method is used by the lazy loading map/list implementation to load related objects when needed. It's not thought for day to day use.
    
    Specified by:
    
    getRelationBOs in interface BOLoaderI
    
    Parameters:
    
    id - id of the BO which the requested BOs has a relation to
    
    classtip - common superclass of the requested bos
    
    attributeName - name of the relation from the BO to the requested ones
    
    Returns:
    
    bo[id].attributeName as array.
  - query
```
public de.ipcon.db.core.QueryResultsI query(java.lang.String query)
```
    Description copied from interface: BOLoaderI
    
    wrapper for query(t, Object[0])
    
    Specified by:
    
    query in interface BOLoaderI
    
    Specified by:
    
    query in interface BOQueryLoaderI
    
    See Also:
    
    BOLoaderI.query(String, Object[])
  - query
```
public de.ipcon.db.core.QueryResultsI query(java.lang.String query,
                                            java.lang.Object[] pvals)
```
    Description copied from interface: BOLoaderI
    
    query objects in an iterative way to hide backend processing time. The QueryResults interface "feels" like the standard iterator interface from the collections framework and it's thought to be used like this: This sample shows how to query bla BOs though this method do it = bol.query("bla from pack.bo bla where not Ldel limit 2") loop while it.hasNext() bo = BO it.getCurrentObject() -- hopefully this IS a BO, depends on the query. -- do whatever you have to do with the bo finally it.close() end The finally clause is very important to free up database and backend resources, so please don't forget this step!
    
    Specified by:
    
    query in interface BOLoaderI
    
    Specified by:
    
    query in interface BOQueryLoaderI
    
    Specified by:
    
    query in interface GrooqlBOLoaderI
    
    Parameters:
    
    query - the query to fetch, written in OQL
    
    pvals - an object array corresponding with $n entries, $1 is pvals[0] and so forth. Must not be null.
    
    Returns:
    
    QueryResults iterator through the query results.
  - query
```
public de.ipcon.db.core.QueryResultsI query(BOQuery _eq)
```
    Description copied from interface: BOLoaderI
    
    query objects in an iterative way to hide backend processing time.
    
    Specified by:
    
    query in interface BOLoaderI
    
    Parameters:
    
    _eq - the query to fetch, written in OQL
    
    Returns:
    
    QueryResults iterator through the query results.
  - queryBO
```
public java.util.List<BO> queryBO(java.lang.String query)
```
    Description copied from interface: BOLoaderI
    
    wrapper for queryBO(String, Object[0])
    
    Specified by:
    
    queryBO in interface BOLoaderI
    
    Specified by:
    
    queryBO in interface BOQueryLoaderI
    
    See Also:
    
    BOLoaderI.queryBO(String, Object[])
  - queryBO
```
public java.util.List<BO> queryBO(java.lang.String query,
                                  java.lang.Object[] pvals)
```
    Description copied from interface: BOLoaderI
    
    query objects and block until all objects are transferred, returns Objects as a List. If at all possible, use query() instead of this, as it's a resource hogger and rather slow - except if you need a complete and rather small set of objects in this or an equivalent form and no further processing.
    
    Specified by:
    
    queryBO in interface BOLoaderI
    
    Specified by:
    
    queryBO in interface BOQueryLoaderI
    
    Specified by:
    
    queryBO in interface GrooqlBOLoaderI
    
    Parameters:
    
    query - the query to fetch, written in OQL
    
    pvals - an object array corresponding with $n entries, $1 is pvals[0] and so forth. Must not be null.
    
    Returns:
    
    List with the requested objects.
    
    See Also:
    
    BOLoaderI.query(String, Object[])
  - parseQueryAndFetchBOs
```
public java.util.List<BO> parseQueryAndFetchBOs(java.lang.String query)
```
    Try to parse and anwser this query (generic method).
  - parseQueryAndFetchBOs
```
public java.util.List<BO> parseQueryAndFetchBOs(java.lang.String query,
                                                java.lang.Object[] pvals)
```
  - queryBO
```
public java.util.List queryBO(BOQuery _eq)
```
    Description copied from interface: BOLoaderI
    
    query objects and block until all objects are transferred, returns Objects as a List.
    
    Specified by:
    
    queryBO in interface BOLoaderI
    
    Parameters:
    
    _eq - the query to fetch, written in OQL
    
    Returns:
    
    List with the requested objects.
  - frapFromCache
```
public BO frapFromCache(BO bo)
```
    Description copied from interface: BOLoaderI
    
    Put a BO instance to further use in this BOLoader, cloning it in case it's unknown, giving back a cached instance in case it's cached, in any way returning an instance without making further reloads (which would make the effort of caching it useless).
    
    Specified by:
    
    frapFromCache in interface BOLoaderI
  - getRootLoader
```
public BOLoaderI getRootLoader()
```
    Description copied from interface: BOLoaderI
    
    Returns the root BOLoader of this BOLoader or this if there is no more parent loader.
    
    Specified by:
    
    getRootLoader in interface BOLoaderI
  - prepareQuery
```
public BatchedBackendRequestI prepareQuery(java.lang.String s,
                                           java.lang.Object[] o)
```
    Specified by:
    
    prepareQuery in interface BOLoaderI
  - prepareQuery
```
public BatchedBackendRequestI prepareQuery(java.lang.String s)
```
    Specified by:
    
    prepareQuery in interface BOLoaderI
  - execute
```
public void execute(BatchedBackendRequestI[] srs)
```
    Specified by:
    
    execute in interface BOLoaderI
  - getCryptoHandler
```
public CryptoHandlerI getCryptoHandler()
```
    Description copied from interface: BOLoaderI
    
    get a reference to the CryptoHandler used. On the server side, this will be a a ServerCryptoHandler, on the client side a ClientCryptoHandler. The main difference between these two is that the server side can calculate hashes, whereas the client side cannot.
    
    Specified by:
    
    getCryptoHandler in interface BOLoaderI
    
    Returns:
    
    the cryptohandler used by this BOLoader instance.
  - addQueryInterceptor
```
public void addQueryInterceptor(java.lang.String query,
                                TestQueryInterceptorI qi)
```
    Adds a Queryinterceptor to this BOLoader, which allows to explicitly execute certain code to calculate the response to this query. There is no check for the validity of the query. The Interceptors are registered on the order of arrival, i.e. later Interceptors for the same query replace existing ones.
    
    Parameters:
    
    query - the exact query that should be intercepted, nonnull (unique)
    
    qi - the interceptor that handles this query, nonnull.
  - removeQueryInterceptor
```
public TestQueryInterceptorI removeQueryInterceptor(java.lang.String query)
```
    Removes the Interceptor that handles this query from the list of possible Interceptors and returns it.
    
    Parameters:
    
    query - the query that should no longer be intercepted, nonnull
    
    Returns:
    
    the Interceptor that handled this query or null, if none were registered yet.
  - getFileVault
```
public FileVaultI getFileVault()
```
    Specified by:
    
    getFileVault in interface BOLoaderI
  - clearQueryInterceptors
```
public void clearQueryInterceptors()
```
    Clears the list of interceptable Queries
  - createExpiringToken
```
public void createExpiringToken(java.lang.String serviceName,
                                java.lang.String tokenName,
                                byte[] value,
                                long expiryms)
```
    ExpiringTokenStorageProviderI (copy of the minimal code from DBMan)
    
    Specified by:
    
    createExpiringToken in interface ExpiringTokenStorageProviderI
    
    Parameters:
    
    serviceName - name (fqn) of the service who provided the value
    
    tokenName - name of the token variable which in conjunction with the service name provides a key to the value
    
    value - the actual value, as byte array
    
    expiryms - the time the value will be valid. After that time, the value is removed from the store
  - createExpiringToken
```
public java.lang.String createExpiringToken(java.lang.String serviceName,
                                            byte[] value,
                                            long expiryms)
```
    Description copied from interface: ExpiringTokenStorageProviderI
    
    Works like @see #createExpiringToken(String,String,byte[],long), but creates a non-conflicting tokenName within the store, stores the value and returns the chosen tokenName.
    
    Specified by:
    
    createExpiringToken in interface ExpiringTokenStorageProviderI
    
    Parameters:
    
    serviceName - name (fqn) of the service who provided the value
    
    value - the actual value, as byte array
    
    expiryms - the time the value will be valid. After that time, the value is removed from the store
    
    Returns:
    
    chosen, non-conflicting tokenName
  - retrieveExpiringToken
```
public byte[] retrieveExpiringToken(java.lang.String serviceName,
                                    java.lang.String tokenName)
```
    Description copied from interface: ExpiringTokenStorageProviderI
    
    Retrieves a time limited token
    
    Specified by:
    
    retrieveExpiringToken in interface ExpiringTokenStorageProviderI
    
    Parameters:
    
    serviceName - name (fqn) of the service who provided the value
    
    tokenName - name of the token variable which in conjunction with the service name provides a key to the value
    
    Returns:
    
    the token data as byte array
  - destroyExpiringToken
```
public byte[] destroyExpiringToken(java.lang.String serviceName,
                                   java.lang.String tokenName)
```
    Description copied from interface: ExpiringTokenStorageProviderI
    
    Destroys a time limited token immediately
    
    Specified by:
    
    destroyExpiringToken in interface ExpiringTokenStorageProviderI
    
    Parameters:
    
    serviceName - name (fqn) of the service who provided the value
    
    tokenName - name of the token variable which in conjunction with the service name provides a key to the value
    
    Returns:
    
    the former token data or null if there was nothing to destroy any more
  - hasBLOB
```
public boolean hasBLOB(java.lang.Long id)
```
    Specified by:
    
    hasBLOB in interface BLOBLoaderI
    
    Parameters:
    
    id - the id of the BO the check for existence of a BLOB on the server.
    
    Returns:
    
    true if a BLOB for the BO with the passed Id exists on the server.
  - hasBLOB
```
public boolean hasBLOB(java.lang.Long id,
                       java.lang.Long backuppingBPId)
```
    Specified by:
    
    hasBLOB in interface BLOBLoaderI
    
    Parameters:
    
    id - the id of the BO the check for existence of a BLOB on the server.
    
    backuppingBPId - instead of the current BLOB get the VFile for the backup-BLOB that was stored because of this BP-Id from the backup-dir
    
    Returns:
    
    true if a BLOB for the BO with the passed Id exists on the server.
  - getBLOB
```
public byte[] getBLOB(java.lang.Long boid)
```
    Description copied from interface: BLOBLoaderI
    
    get the BLOB belonging to BO[id]. Gives back a byte array of the BLOB.
    
    Specified by:
    
    getBLOB in interface BLOBLoaderI
    
    Parameters:
    
    boid - the id of the BO the BLOB belongs to.
    
    Returns:
    
    a byte array containing the data of the BLOB.
  - getBLOB
```
public byte[] getBLOB(java.lang.Long boid,
                      java.lang.Long backuppingBPId)
```
    Description copied from interface: BLOBLoaderI
    
    get the BLOB belonging to BO[id]. Gives back a byte array of the BLOB.
    
    Specified by:
    
    getBLOB in interface BLOBLoaderI
    
    Parameters:
    
    boid - the id of the BO the BLOB belongs to.
    
    backuppingBPId - instead of the current BLOB get and stream the backup-BLOB that was stored because of this BP-Id from the backup-dir
    
    Returns:
    
    a byte array containing the data of the BLOB.
  - getBLOBInfo
```
public VFile getBLOBInfo(java.lang.Long id)
```
    Description copied from interface: BLOBLoaderI
    
    gathers information about the BLOB belonging to BO[i].
    
    Specified by:
    
    getBLOBInfo in interface BLOBLoaderI
    
    Parameters:
    
    id - the id of the BO the BLOB-info belongs to.
    
    Returns:
    
    VFile object containing information about lastmodification and size.
  - getBLOBInfo
```
public VFile getBLOBInfo(java.lang.Long id,
                         java.lang.Long backuppingBPId)
```
    Description copied from interface: BLOBLoaderI
    
    gathers information about the BLOB belonging to BO[i].
    
    Specified by:
    
    getBLOBInfo in interface BLOBLoaderI
    
    Parameters:
    
    id - the id of the BO the BLOB-info belongs to.
    
    backuppingBPId - instead of the current BLOB get the VFile for the backup-BLOB that was stored because of this BP-Id from the backup-dir
    
    Returns:
    
    VFile object containing information about lastmodification and size.
  - getBLOB
```
public long getBLOB(java.lang.Long $22,
                    java.io.OutputStream $23)
```
    Description copied from interface: BLOBLoaderI
    
    Writes the BLOB belonging to BO[id] to the passed OutputStream. writes to the given OutputStream
    
    Specified by:
    
    getBLOB in interface BLOBLoaderI
    
    Parameters:
    
    $22 - the id of the BO the BLOB belongs to
    
    $23 - the OutputStream to write the BLOB-bytes to
    
    Returns:
    
    the written bytecount / length of BLOB
  - getBLOB
```
public long getBLOB(java.lang.Long $24,
                    java.io.OutputStream $25,
                    boolean $26)
```
    Description copied from interface: BLOBLoaderI
    
    Writes the BLOB belonging to BO[id] to the passed OutputStream. writes to the given OutputStream
    
    Specified by:
    
    getBLOB in interface BLOBLoaderI
    
    Parameters:
    
    $24 - the id of the BO the BLOB belongs to
    
    $25 - the OutputStream to write the BLOB-bytes to
    
    $26 - a boolean designating if the OutputStream shall be closed afterwards or not.
    
    Returns:
    
    the written bytecount / length of BLOB
  - getBLOB
```
public long getBLOB(java.lang.Long $27,
                    java.io.OutputStream $28,
                    boolean $29,
                    java.lang.Long $30)
```
    Description copied from interface: BLOBLoaderI
    
    Writes the BLOB belonging to BO[id] to the passed OutputStream. writes to the given OutputStream
    
    Specified by:
    
    getBLOB in interface BLOBLoaderI
    
    Parameters:
    
    $27 - the id of the BO the BLOB belongs to
    
    $28 - the OutputStream to write the BLOB-bytes to
    
    $29 - a boolean designating if the OutputStream shall be closed afterwards or not.
    
    $30 - instead of the current BLOB get and stream the backup-BLOB that was stored because of this BP-Id from the backup-dir
    
    Returns:
    
    the written bytecount / length of BLOB
  - getBLOB
```
public long getBLOB(java.lang.Long $31,
                    java.io.DataOutput $32)
```
    Description copied from interface: BLOBLoaderI
    
    Writes the BLOB belonging to BO[id] to the passed DataOutput. writes to the given DataOutput
    
    Specified by:
    
    getBLOB in interface BLOBLoaderI
    
    Parameters:
    
    $31 - the id of the BO the BLOB belongs to
    
    $32 - the DataOutput to write the BLOB-bytes to
    
    Returns:
    
    the written bytecount / length of BLOB
  - getBLOB
```
public long getBLOB(java.lang.Long $33,
                    java.io.DataOutput $34,
                    boolean $35)
```
    Description copied from interface: BLOBLoaderI
    
    Writes the BLOB belonging to BO[id] to the passed DataOutput. writes to the given DataOutput
    
    Specified by:
    
    getBLOB in interface BLOBLoaderI
    
    Parameters:
    
    $33 - the id of the BO the BLOB belongs to
    
    $34 - the DataOutput to write the BLOB-bytes to
    
    $35 - a boolean designating if the DataOutput shall be closed afterwards or not.
    
    Returns:
    
    the written bytecount / length of BLOB
  - getBLOB
```
public long getBLOB(java.lang.Long $36,
                    java.io.DataOutput $37,
                    boolean $38,
                    java.lang.Long $39)
```
    Description copied from interface: BLOBLoaderI
    
    Writes the BLOB belonging to BO[id] to the passed DataOutput. writes to the given DataOutput
    
    Specified by:
    
    getBLOB in interface BLOBLoaderI
    
    Parameters:
    
    $36 - the id of the BO the BLOB belongs to
    
    $37 - the DataOutput to write the BLOB-bytes to
    
    $38 - a boolean designating if the DataOutput shall be closed afterwards or not.
    
    $39 - instead of the current BLOB get and stream the backup-BLOB that was stored because of this BP-Id from the backup-dir
    
    Returns:
    
    the written bytecount / length of BLOB
  - isLoggedIn
```
public java.lang.Boolean isLoggedIn(Benutzer $40)
```
    Description copied from interface: BOLoaderI
    
    Tells if the given Benutzer is currently logged in.
    
    Specified by:
    
    isLoggedIn in interface BOLoaderI
    
    Parameters:
    
    $40 - the Benutzer for which the logged in state should be checked
    
    Returns:
    
    Boolean.TRUE if Benutzer is currently logged in, Boolean.FALSE if not and null if this info is not available
  - isLoggedInNN
```
public boolean isLoggedInNN(Benutzer $41)
```
    Description copied from interface: BOLoaderI
    
    Tells if the given Benutzer is currently logged in.
    
    Specified by:
    
    isLoggedInNN in interface BOLoaderI
    
    Parameters:
    
    $41 - the Benutzer for which the logged in state should be checked
    
    Returns:
    
    true if Benutzer is currently logged in, false if not or if this info is not available
  - exists
```
public boolean exists(java.lang.Long $42,
                      java.lang.Class<? extends BOI> $43)
```
    Description copied from interface: BOLoaderI
    
    Returns true if a BO with the given id exists. The class tip is just what the name suggests, just a tip and will only have performance consequences if wrong or null.
    
    Specified by:
    
    exists in interface BOLoaderI
    
    Parameters:
    
    $42 - the id of the BO
    
    $43 - a guess which class the object has. May be null.
    
    Returns:
    
    true if a BO with the given id exists
  - exists
```
public boolean exists(java.lang.Long $44)
```
    Description copied from interface: BOLoaderI
    
    wrapper for exists(id, null).
    
    Specified by:
    
    exists in interface BOLoaderI
    
    See Also:
    
    BOLoaderI.exists(Long, Class)
  - testAuth
```
public java.lang.Long testAuth(Anmeldung $45)
```
    Description copied from interface: BOLoaderI
    
    Tests wether given credentials can be verified. Returns long denoting the internal BO object in case the verification succeeded.
    
    Specified by:
    
    testAuth in interface BOLoaderI
    
    Returns:
    
    Long id of the Benutzer object in case the verification succeeded, null otherwise (aside a server-dependent lag).
  - testAuth
```
public boolean testAuth(de.ipcon.db.core.PasswortUeberpruefung $46)
```
    Description copied from interface: BOLoaderI
    
    Tests wether given credentials can be verified. Returns true in case the verification succeeded.
    
    Specified by:
    
    testAuth in interface BOLoaderI
    
    Returns:
    
    true in case the verification succeeded, false otherwise.
  - getBOT
```
public BOT getBOT(java.lang.Class<? extends BOI> $47)
```
    Specified by:
    
    getBOT in interface BOLoaderI
  - queryRelation
```
public de.ipcon.db.core.QueryResultsI queryRelation(long $48,
                                                    java.lang.Class<? extends BOI> $49,
                                                    java.lang.String $50)
```
    Description copied from interface: BOLoaderI
    
    does the same as @see #getRelationBOs, but returns a QueryResultsI like @see #query.
    
    Specified by:
    
    queryRelation in interface BOLoaderI
  - isCaching
```
public boolean isCaching()
```
    Description copied from interface: BOLoaderI
    
    If true, then this BOLoaderI uses an internal cache, holding all BOs hat were loaded or frapped into it. In this case, the BOLoader should not be expected to handle automatic cache eviction (some might). A BOLoader that is caching can be expected to deduplicate BOs with the same Id from different sources to create a stable, self contained BO graph. Caching BOLoaders should not be expected to always hold the most up to date version of a BO, even after frapping a newer BO with it, i.e. an already cached BO is might always be preferred. If false, then this BOLoader will not hold references to loaded BOs, allowing them to be garbage collected as soon as they're no longer referenced outside of this class. As a result, this Interface makes no guarantees regarding deduplication of BOs in the returned graph.
    
    Specified by:
    
    isCaching in interface BOLoaderI
    
    Returns:
    
    true if this BOLoaderI uses a cache, false if loaded BOs aren't cached.
  - isRecording
```
public boolean isRecording()
```
    Description copied from interface: BOLoaderI
    
    Returns true if this BOLoaderI records changes.
    
    Specified by:
    
    isRecording in interface BOLoaderI
  - getFeatureManager
```
public FeatureManagerI getFeatureManager()
```
    Specified by:
    
    getFeatureManager in interface BOLoaderI
  - getParentLoader
```
public BOLoaderI getParentLoader()
```
    Description copied from interface: BOLoaderI
    
    returns the BOLoader which this BOLoader uses to load its objects. If this is a Root BOLoader, then null is returned.
    
    Specified by:
    
    getParentLoader in interface BOLoaderI
  - drain
```
public void drain()
```
    Description copied from interface: BOLoaderI
    
    If this BOLoader has a cache, we request it to empty it. The BOLoader should make every effort to keep valuable data though, but objects not "nailed" (=included in a transaction) should be reloaded or removed from the cache so that a further request will fetch them again. If BOLoaderI.isCaching() returns false, this is a nop.
    
    Specified by:
    
    drain in interface BOLoaderI
  - getEventProvider
```
public DBManEventProviderI getEventProvider()
```
    Description copied from interface: BOLoaderI
    
    Returns the DBManEventProviderI of this BOLoader, if any.
    
    Specified by:
    
    getEventProvider in interface BOLoaderI
  - getSchema
```
public SchemaI getSchema()
```
    Description copied from interface: BOLoaderI
    
    gets a reference to the schema which is used by this BOLoader. Within the schema, you can find methods to set/get values, gather information about available entities and their attributes and many other things, too.
    
    Specified by:
    
    getSchema in interface BOLoaderI
    
    Specified by:
    
    getSchema in interface SchemaProviderI
    
    Returns:
    
    the schema of this BOLoader instance.
  - setSchema
```
public void setSchema(SchemaI $51)
```
  - getTx
```
public TestTransaction getTx()
```
  - setTx
```
public void setTx(TestTransaction $52)
```
  - getTraceQueryOnEntity
```
public java.lang.String getTraceQueryOnEntity()
```
  - setTraceQueryOnEntity
```
public void setTraceQueryOnEntity(java.lang.String $53)
```

Class TestBOLoader

Nested Class Summary

Nested classes/interfaces inherited from interface de.ipcon.db.core.BOQueryLoaderI

Field Summary

Fields inherited from interface de.ipcon.db.core.BOLoaderI

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface de.ipcon.db.core.BOLoaderI

Methods inherited from interface de.ipcon.db.blob.BLOBLoaderI

Methods inherited from interface de.ipcon.db.core.BOQueryLoaderI

Constructor Detail

TestBOLoader

TestBOLoader

Method Detail

main

isTesting

injectAdditionalPersistentBOs

of

loadSchema

getNextId

createTransaction

createTransaction

createTransaction

createTransactionWithInitialDataFor

createTransactionDescWithInitialDataFor

createInstrumentedTransaction

createInstrumentedTransaction

createInstrumentedTransaction

getBO

getBO

getBOs

getBOs

getBOs

getBOs

getBOUncached

getBOUncached

getRelationBOs

query

query

query

queryBO

queryBO

parseQueryAndFetchBOs

parseQueryAndFetchBOs

queryBO

frapFromCache

getRootLoader

prepareQuery

prepareQuery

execute

getCryptoHandler

addQueryInterceptor

removeQueryInterceptor

getFileVault

clearQueryInterceptors

createExpiringToken

createExpiringToken

retrieveExpiringToken

destroyExpiringToken

hasBLOB

hasBLOB

getBLOB

getBLOB

getBLOBInfo

getBLOBInfo

getBLOB

getBLOB

getBLOB

getBLOB

getBLOB

getBLOB

isLoggedIn

isLoggedInNN

exists

exists

testAuth

testAuth

getBOT

queryRelation