info.soaj.world.plugin
Class SjAbstractPluginHelloWorld

java.lang.Object
  info.soaj.core.plugin.SjBasePlugin
      info.soaj.world.plugin.SjAbstractPluginHelloWorld

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

SjPluginWorld

public abstract class SjAbstractPluginHelloWorld
extends SjBasePlugin

This SOAj plugin supports 'hello worlding'.

See SjBasePlugin for plugin pattern details.

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

Since:

v. 1.2

Author:

MarvinToll@gtcGroup.com

See Also:

Serialized Form

Field Summary

private static long

serialVersionUID UID

Constructor Summary

protected

SjAbstractPluginHelloWorld(SjPopulatedPluginKey populatedPluginKey) Constructor - protected

Method Summary

abstract java.lang.String	echo() This method returns text defined in a descriptor document.
abstract boolean	echo(java.lang.String greeting) This method returns the text defined in the parameter.
abstract void	throwException() This method throws an exception.
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

createPluginMetadataCB, 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

SjAbstractPluginHelloWorld

protected SjAbstractPluginHelloWorld(SjPopulatedPluginKey populatedPluginKey)

Constructor - protected

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

Parameters:

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

Method Detail

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"!

echo

public abstract boolean echo(java.lang.String greeting)

This method returns the text defined in the parameter.

Parameters:

greeting -

Returns:

boolean

echo

public abstract java.lang.String echo()

This method returns text defined in a descriptor document.

Returns:

String

throwException

public abstract void throwException()

This method throws an exception.