de.ipcon.db.testing

Class TestBOLoaderV2

java.lang.Object

de.ipcon.db.testing.TestBOLoaderV2

All Implemented Interfaces:

BLOBLoaderI, BOLoaderI, BOQueryLoaderI, ExpiringTokenStorageProviderI, TransactionBuilderI, TransactionProviderI, GrooqlBOLoaderI, SchemaProviderI, java.io.Serializable

public class TestBOLoaderV2
extends java.lang.Object
implements BOLoaderI, ExpiringTokenStorageProviderI, TransactionProviderI

A new version of TestBOLoader which tries to remedy that one's shortcomings: - if some functionality is not (yet) available throw exceptions instead of returning useless and misleading dummy results - by default be able to handle a much wider set of OQL queries by using the functionality from InterpretedOQLQuery - allow to use more than one transaction - always call verify* methods on saving, as in reality - try to adhere to the real API instead of a set of special test methods ("createTransaction", "simulateSave", etc.) - have the transactions get their BOs from the loader, as in reality, not the other way round - have the loader get its BOs from a simulated database BO collection, not from some single transaction's cache - add the initialdata to that simulated database, not as new BOs to some single transaction - initialdata is automatically loaded if and when it is needed; no more manually compiled class lists

See Also:

Serialized Form

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
TestBOLoaderV2(SchemaI _schema)
TestBOLoaderV2(SchemaI _schema, java.lang.Class[] initialdataClasses)
TestBOLoaderV2(SchemaI _schema, java.lang.Class[] initialdataClasses, BO[] _bosInDB)
TestBOLoaderV2(java.lang.String schemaPath)
TestBOLoaderV2(java.lang.String schemaPath, java.lang.Class[] initialdataClasses)
TestBOLoaderV2(java.lang.String schemaPath, java.lang.Class[] initialdataClasses, BO[] _bosInDB)

Method Summary

Modifier and Type	Method and Description
void	addQueryInterceptor(java.lang.String query, TestQueryInterceptorI qi) Deprecated. FIXME! TT 2024-04-11: This kludge should not be used, rather support for the required OQL constructs should be implemented in InterpretedOQLQuery
void	clearQueryInterceptors() Deprecated.
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) Creates a time limited association of the given service and token name to a byte array value (usually a key).
TestTransactionV2	createTransaction() Convenience method to create a TestTransactionV2 with default description.
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	dump() Outputs some info about the loader's state to STDERR.
void	dump(boolean listBOs)
void	execute(BatchedBackendRequestI[] srs)
boolean	exists(java.lang.Long id) wrapper for exists(id, null).
boolean	exists(java.lang.Long id, java.lang.Class classtip) Returns true if a BO with the given id exists.
static TestBOLoaderV2	forCore()
static TestBOLoaderV2	forCore(java.lang.Class[] initialdataClasses)
static TestBOLoaderV2	forCore(java.lang.Class[] initialdataClasses, BO[] _bosInDB)
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 id, java.io.DataOutput os) Writes the BLOB belonging to BO[id] to the passed DataOutput.
long	getBLOB(java.lang.Long id, java.io.DataOutput os, boolean closeOS) Writes the BLOB belonging to BO[id] to the passed DataOutput.
long	getBLOB(java.lang.Long id, java.io.DataOutput os, boolean closeOS, java.lang.Long backuppingBPId) 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 id, java.io.OutputStream os) Writes the BLOB belonging to BO[id] to the passed OutputStream.
long	getBLOB(java.lang.Long id, java.io.OutputStream os, boolean closeOS) Writes the BLOB belonging to BO[id] to the passed OutputStream.
long	getBLOB(java.lang.Long id, java.io.OutputStream os, boolean closeOS, java.lang.Long backuppingBPId) 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	getBO(java.lang.Long id, java.lang.Class<? extends BOI> classtip, boolean returnNullIfNotFound)
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 clazz)
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()
Transaction	getNewTransaction()
Transaction	getNewTransaction(java.lang.String desc)
Transaction	getNewTransaction(java.lang.String desc, TemporaryIdSupplierI tempIdSupplier)
Transaction	getNewTransaction(TemporaryIdSupplierI tempIdSupplier)
Transaction	getNewTransactionWithInstrumentedSchema()
Transaction	getNewTransactionWithInstrumentedSchema(java.lang.String desc)
Transaction	getNewTransactionWithInstrumentedSchema(java.lang.String desc, TemporaryIdSupplierI tempIdSupplier)
Transaction	getNewTransactionWithInstrumentedSchema(TemporaryIdSupplierI tempIdSupplier)
java.lang.Long	getNextId() get a unique Long id from the backend.
java.lang.Long	getNodeNumber()
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.
boolean	hasBLOB(java.lang.Long id)
boolean	hasBLOB(java.lang.Long id, java.lang.Long backuppingBPId)
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 user) Tells if the given Benutzer is currently logged in.
boolean	isLoggedInNN(Benutzer user) Tells if the given Benutzer is currently logged in.
boolean	isRecording() Returns true if this BOLoaderI records changes.
void	loadInitialdataFor(java.lang.Class clazz) Loads initialdata for the given class into the simulated DB Convenience frontend for the other loadInitialdataFor method.
void	loadInitialdataFor(java.lang.Class[] clazzes) Loads initialdata for the given classes into the simulated DB.
void	loadInitialdataFor(java.lang.Class[] clazzes, boolean setInitialdataFlag)
void	loadInitialdataFor(java.lang.Class clazz, boolean setInitialdataFlag)
static CBOSchema	loadSchema(java.lang.String schemaPath)
void	login(Benutzer user) "Logs in" the given Benutzer; isLoggedIn will return true after this for that user.
static TestBOLoaderV2	of(java.lang.String projectPath, java.lang.Class[] initialdataClasses)
static TestBOLoaderV2	of(java.lang.String projectPath, java.lang.Class[] initialdataClasses, BO[] _bosInDB)
BatchedBackendRequestI	prepareQuery(java.lang.String s)
BatchedBackendRequestI	prepareQuery(java.lang.String s, java.lang.Object[] o)
void	putIntoDB(BO bo) Puts the given BO into the simulated DB.
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 q) query objects and block until all objects are transferred, returns Objects as a List.
java.util.List	queryBO(java.lang.String query) wrapper for queryBO(String, Object[0])
java.util.List	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 id, java.lang.Class classtip, java.lang.String attributeName) does the same as @see #getRelationBOs, but returns a QueryResultsI like @see #query.
byte[]	retrieveExpiringToken(java.lang.String serviceName, java.lang.String tokenName) Retrieves a time limited token
TransactionAnswer	saveBO(Transaction tx) Persists the changes recorded in the passed transaction tx to the database.
TransactionAnswer	saveBO(Transaction tx, boolean ignoreConflicts)
void	setNodeNumber(java.lang.Long $39)
void	setSchema(SchemaI $38)
java.lang.Long	testAuth(Anmeldung a) Tests wether given credentials can be verified.
boolean	testAuth(de.ipcon.db.core.PasswortUeberpruefung a) 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, isTesting, 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

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

saveWithRetries, saveWithRetries

Constructor Detail

TestBOLoaderV2

public TestBOLoaderV2(java.lang.String schemaPath)

TestBOLoaderV2

public TestBOLoaderV2(java.lang.String schemaPath,
                      java.lang.Class[] initialdataClasses)

TestBOLoaderV2

public TestBOLoaderV2(java.lang.String schemaPath,
                      java.lang.Class[] initialdataClasses,
                      BO[] _bosInDB)

TestBOLoaderV2

public TestBOLoaderV2(SchemaI _schema)

TestBOLoaderV2

public TestBOLoaderV2(SchemaI _schema,
                      java.lang.Class[] initialdataClasses)

TestBOLoaderV2

public TestBOLoaderV2(SchemaI _schema,
                      java.lang.Class[] initialdataClasses,
                      BO[] _bosInDB)

Method Detail

loadSchema

public static CBOSchema loadSchema(java.lang.String schemaPath)

dump

public void dump()

Outputs some info about the loader's state to STDERR.

dump

public void dump(boolean listBOs)

of

public static TestBOLoaderV2 of(java.lang.String projectPath,
                                java.lang.Class[] initialdataClasses)

of

public static TestBOLoaderV2 of(java.lang.String projectPath,
                                java.lang.Class[] initialdataClasses,
                                BO[] _bosInDB)

forCore

public static TestBOLoaderV2 forCore()

forCore

public static TestBOLoaderV2 forCore(java.lang.Class[] initialdataClasses)

forCore

public static TestBOLoaderV2 forCore(java.lang.Class[] initialdataClasses,
                                     BO[] _bosInDB)

loadInitialdataFor

public void loadInitialdataFor(java.lang.Class clazz)

Loads initialdata for the given class into the simulated DB Convenience frontend for the other loadInitialdataFor method.

loadInitialdataFor

public void loadInitialdataFor(java.lang.Class clazz,
                               boolean setInitialdataFlag)

loadInitialdataFor

public void loadInitialdataFor(java.lang.Class[] clazzes)

Loads initialdata for the given classes into the simulated DB.

loadInitialdataFor

public void loadInitialdataFor(java.lang.Class[] clazzes,
                               boolean setInitialdataFlag)

putIntoDB

public void putIntoDB(BO bo)

Puts the given BO into the simulated DB.

getFeatureManager

public FeatureManagerI getFeatureManager()

Specified by:

getFeatureManager 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

@Deprecated
public void addQueryInterceptor(java.lang.String query,
                                            TestQueryInterceptorI qi)

Deprecated. FIXME! TT 2024-04-11: This kludge should not be used, rather support for the required OQL constructs should be implemented in InterpretedOQLQuery

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.

clearQueryInterceptors

@Deprecated
public void clearQueryInterceptors()

Deprecated.

Clears the list of interceptable Queries

getBOT

public BOT getBOT(java.lang.Class clazz)

Specified by:

getBOT in interface BOLoaderI

exists

public boolean exists(java.lang.Long id)

Description copied from interface: BOLoaderI

wrapper for exists(id, null).

Specified by:

exists in interface BOLoaderI

See Also:

BOLoaderI.exists(Long, Class)

exists

public boolean exists(java.lang.Long id,
                      java.lang.Class classtip)

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:

id - the id of the BO

classtip - a guess which class the object has. May be null.

Returns:

true if a BO with the given id exists

getBO

public BO getBO(java.lang.Long id)

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

See Also:

BOLoaderI.getBO(Long, Class)

getBO

public BO getBO(java.lang.Long id,
                java.lang.Class<? extends BOI> classtip)

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.

getBO

public BO getBO(java.lang.Long id,
                java.lang.Class<? extends BOI> classtip,
                boolean returnNullIfNotFound)

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)
                    throws ObjectNotFoundException

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.

Throws:

ObjectNotFoundException

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.

queryRelation

public de.ipcon.db.core.QueryResultsI queryRelation(long id,
                                                    java.lang.Class classtip,
                                                    java.lang.String attributeName)

Description copied from interface: BOLoaderI

does the same as @see #getRelationBOs, but returns a QueryResultsI like @see #query.

Specified by:

queryRelation in interface BOLoaderI

queryBO

public java.util.List queryBO(java.lang.String query)
                       throws java.lang.IllegalArgumentException

Description copied from interface: BOLoaderI

wrapper for queryBO(String, Object[0])

Specified by:

queryBO in interface BOLoaderI

Specified by:

queryBO in interface BOQueryLoaderI

Throws:

java.lang.IllegalArgumentException

See Also:

BOLoaderI.queryBO(String, Object[])

queryBO

public java.util.List queryBO(java.lang.String query,
                              java.lang.Object[] pvals)
                       throws java.lang.IllegalArgumentException

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.

Throws:

java.lang.IllegalArgumentException

See Also:

BOLoaderI.query(String, Object[])

queryBO

public java.util.List queryBO(BOQuery q)

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:

q - the query to fetch, written in OQL

Returns:

List with the requested objects.

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.

testAuth

public java.lang.Long testAuth(Anmeldung a)

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 a)

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.

prepareQuery

public BatchedBackendRequestI prepareQuery(java.lang.String s)

Specified by:

prepareQuery in interface BOLoaderI

prepareQuery

public BatchedBackendRequestI prepareQuery(java.lang.String s,
                                           java.lang.Object[] o)

Specified by:

prepareQuery in interface BOLoaderI

execute

public void execute(BatchedBackendRequestI[] srs)

Specified by:

execute in interface BOLoaderI

login

public void login(Benutzer user)

"Logs in" the given Benutzer; isLoggedIn will return true after this for that user.

Parameters:

user - the Benutzer that should be marked as "logged in"

isLoggedIn

public java.lang.Boolean isLoggedIn(Benutzer user)

Description copied from interface: BOLoaderI

Tells if the given Benutzer is currently logged in.

Specified by:

isLoggedIn in interface BOLoaderI

Parameters:

user - 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 user)

Description copied from interface: BOLoaderI

Tells if the given Benutzer is currently logged in.

Specified by:

isLoggedInNN in interface BOLoaderI

Parameters:

user - 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

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

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

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

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

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

getEventProvider

public DBManEventProviderI getEventProvider()

Description copied from interface: BOLoaderI

Returns the DBManEventProviderI of this BOLoader, if any.

Specified by:

getEventProvider in interface BOLoaderI

saveBO

public TransactionAnswer saveBO(Transaction tx)

Description copied from interface: TransactionProviderI

Persists the changes recorded in the passed transaction tx to the database.

Specified by:

saveBO in interface TransactionProviderI

Parameters:

tx - the Transaction to save

Returns:

the TransactionAnswer resulting from the save process, or null if no saving was actually done for some reason

saveBO

public TransactionAnswer saveBO(Transaction tx,
                                boolean ignoreConflicts)

Specified by:

saveBO in interface TransactionProviderI

createTransaction

public TestTransactionV2 createTransaction()

Convenience method to create a TestTransactionV2 with default description.

getNewTransaction

public Transaction getNewTransaction()

Specified by:

getNewTransaction in interface TransactionBuilderI

Returns:

a new Transaction-instance.

getNewTransaction

public Transaction getNewTransaction(TemporaryIdSupplierI tempIdSupplier)

Specified by:

getNewTransaction in interface TransactionBuilderI

Returns:

a new Transaction-instance, with a pre-set temporary id supplier, if not null.

getNewTransaction

public Transaction getNewTransaction(java.lang.String desc)

Specified by:

getNewTransaction in interface TransactionBuilderI

Returns:

a new Transaction-instance, with a pre-set description, if not null.

getNewTransaction

public Transaction getNewTransaction(java.lang.String desc,
                                     TemporaryIdSupplierI tempIdSupplier)

Specified by:

getNewTransaction in interface TransactionBuilderI

Returns:

a new Transaction-instance, with a pre-set description and a temporary id supplier, if not null.

getNewTransactionWithInstrumentedSchema

public Transaction getNewTransactionWithInstrumentedSchema()

Specified by:

getNewTransactionWithInstrumentedSchema in interface TransactionBuilderI

Returns:

a new Transaction-instance with an InstrumentedSchema.

getNewTransactionWithInstrumentedSchema

public Transaction getNewTransactionWithInstrumentedSchema(TemporaryIdSupplierI tempIdSupplier)

Specified by:

getNewTransactionWithInstrumentedSchema in interface TransactionBuilderI

Returns:

a new Transaction-instance with an InstrumentedSchema, with a pre-set temporary id supplier, if not null.

getNewTransactionWithInstrumentedSchema

public Transaction getNewTransactionWithInstrumentedSchema(java.lang.String desc)

Specified by:

getNewTransactionWithInstrumentedSchema in interface TransactionBuilderI

Returns:

a new Transaction-instance with an InstrumentedSchema, with a pre-set description, if not null.

getNewTransactionWithInstrumentedSchema

public Transaction getNewTransactionWithInstrumentedSchema(java.lang.String desc,
                                                           TemporaryIdSupplierI tempIdSupplier)

Specified by:

getNewTransactionWithInstrumentedSchema in interface TransactionBuilderI

Returns:

a new Transaction-instance with an InstrumentedSchema, with a pre-set description and a temporary id supplier, if not null.

getFileVault

public FileVaultI getFileVault()

Specified by:

getFileVault in interface BOLoaderI

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 id,
                    java.io.OutputStream os)

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:

id - the id of the BO the BLOB belongs to

os - the OutputStream to write the BLOB-bytes to

Returns:

the written bytecount / length of BLOB

getBLOB

public long getBLOB(java.lang.Long id,
                    java.io.OutputStream os,
                    boolean closeOS)

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:

id - the id of the BO the BLOB belongs to

os - the OutputStream to write the BLOB-bytes to

closeOS - 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 id,
                    java.io.OutputStream os,
                    boolean closeOS,
                    java.lang.Long backuppingBPId)

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:

id - the id of the BO the BLOB belongs to

os - the OutputStream to write the BLOB-bytes to

closeOS - a boolean designating if the OutputStream shall be closed afterwards or not.

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:

the written bytecount / length of BLOB

getBLOB

public long getBLOB(java.lang.Long id,
                    java.io.DataOutput os)

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:

id - the id of the BO the BLOB belongs to

os - the DataOutput to write the BLOB-bytes to

Returns:

the written bytecount / length of BLOB

getBLOB

public long getBLOB(java.lang.Long id,
                    java.io.DataOutput os,
                    boolean closeOS)

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:

id - the id of the BO the BLOB belongs to

os - the DataOutput to write the BLOB-bytes to

closeOS - 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 id,
                    java.io.DataOutput os,
                    boolean closeOS,
                    java.lang.Long backuppingBPId)

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:

id - the id of the BO the BLOB belongs to

os - the DataOutput to write the BLOB-bytes to

closeOS - a boolean designating if the DataOutput shall be closed afterwards or not.

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:

the written bytecount / length of BLOB

createExpiringToken

public void createExpiringToken(java.lang.String serviceName,
                                java.lang.String tokenName,
                                byte[] value,
                                long expiryms)

Description copied from interface: ExpiringTokenStorageProviderI

Creates a time limited association of the given service and token name to a byte array value (usually a key).

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

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 $38)

getNodeNumber

public java.lang.Long getNodeNumber()

setNodeNumber

public void setNodeNumber(java.lang.Long $39)