com.actional.soapstation.plugin.inproc

Interface IInit

All Known Implementing Classes:

PluginBase

public interface IInit

This is an optional interface that an in-process plugin must implement to be notified when it is about to be used as well as for getting a hold of its settings.
The life cycle management rules are the following.

RUN time

• Plug-in interceptors instances are created the first time they are needed and cached for subsequent usage if they are flagged as cacheable (com.actional.classloader.LoadableClassDefinition.isMgrCachable = true).
• The application calls com.actional.soapstation.plugin.inproc.IInit.destroy(IDestroyContext) when the plug-in instance is no longer used. Therefore, this method is no longer deprecated.
  Changing a plug-in declaration (through updating any subclass of com.actional.soapstation.db.JavaPluginLC or com.actional.soapstation.db.JavaPluginInstance) or its class loader (com.actional.classloader.DynamicClassLoaderEnvironment) causes the plug-in to be released, in which case com.actional.soapstation.plugin.inproc.IInit.destroy(IDestroyContext) is invoked. com.actional.soapstation.plugin.inproc.IInit.destroy(IDestroyContext) is only invoked for plug-ins that are declared as cacheable (com.actional.classloader.LoadableClassDefinition.isMgrCachable = true).

CONFIGURATION time

The following states how plug-ins should be developed to properly behave during configuration. The life cycle of plug-ins instances does NOT follow the rules listed above. Therefore, it is highly suggested that plug-in DO NOT create in com.actional.soapstation.plugin.inproc.IInit.init(IInitContext) resources that must be explicitly released. Instead, such resources SHOULD be created on demand (and probably cached for subsequent usage) in com.actional.soapstation.plugin.inproc.IInterceptor.invoke(IInvokeContext).

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IInit.IDestroyContext
static interface	IInit.IInitContext

Method Summary

Modifier and Type	Method and Description
void	destroy(IInit.IDestroyContext ctx) This method is called by the host application when the instance of the plug-in is released
void	init(IInit.IInitContext ctx) This method is called by the host application to initialize this instance of the plugin.

Method Detail

init

void init(IInit.IInitContext ctx)
   throws java.lang.Exception

This method is called by the host application to initialize this instance of the plugin.
If the validation of prerequisites is requested, the plug-in should validate any potential dependencies on classes, environments or other plug-ins and throw an exception if a problem is encountered.

Throws:

java.lang.Exception

destroy

void destroy(IInit.IDestroyContext ctx)
      throws java.lang.Exception

This method is called by the host application when the instance of the plug-in is released.

Throws:

java.lang.Exception