Package org.bonitasoft.engine.classloader

Class ClassLoaderServiceImpl

java.lang.Object

org.bonitasoft.engine.classloader.ClassLoaderServiceImpl

All Implemented Interfaces:

ClassLoaderService, LifecycleService, PlatformLifecycleService

@Component("classLoaderService")
public class ClassLoaderServiceImpl
extends java.lang.Object
implements ClassLoaderService

Author:

Elias Ricken de Medeiros, Baptiste Mesta, Matthieu Chaffotte

Constructor Summary

Constructors

Constructor

Description

ClassLoaderServiceImpl(ParentClassLoaderResolver parentClassLoaderResolver, EventService eventService, PlatformDependencyService platformDependencyService, SessionAccessor sessionAccessor, UserTransactionService userTransactionService, BroadcastService broadcastService, org.bonitasoft.engine.classloader.ClassLoaderUpdater classLoaderUpdater, java.util.List<PlatformClassLoaderListener> platformClassLoaderListeners)

Method Summary

Modifier and Type	Method	Description
boolean	addListener(ClassLoaderIdentifier identifier, SingleClassLoaderListener singleClassLoaderListener)	add listener on a classloader
BonitaClassLoader	getClassLoader(ClassLoaderIdentifier id)	Get the local ClassLoader for the given type and id.
BonitaClassLoader	getOrInitializeClassloader(ClassLoaderIdentifier id, java.util.function.Function<ClassLoaderIdentifier,BonitaClassLoader> createClassloaderFunction)
void	pause()	Temporary halt the execution of this service.
void	refreshClassLoaderAfterUpdate(ClassLoaderIdentifier identifier)
void	refreshClassLoaderImmediately(ClassLoaderIdentifier identifier)	This method refreshes in the current thread/transaction the classLoader with the given identifier.
void	refreshClassLoaderImmediatelyWithRollback(ClassLoaderIdentifier identifier)	This method refreshes in the current thread/transaction the classLoader with the given identifier.
void	refreshClassLoaderOnOtherNodes(ClassLoaderIdentifier identifier)
void	registerDependencyServiceOfTenant(java.lang.Long tenantId, TenantDependencyService tenantDependencyService)
boolean	removeListener(ClassLoaderIdentifier identifier, SingleClassLoaderListener singleClassLoaderListener)
void	removeLocalClassloader(ClassLoaderIdentifier identifier)
void	removeRefreshClassLoaderSynchronization()
void	resume()	resume the execution the service
void	start()	Start the service
void	stop()

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassLoaderServiceImpl

public ClassLoaderServiceImpl(ParentClassLoaderResolver parentClassLoaderResolver,
                              @Qualifier("platformEventService")
                              EventService eventService,
                              PlatformDependencyService platformDependencyService,
                              SessionAccessor sessionAccessor,
                              UserTransactionService userTransactionService,
                              BroadcastService broadcastService,
                              org.bonitasoft.engine.classloader.ClassLoaderUpdater classLoaderUpdater,
                              java.util.List<PlatformClassLoaderListener> platformClassLoaderListeners)

Method Detail

registerDependencyServiceOfTenant

public void registerDependencyServiceOfTenant(java.lang.Long tenantId,
                                              TenantDependencyService tenantDependencyService)

Specified by:

registerDependencyServiceOfTenant in interface ClassLoaderService

getClassLoader

public BonitaClassLoader getClassLoader(ClassLoaderIdentifier id)

Description copied from interface: ClassLoaderService

Get the local ClassLoader for the given type and id. If no ClassLoader already exists, a new one is created and initialized. This initialization is executed in a different thread/transaction. It eagerly initialize parent classloaders.

Specified by:

getClassLoader in interface ClassLoaderService

Parameters:

id - of the classloader to refresh

Returns:

the local ClassLoader for the given type and id

getOrInitializeClassloader

public BonitaClassLoader getOrInitializeClassloader(ClassLoaderIdentifier id,
                                                    java.util.function.Function<ClassLoaderIdentifier,BonitaClassLoader> createClassloaderFunction)

removeLocalClassloader

public void removeLocalClassloader(ClassLoaderIdentifier identifier)
                            throws SClassLoaderException

Specified by:

removeLocalClassloader in interface ClassLoaderService

Throws:

SClassLoaderException

start

public void start()

Description copied from interface: LifecycleService

Start the service

Specified by:

start in interface LifecycleService

stop

public void stop()

Specified by:

stop in interface LifecycleService

pause

public void pause()

Description copied from interface: LifecycleService

Temporary halt the execution of this service.

Specified by:

pause in interface LifecycleService

resume

public void resume()

Description copied from interface: LifecycleService

resume the execution the service

Specified by:

resume in interface LifecycleService

addListener

public boolean addListener(ClassLoaderIdentifier identifier,
                           SingleClassLoaderListener singleClassLoaderListener)

Description copied from interface: ClassLoaderService

add listener on a classloader

Specified by:

addListener in interface ClassLoaderService

Parameters:

identifier - the classloader id

singleClassLoaderListener - the listener to add

Returns:

true if the listener was added

removeListener

public boolean removeListener(ClassLoaderIdentifier identifier,
                              SingleClassLoaderListener singleClassLoaderListener)

Specified by:

removeListener in interface ClassLoaderService

Parameters:

identifier - the classloader id

singleClassLoaderListener - classloader listener to remove

Returns:

true if the listener was removed

refreshClassLoaderImmediatelyWithRollback

public void refreshClassLoaderImmediatelyWithRollback(ClassLoaderIdentifier identifier)
                                               throws SClassLoaderException

Description copied from interface: ClassLoaderService

This method refreshes in the current thread/transaction the classLoader with the given identifier. Contrary to refreshClassLoaderImmediately, it creates a synchronization that triggers a reload of the classloader in case the transaction was rolled back, insuring there is no new loaded class in the classloader after the rollback.

e.g. If the classloader was set as the current context classloader, it should be reset like this

  
 Thread.currentThread().setContextClassLoader(classLoaderService.getLocalClassLoader(identifier));
 
 

Specified by:

refreshClassLoaderImmediatelyWithRollback in interface ClassLoaderService

Parameters:

identifier - of the classloader to refresh

Throws:

SClassLoaderException

refreshClassLoaderImmediately

public void refreshClassLoaderImmediately(ClassLoaderIdentifier identifier)
                                   throws SClassLoaderException

Description copied from interface: ClassLoaderService

This method refreshes in the current thread/transaction the classLoader with the given identifier. It eagerly initializes parents classloaders.

A new classloader will be created. In order to use the new classloader, references to the old one should be updated.

e.g. If the classloader was set as the current context classloader, it should be reset like this

  
 Thread.currentThread().setContextClassLoader(classLoaderService.getLocalClassLoader(identifier));
 
 

Specified by:

refreshClassLoaderImmediately in interface ClassLoaderService

Parameters:

identifier - of the classloader to refresh

Throws:

SClassLoaderException

refreshClassLoaderAfterUpdate

public void refreshClassLoaderAfterUpdate(ClassLoaderIdentifier identifier)
                                   throws SClassLoaderException

Specified by:

refreshClassLoaderAfterUpdate in interface ClassLoaderService

Throws:

SClassLoaderException

refreshClassLoaderOnOtherNodes

public void refreshClassLoaderOnOtherNodes(ClassLoaderIdentifier identifier)
                                    throws SClassLoaderException

Specified by:

refreshClassLoaderOnOtherNodes in interface ClassLoaderService

Throws:

SClassLoaderException

removeRefreshClassLoaderSynchronization

public void removeRefreshClassLoaderSynchronization()

Specified by:

removeRefreshClassLoaderSynchronization in interface ClassLoaderService