Package org.cyclos.impl.system

Class ScriptHelperImpl

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.impl.BaseNetworkedHandlerImpl

org.cyclos.impl.system.ScriptHelperImpl

All Implemented Interfaces:

ScriptHelper

@Component
public class ScriptHelperImpl
extends BaseNetworkedHandlerImpl
implements ScriptHelper

Implementation for ScriptHelper

Field Summary

Fields inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

authHandler, conversionHandler, customFieldValueHandler, entityManagerHandler, groupsHandler, productsHandler, restBeanPropertyMapping, userLocatorHandler

Fields inherited from class org.cyclos.impl.AbstractServerComponent

accountHandler, configurationHandler, dataTranslationHandler, notificationHandler, transactionHandler, translationHandler

Constructor Summary

Constructors

Constructor	Description
ScriptHelperImpl()

Method Summary

Modifier and Type	Method	Description
void	addOnCommit(Runnable runnable)	Adds a listener to be executed when the main transaction commits, which is not executed in a database transaction
void	addOnCommitTransactional(Runnable runnable)	Adds a listener to be executed when the main transaction commits, which is executed inside a new transaction
void	addOnRollback(Runnable runnable)	Adds a listener to be executed when the main transaction rollbacks, which is not executed in a database transaction
void	addOnRollbackTransactional(Runnable runnable)	Adds a listener to be executed when the main transaction is rolled-back, which is executed inside a new transaction
<T> T	bean(Class<T> beanType)	Returns a bean by type
Object	bean(String name)	Returns a bean by short name.
ApplicationContext	getApplicationContext()	Returns the Spring application context
Map<String,Object>	getBeanMap()	Returns a Map with all beans accessible by ScriptHelper.bean(String)
void	initialize()
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(CloseableIterator, Consumer, BaseEntityManagerHandler)
<T> long	processBatch(Iterator<T> iterator, Consumer<T> closure)	See QueryHelper#processBatch(CloseableIterator, Consumer, BaseEntityManagerHandler)
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 ScriptHelper.wrap(Object), but providing an explicit custom fields collection, instead of trying to get from the object.

Methods inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

canManage, checkManagesUser, checkPermission, checkRelatesToUser, checkValue, clearAlreadyValidated, getBaseEntityManagerHandler, getConfiguration, getLoggedBasicUser, getLoggedUser, getProducts, getTranslatedName, getTranslatedValue, hasPermission, hasValue, inSameNetwork, inSameNetworkOrGlobal, isAdmin, isAlreadyValidated, isBroker, isGlobalAdmin, isGlobalAdminInNetwork, isGuest, isLoggedIn, isMember, isMemberOnly, isNetworkAdmin, isOperator, isRelatedToUser, isSystem, isUserManager, isUserManagerOf, message, message, permission, permission, permissionOptionalValue, permissionOptionalValue, setAlreadyValidated, toDate, toDateTime, validate

Methods inherited from class org.cyclos.impl.AbstractServerComponent

dataTranslationProxy, dataTranslationProxy, delete, detach, doDataTranslationProxy, find, flush, from, getFormatter, getFormatter, getFormatter, getLogger, getRemoteAddress, getSessionData, mailContentBuilder, message, message, persist, refresh, remove, selectFrom, subQuery, update

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptHelperImpl

public ScriptHelperImpl()

Method Detail

addOnCommit

public void addOnCommit(Runnable runnable)

Description copied from interface: ScriptHelper

Adds a listener to be executed when the main transaction commits, which is not executed in a database transaction

Specified by:

addOnCommit in interface ScriptHelper

addOnCommitTransactional

public void addOnCommitTransactional(Runnable runnable)

Description copied from interface: ScriptHelper

Adds a listener to be executed when the main transaction commits, which is executed inside a new transaction

Specified by:

addOnCommitTransactional in interface ScriptHelper

addOnRollback

public void addOnRollback(Runnable runnable)

Description copied from interface: ScriptHelper

Adds a listener to be executed when the main transaction rollbacks, which is not executed in a database transaction

Specified by:

addOnRollback in interface ScriptHelper

addOnRollbackTransactional

public void addOnRollbackTransactional(Runnable runnable)

Description copied from interface: ScriptHelper

Adds a listener to be executed when the main transaction is rolled-back, which is executed inside a new transaction

Specified by:

addOnRollbackTransactional in interface ScriptHelper

bean

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

Description copied from interface: ScriptHelper

Returns a bean by type

Specified by:

bean in interface ScriptHelper

bean

public Object bean(String name)

Description copied from interface: ScriptHelper

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

Specified by:

bean in interface ScriptHelper

getApplicationContext

public ApplicationContext getApplicationContext()

Description copied from interface: ScriptHelper

Returns the Spring application context

Specified by:

getApplicationContext in interface ScriptHelper

Overrides:

getApplicationContext in class AbstractServerComponent

getBeanMap

public Map<String,Object> getBeanMap()

Description copied from interface: ScriptHelper

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

Specified by:

getBeanMap in interface ScriptHelper

initialize

@PostConstruct
public void initialize()

maskId

public Long maskId(Object id)

Description copied from interface: ScriptHelper

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

Specified by:

maskId in interface ScriptHelper

processBatch

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

Description copied from class: AbstractServerComponent

See QueryHelper#processBatch(CloseableIterator, Consumer, BaseEntityManagerHandler)

Specified by:

processBatch in interface ScriptHelper

Overrides:

processBatch in class AbstractServerComponent

processBatch

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

Description copied from class: AbstractServerComponent

See QueryHelper#processBatch(CloseableIterator, Consumer, BaseEntityManagerHandler)

Specified by:

processBatch in interface ScriptHelper

Overrides:

processBatch in class AbstractServerComponent

unmaskId

public Long unmaskId(Object id)

Description copied from interface: ScriptHelper

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

Specified by:

unmaskId in interface ScriptHelper

wrap

public Map<String,Object> wrap(Object object)

Description copied from interface: ScriptHelper

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.

Specified by:

wrap in interface ScriptHelper

wrap

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

Description copied from interface: ScriptHelper

Same as ScriptHelper.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

Specified by:

wrap in interface ScriptHelper