Package org.cyclos.impl.system

Interface ScriptHelper

public interface ScriptHelper

Helper for script execution

Method Summary

Modifier and Type	Method	Description
void	addOnAfterEnd(Consumer<Boolean> callback)	Adds a listener to be executed when the main transaction ends, regardless of success or failure.
void	addOnAfterEndTransactional(Consumer<Boolean> callback)	Adds a listener to be executed when the main transaction ends, regardless of success or failure.
void	addOnBeforeEnd(Runnable callback)	Adds a listener to be executed right before the current transaction ends.
void	addOnCommit(Runnable callback)	Adds a listener to be executed when the main read-write transaction commits.
void	addOnCommitTransactional(Runnable callback)	Adds a listener to be executed when the main read-write transaction commits.
void	addOnRollback(Runnable callback)	Adds a listener to be executed when the main read-write transaction is rolled-back.
void	addOnRollbackTransactional(Runnable callback)	Adds a listener to be executed when the main read-write transaction is rolled-back.
<T> T	bean(Class<T> beanType)	Returns a component by type
Object	bean(String name)	Returns a component by short name.
ApplicationContext	getApplicationContext()	Returns the Spring application context
Map<String,Object>	getBeanMap()	Returns a Map with all beans accessible by bean(String)
ConcurrentMap<String,Object>	getGlobals()	Returns the globals map
Long	maskId(Object id)	Returns a value suitable to be sent to clients, which represents the given entity identifier
<T> long	processBatch(Iterable<T> iterable, Consumer<T> closure)	See QueryHelper.processBatch(BaseEntityManagerHandler, Iterator, Consumer)
<T> long	processBatch(Iterator<T> iterator, Consumer<T> closure)	See QueryHelper.processBatch(BaseEntityManagerHandler, Iterator, Consumer)
Long	unmaskId(Object id)	Returns a value suitable to be used on server side, given the argument is a masked identifier
Map<String,Object>	wrap(Object object)	Wraps an object in a Map, providing access to object properties as map keys.
Map<String,Object>	wrap(Object object, Collection<? extends CustomField<?,?,?>> customFields)	Same as wrap(Object), but providing an explicit custom fields collection, instead of trying to get from the object.

Method Detail

addOnAfterEnd

void addOnAfterEnd(Consumer<Boolean> callback)

Adds a listener to be executed when the main transaction ends, regardless of success or failure. The listener itself runs outside a transaction. The given callback receives a Boolean object, which can be:

• true: The current read-write transaction was committed;
• false: The current read-write transaction was rolled-back;
• null: The current read-only transaction has ended.

addOnAfterEndTransactional

void addOnAfterEndTransactional(Consumer<Boolean> callback)

Adds a listener to be executed when the main transaction ends, regardless of success or failure. The listener itself runs in a new read-write transaction. The given callback receives a Boolean object, which can be:

• true: The current read-write transaction was committed;
• false: The current read-write transaction was rolled-back;
• null: The current read-only transaction has ended.

addOnBeforeEnd

void addOnBeforeEnd(Runnable callback)

Adds a listener to be executed right before the current transaction ends. The listener runs in the current transaction.

addOnCommit

void addOnCommit(Runnable callback)

Adds a listener to be executed when the main read-write transaction commits. The listener itself runs outside a transaction. If called in a read-only transaction, an exception is thrown.

addOnCommitTransactional

void addOnCommitTransactional(Runnable callback)

Adds a listener to be executed when the main read-write transaction commits. The listener itself runs in a new read-write transaction. If called in a read-only transaction, an exception is thrown.

addOnRollback

void addOnRollback(Runnable callback)

Adds a listener to be executed when the main read-write transaction is rolled-back. The listener itself runs outside a transaction. If called in a read-only transaction, an exception is thrown.

addOnRollbackTransactional

void addOnRollbackTransactional(Runnable callback)

Adds a listener to be executed when the main read-write transaction is rolled-back. The listener itself runs in a new read-write transaction. If called in a read-only transaction, an exception is thrown.

bean

<T> T bean(Class<T> beanType)

Returns a component by type

bean

Object bean(String name)

Returns a component by short name. For example, userService returns the UserServiceLocal, invokerHandler returns InvokerHandler and so on.

getApplicationContext

ApplicationContext getApplicationContext()

Returns the Spring application context

getBeanMap

Map<String,Object> getBeanMap()

Returns a Map with all beans accessible by bean(String)

getGlobals

ConcurrentMap<String,Object> getGlobals()

Returns the globals map

maskId

Long maskId(Object id)

Returns a value suitable to be sent to clients, which represents the given entity identifier

processBatch

<T> long processBatch(Iterable<T> iterable,
                      Consumer<T> closure)

See QueryHelper.processBatch(BaseEntityManagerHandler, Iterator, Consumer)

processBatch

<T> long processBatch(Iterator<T> iterator,
                      Consumer<T> closure)

See QueryHelper.processBatch(BaseEntityManagerHandler, Iterator, Consumer)

unmaskId

Long unmaskId(Object id)

Returns a value suitable to be used on server side, given the argument is a masked identifier

wrap

Map<String,Object> wrap(Object object)

Wraps an object in a Map, providing access to object properties as map keys. For objects with custom fields (that implement either ModelWithCustomValues or EntityWithCustomValues), custom fields can be accessed via the field internal name. So, for example, for a user, user.gender would return the CustomFieldPossibleValue, assuming it is an enumerated custom field.

wrap

Map<String,Object> wrap(Object object,
                              Collection<? extends CustomField<?,?,?>> customFields)

Same as wrap(Object), but providing an explicit custom fields collection, instead of trying to get from the object. Is useful, for example, when creating a new entity / DTO, when it doesn't yet have a list of custom values