com.indexdata.serviceproxy

Interface Plugin

All Known Implementing Classes:

AbstractPlugin, AcePlugin, AddHeaderPlugin, AuthNTorusPlugin, AvailableTargetsPlugin, ByePlugin, ClickOutPlugin, ContentProxyPlugin, ExplodePlugin, ExportRecordsPlugin, HelloPlugin, HiPlugin, HoldingsPlugin, IllRequestPlugin, ILSPlugin, ImageProxyPlugin, InfoPlugin, Pazpar2RelayPlugin, RecordCachePlugin, RecordRelayPlugin, RecordStorePlugin, SecondaryLookup, SendRequest, StatisticsPlugin, TargetCategoriesPlugin

public interface Plugin

Interface to represent a service proxy plugin. In principle has to be implemented by every registered component, however in practice the plugin should exntend the AbstractPlugin class.

Author:

jakub

Method Summary

Modifier and Type	Method and Description
String	getChainName()
com.indexdata.masterkey.config.ModuleConfiguration	getConfig() Poorman's dependency injection mechanism: get configuration for this plugin.
String	getName()
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 pluginConfig) Poorman's dependency injection mechanism: set configuration for this plugin.
void	setName(String name)

Method Detail

setConfig

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

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

Parameters:

config - configuration

setChainName

void setChainName(String chainName)

getChainName

String getChainName()

getName

String getName()

setName

void setName(String name)

getConfig

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

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

Returns:

map with the plugin configuration

serve

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

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

Parameters:

request - service request

response - service response

chain - chain-control utility

Throws:

StandardServiceException - plugin-runtime exception

IOException - of any kind

ServiceException