info.soaj.core.plugin
Class SjPluginStartup

java.lang.Object
  info.soaj.core.plugin.SjBasePlugin
      info.soaj.core.plugin.SjPluginStartup

All Implemented Interfaces:

java.io.Serializable

public class SjPluginStartup
extends SjBasePlugin

This SOAj plugin supports declared core framework startup options.

Copyright (c) 2006 - 2009 by Global Technology Consulting Group, Inc. at gtcGroup.com .

Since:

v. 1.0

Author:

MarvinToll@gtcGroup.com

See Also:

Serialized Form

Field Summary

private static long

serialVersionUID UID

Constructor Summary

SjPluginStartup(SjPopulatedPluginKey pluginKey)
Constructor - protected

Method Summary

SjBaseMetadata	createPluginMetadataCB() This method
boolean	verifyCB() This callback method is invoked exactly once upon application server startup AFTER the initCB() methods complete successfully for ALL plugins.

Methods inherited from class info.soaj.core.plugin.SjBasePlugin

getPluginMetadata, getPluginProperties, getPopulatedPluginKey, initCB

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

UID

See Also:

Constant Field Values

Constructor Detail

SjPluginStartup

public SjPluginStartup(SjPopulatedPluginKey pluginKey)

Constructor - protected

The SOAj plugin pattern enforces instantiation of a plugin via the General Store. Concrete class constructors should be coded as 'protected'.

Parameters:

pluginKey - The 'Key' defined in the descriptor document.

Method Detail

createPluginMetadataCB

public SjBaseMetadata createPluginMetadataCB()

Description copied from class: SjBasePlugin

This method

Specified by:

createPluginMetadataCB in class SjBasePlugin

Returns:

SjBaseMetadata - The wrapper object containing plugin information.

See Also:

SjBasePlugin.createPluginMetadataCB()

verifyCB

public boolean verifyCB()

This callback method is invoked exactly once upon application server startup AFTER the initCB() methods complete successfully for ALL plugins. This method provides an opportunity for a onetime execution of verification logic to ensure the integrity (or fitness) of a plugin for use. As an example, a sophisticated implementation might fire all of the plugin methods (perhaps using mock objects) to ensure the plugin is 100% operational.

Overrides:

verifyCB in class SjBasePlugin

Returns:

boolean - 'True' indicates the plugin is "good to go"!