com.actional.soapstation.plugin.inproc

Class PluginBase

java.lang.Object

com.actional.soapstation.plugin.inproc.PluginBase

All Implemented Interfaces:

IInit, IPluginInfo

public class PluginBase
extends java.lang.Object
implements IPluginInfo, IInit

Base class to simplify the creation of plugins. It handles basic settings, preparation of XPaths, etc. This is the base class of GenericXmlProcessor, among others.

Nested Class Summary

Nested classes/interfaces inherited from interface com.actional.soapstation.plugin.inproc.IPluginInfo

IPluginInfo.IPluginInfoContext

Nested classes/interfaces inherited from interface com.actional.soapstation.plugin.inproc.IInit

IInit.IDestroyContext, IInit.IInitContext

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	itsKeyId The Key ID for this plugin.
protected org.w3c.dom.Element	itsSettingRoot The root element of the XML document containing configurations for this plugin.
static java.lang.String	SOAP_URI

Constructor Summary

Constructors

Constructor and Description
PluginBase()

Method Summary

Modifier and Type	Method and Description
protected org.w3c.dom.Element	buildDom(java.lang.String doc) Given a String, build a DOM out of it and return the root element.
static IXPathEvaluator	buildXPath(org.w3c.dom.Element root, java.lang.String name) Given an Element, build an XPath out of the string value of the element with the specified name.
static IXPathEvaluator	buildXPath(java.lang.String path, org.w3c.dom.Node nsContext) Build an XPath for the specified string.
void	destroy(IInit.IDestroyContext ctx) This method is called by the host application when the instance of the plug-in is released
static org.w3c.dom.Element	getFirstElement(IXpathResult match) If the IXpathResult contains a Node set whose first child is an Element, return it.
void	getPluginInfo(IPluginInfo.IPluginInfoContext ctx) Return PluginInfo with key.
static java.lang.String	getStringValue(org.w3c.dom.Element elm) Given an Element, extract the text value that is stored in this element.
static java.lang.String	getStringValue(org.w3c.dom.Element root, java.lang.String name) Given an Element, extract the text value that is stored in the specified child element.
void	init(IInit.IInitContext ctx) After the constructor is called, this method is called to initialize the plug in and passed any settings that are needed.
static boolean	isBlank(java.lang.String s) Returns TRUE if the given String is "blank"; otherwise FALSE.
protected void	loadSettings(ISettings settings)
protected void	loadSettings(java.lang.String settingsStr)
protected static double	parseDoubleSetting(java.lang.String val, java.lang.String settingName) Convert the specified string to a double.
protected static int	parseIntSetting(java.lang.String val, java.lang.String settingName) Convert the specified string to an integer.
static int	size(java.util.Collection c) Compute the size of a collection.
static int	size(java.util.Map m) Compute the size of a Map.
static int	size(org.w3c.dom.NodeList nl) Compute the size of a NodeList.
static int	size(java.lang.Object[] c) Compute the size of an array.

Methods inherited from class java.lang.Object

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

Field Detail

SOAP_URI

public static final java.lang.String SOAP_URI

See Also:

Constant Field Values

itsKeyId

protected java.lang.String itsKeyId

The Key ID for this plugin.

itsSettingRoot

protected org.w3c.dom.Element itsSettingRoot

The root element of the XML document containing configurations for this plugin. Subclasses may need to cache this.

Constructor Detail

PluginBase

public PluginBase()

Method Detail

init

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

After the constructor is called, this method is called to initialize the plug in and passed any settings that are needed. If an error occurs during initialization, this method can throw an exception.

Settings:
id - The ID of the interceptor.
<settings xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tns="http://sanity/test"> <!-- The ID of the interceptor. --> <id>CacheInterceptor</id> <!-- Extra custom settings. --> </settings>

Specified by:

init in interface IInit

Throws:

java.lang.Exception

destroy

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

Description copied from interface: IInit

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

Specified by:

destroy in interface IInit

Throws:

java.lang.Exception

getPluginInfo

public void getPluginInfo(IPluginInfo.IPluginInfoContext ctx)
                   throws java.lang.Exception

Return PluginInfo with key.

Specified by:

getPluginInfo in interface IPluginInfo

Throws:

java.lang.Exception

loadSettings

protected void loadSettings(ISettings settings)
                     throws java.lang.Exception

Throws:

java.lang.Exception

buildDom

protected org.w3c.dom.Element buildDom(java.lang.String doc)
                                throws java.lang.Exception

Given a String, build a DOM out of it and return the root element.

Throws:

java.lang.Exception

loadSettings

protected void loadSettings(java.lang.String settingsStr)
                     throws java.lang.Exception

Throws:

java.lang.Exception

buildXPath

public static IXPathEvaluator buildXPath(org.w3c.dom.Element root,
                                         java.lang.String name)
                                  throws java.lang.Exception

Given an Element, build an XPath out of the string value of the element with the specified name.

Parameters:

root - The element where the XPath is found.

name - The name of the element under root.

Returns:

the XPath.

Throws:

java.lang.Exception

buildXPath

public static IXPathEvaluator buildXPath(java.lang.String path,
                                         org.w3c.dom.Node nsContext)
                                  throws java.lang.Exception

Build an XPath for the specified string.

Parameters:

path - The XPath String.

nsContext - The namespace context for the XPath.

Returns:

The XPath.

Throws:

java.lang.Exception

getStringValue

public static java.lang.String getStringValue(org.w3c.dom.Element root,
                                              java.lang.String name)
                                       throws java.lang.Exception

Given an Element, extract the text value that is stored in the specified child element.

Parameters:

root - The root element of the settings.

name - The name of the child element to extract the string value from.

Returns:

The string value of the specified element.

Throws:

java.lang.Exception

getStringValue

public static java.lang.String getStringValue(org.w3c.dom.Element elm)

Given an Element, extract the text value that is stored in this element.

Parameters:

elm - The element to extract the string value from.

Returns:

The string value of the specified element.

getFirstElement

public static org.w3c.dom.Element getFirstElement(IXpathResult match)
                                           throws java.lang.Exception

If the IXpathResult contains a Node set whose first child is an Element, return it.

Parameters:

match - the Element containing a nodeset whose first Node may be an Element

Throws:

java.lang.Exception

size

public static final int size(java.lang.Object[] c)

Compute the size of an array. Handles null.

Parameters:

c - Object array

size

public static final int size(java.util.Collection c)

Compute the size of a collection. Handles null.

Parameters:

c - Collection

size

public static final int size(java.util.Map m)

Compute the size of a Map. Handles null. lastrev fix36438 - new method

size

public static final int size(org.w3c.dom.NodeList nl)

Compute the size of a NodeList. Handles null. lastrev fix36438 - new method

isBlank

public static boolean isBlank(java.lang.String s)

Returns TRUE if the given String is "blank"; otherwise FALSE. Blank means any of the following:

the object is null the object is an empty string

Parameters:

s - The object to test.

Returns:

TRUE if the given String is "blank"; otherwise FALSE.

parseIntSetting

protected static int parseIntSetting(java.lang.String val,
                                     java.lang.String settingName)
                              throws java.lang.Exception

Convert the specified string to an integer.

Parameters:

val - Stringified value of the integer setting

settingName - Name of the setting (used if an exception needs to be thrown)

Returns:

TRUE if the given String is "blank"; otherwise FALSE.

Throws:

java.lang.Exception

parseDoubleSetting

protected static double parseDoubleSetting(java.lang.String val,
                                           java.lang.String settingName)
                                    throws java.lang.Exception

Convert the specified string to a double.

Parameters:

val - Stringified value of the double setting

settingName - Name of the setting (used if an exception needs to be thrown)

Returns:

the parsed double value

Throws:

java.lang.Exception