Skip navigation links

com.bea.wlevs.configuration
Interface Prepare

public interface Prepare

extends java.lang.annotation.Annotation

Indicates that a method is used to inject a stage with its configuration object during the prepare phase of a configuration update. The method will also be invoked when the stage is initialized after static dependencies have been injected. The annotated method must have a single parameter whose type is the type, or a supertype, of the configuration object that is injected. The return type of the method must be void. Only a single method on a class may be annotated with the Prepare annotation, however, both a superclass and its subclass may be annotated. In this case, the superclass method will be invoked before invoking the subclass method.

The Java type of the configuration object passed to the Prepare method is determined by JAXB. By default, the Java class name is the same as the name of the XML Schema complex type that describes the configuration data for the stage. See the wlevs_application_config.xsd for more detail.

Code example:

 @Prepare
 public void prepareConfig(MyAdapterConfig config) throws Exception {
    ...
 }
 

The purpose of the Prepare callback is to validate the configuration data and do any work necessary to ensure that the Activate callback will succeed. If the Prepare method detects that the configuration data is invalid it must throw a RuntimeException after performing any necessary cleanup. Following an unsuccessful invocation, the prepare method may be called again if additional configuration updates are attempted while the application is running.

Methods inherited from interface java.lang.annotation.Annotation

annotationType, equals, hashCode, toString