info.soaj.world.plugin
Class SjPluginWorld

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

All Implemented Interfaces:

java.io.Serializable

public class SjPluginWorld
extends SjAbstractPluginHelloWorld

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 java.lang.String	CLASS_NAME Class name.
private static long	serialVersionUID UID

Constructor Summary

SjPluginWorld(SjPopulatedPluginKey populatedPluginKey)
Constructor - protected

Method Summary

SjBaseMetadata	createPluginMetadataCB() This method
java.lang.String	echo() This method returns text defined in a descriptor document.
boolean	echo(java.lang.String greeting) This method returns the text defined in the parameter.
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

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

CLASS_NAME

private static final java.lang.String CLASS_NAME

Class name.

Constructor Detail

SjPluginWorld

public SjPluginWorld(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

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 SjAbstractPluginHelloWorld

Returns:

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

echo

public boolean echo(java.lang.String greeting)

Description copied from class: SjAbstractPluginHelloWorld

This method returns the text defined in the parameter.

Specified by:

echo in class SjAbstractPluginHelloWorld

Parameters:

greeting -

Returns:

boolean

See Also:

SjAbstractPluginHelloWorld.echo(String greeting)

echo

public java.lang.String echo()

Description copied from class: SjAbstractPluginHelloWorld

This method returns text defined in a descriptor document.

Specified by:

echo in class SjAbstractPluginHelloWorld

Returns:

String

See Also:

SjAbstractPluginHelloWorld.echo()

throwException

public void throwException()

Description copied from class: SjAbstractPluginHelloWorld

This method throws an exception.

Specified by:

throwException in class SjAbstractPluginHelloWorld

See Also:

SjAbstractPluginHelloWorld.throwException()