com.indexdata.serviceproxy
Class AbstractPlugin

java.lang.Object
  com.indexdata.serviceproxy.AbstractPlugin

All Implemented Interfaces:

Plugin

Direct Known Subclasses:

AcePlugin, AddHeaderPlugin, AuthNTorusPlugin, ByePlugin, ClickOutPlugin, ExplodePlugin, ExportRecordsPlugin, HelloPlugin, HiPlugin, HoldingsPlugin, IllRequestPlugin, ILSPlugin, ImageProxyPlugin, Pazpar2RelayPlugin, RecordCachePlugin, RecordStorePlugin, SecondaryLookup, StatisticsPlugin, TargetCategoriesPlugin

public abstract class AbstractPlugin
extends Object
implements Plugin

Provides base implementation for every service proxy plugin.

Author:

jakub

Constructor Summary

AbstractPlugin()

Method Summary

String	getChainName()
com.indexdata.masterkey.config.ModuleConfiguration	getConfig() Poorman's dependency injection mechanism: get configuration for this plugin.
String	getName()
NodeList	getNodeList(Object startingPoint, String xPathString)
String	getXmlString(Document dom)
abstract void	serve(ServiceRequest request, ServiceResponse response, ChainControl chain) This method gets called during the chain processing by the container.
void	setChainName(String chainName)
void	setConfig(com.indexdata.masterkey.config.ModuleConfiguration config) Poorman's dependency injection mechanism: set configuration for this plugin.
void	setName(String name)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractPlugin

public AbstractPlugin()

Method Detail

setConfig

public void setConfig(com.indexdata.masterkey.config.ModuleConfiguration config)

Description copied from interface: Plugin

Poorman's dependency injection mechanism: set configuration for this plugin.

Specified by:

setConfig in interface Plugin

getConfig

public com.indexdata.masterkey.config.ModuleConfiguration getConfig()

Description copied from interface: Plugin

Poorman's dependency injection mechanism: get configuration for this plugin.

Specified by:

getConfig in interface Plugin

Returns:

map with the plugin configuration

setChainName

public void setChainName(String chainName)

Specified by:

setChainName in interface Plugin

getChainName

public String getChainName()

Specified by:

getChainName in interface Plugin

getName

public String getName()

Specified by:

getName in interface Plugin

setName

public void setName(String name)

Specified by:

setName in interface Plugin

getXmlString

public String getXmlString(Document dom)

getNodeList

public NodeList getNodeList(Object startingPoint,
                            String xPathString)
                     throws StandardServiceException

Throws:

StandardServiceException

serve

public abstract void serve(ServiceRequest request,
                           ServiceResponse response,
                           ChainControl chain)
                    throws ServiceException,
                           IOException

Description copied from interface: Plugin

This method gets called during the chain processing by the container.

Specified by:

serve in interface Plugin

Parameters:

request - service request

response - service response

chain - chain-control utility

Throws:

IOException - of any kind

ServiceException