com.secutix.plugin.v1_0

Class AbstractStxPlugin

java.lang.Object

com.secutix.plugin.v1_0.AbstractStxPlugin

Direct Known Subclasses:

AccessControlPlugin

public abstract class AbstractStxPlugin
extends Object

To implement a plugin, override this class. Fill abstract method (they may have been pre-implemented by S-360 team)

Only override methods for behaviors handled by your plugin. A method must never throw any exception, and always return a PluginCallResult object.

• Connection and context parameters (url, login, password...) can be accessed through : interfaceParametersProvider
• Logging must be done through getLogger() helper.
• Logging for operator (in the application) must i18nized and done through logForOperator method.
• doing http requests must be done through getCurrentHttpClientHelper() (this helper guarantee the use of internal S-360 proxies, timeouts, etc.)

Author:

qhr, lkl

Field Summary

Fields

Modifier and Type	Field and Description
protected StopWatch	watch

Constructor Summary

Constructors

Constructor and Description
AbstractStxPlugin()

Method Summary

Modifier and Type	Method and Description
void	clearLogSuffix()
protected List<StxFunction>	findAllFunctions(Class<?> aClass)
protected HttpClientHelper	getCurrentHttpClientHelper()
protected XmlRpcClientHelper	getCurrentXmlRpcClientHelper()
HttpClientHelper	getDummyHttpClientHelper()
XmlRpcClientHelper	getDummyXmlRpcClientHelper()
ExecutorServiceProvider	getExecutorServiceProvider()
HttpClientHelper	getHttpClientHelper()
abstract Map<String,String>	getInterfaceNamesByLanguageCode()
InterfaceParametersProvider	getInterfaceParametersProvider()
abstract String	getInterfaceType()
OperatorInternationalizedLogger	getInternationalizedLogger()
JaxRpcSoapProxyHelper	getJaxRpcSoapProxyHelper()
JaxwsSoapProxyHelper	getJaxwsSoapProxyHelper()
Logger	getLogger()
MappingReader	getMappingReader()
RemoteFileAccessor	getRemoteFileAccessor()
String	getTranslatedMessage(String defaultMessage, String... translations)
UniqueValuesHelper	getUniqueValuesHelper()
XmlRpcClientHelper	getXmlRpcClientHelper()
void	initLogSuffix(Map<String,Object> suffixes)
boolean	isDemoPlugin()
List<ParameterDefinition>	listParameterDefinitions()
List<ParameterDefinition>	listParameterDefinitions(boolean registeringMode)
void	logDownloadableData(LogLevel lvl, String fileName, String data, String message, String... translations) Allows to store data downloadable from a link in the executions.
void	logForOperator(LogLevel lvl, String defaultMessage, String... translations) Logs an message for the operator in S-360 backend.
void	setDummyHttpClientHelper(HttpClientHelper dummyHttpClientHelper)
void	setDummyXmlRpcClientHelper(XmlRpcClientHelper dummyXmlRpcClientHelper)
void	setExecutorServiceProvider(ExecutorServiceProvider executorServiceProvider)
void	setHttpClientHelper(HttpClientHelper httpClientHelper)
void	setInterfaceParametersProvider(InterfaceParametersProvider interfaceParametersProvider)
void	setInternationalizedLogger(OperatorInternationalizedLogger logger)
void	setJaxRpcSoapProxyHelper(JaxRpcSoapProxyHelper jaxRpcSoapProxyHelper)
void	setJaxwsSoapProxyHelper(JaxwsSoapProxyHelper jaxwsSoapProxyHelper)
void	setLogger(Logger logger)
void	setMappingReader(MappingReader mappingReader)
void	setRemoteFileAccessor(RemoteFileAccessor remoteFileAccessor)
void	setUniqueValuesHelper(UniqueValuesHelper uniqueValuesHelper)
void	setXmlRpcClientHelper(XmlRpcClientHelper xmlRpcClientHelper)
void	validate()
Map<String,String>	validateStringWithTranslations(String stringWithTranslations, String desc)

Methods inherited from class java.lang.Object

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

Field Detail

watch

protected StopWatch watch

Constructor Detail

AbstractStxPlugin

public AbstractStxPlugin()

Method Detail

getInterfaceType

public abstract String getInterfaceType()

getInterfaceNamesByLanguageCode

public abstract Map<String,String> getInterfaceNamesByLanguageCode()

getRemoteFileAccessor

public RemoteFileAccessor getRemoteFileAccessor()

setRemoteFileAccessor

public void setRemoteFileAccessor(RemoteFileAccessor remoteFileAccessor)

initLogSuffix

public void initLogSuffix(Map<String,Object> suffixes)

clearLogSuffix

public void clearLogSuffix()

logForOperator

public final void logForOperator(LogLevel lvl,
                                 String defaultMessage,
                                 String... translations)

Logs an message for the operator in S-360 backend.

Parameters:

lvl - the level of the error. Beware : an error log can trigger an email to the operator. Be explicit in the problems that you log and propose a solution.

defaultMessage - the default message. Pattern must be : [localeCode] message. Example [en] reading the catalog. This message will be chosen if the locale code is not matching any of the messages below.

translations - same pattern as above.

validate

public void validate()
              throws ValidationException

Throws:

ValidationException

findAllFunctions

protected List<StxFunction> findAllFunctions(Class<?> aClass)

validateStringWithTranslations

public Map<String,String> validateStringWithTranslations(String stringWithTranslations,
                                                         String desc)
                                                  throws ValidationException

Throws:

ValidationException

getTranslatedMessage

public String getTranslatedMessage(String defaultMessage,
                                   String... translations)

getInterfaceParametersProvider

public final InterfaceParametersProvider getInterfaceParametersProvider()

setInterfaceParametersProvider

public final void setInterfaceParametersProvider(InterfaceParametersProvider interfaceParametersProvider)

getInternationalizedLogger

public final OperatorInternationalizedLogger getInternationalizedLogger()

setInternationalizedLogger

public final void setInternationalizedLogger(OperatorInternationalizedLogger logger)

getLogger

public final Logger getLogger()

setLogger

public final void setLogger(Logger logger)

getCurrentHttpClientHelper

protected final HttpClientHelper getCurrentHttpClientHelper()

setDummyHttpClientHelper

public final void setDummyHttpClientHelper(HttpClientHelper dummyHttpClientHelper)

setHttpClientHelper

public final void setHttpClientHelper(HttpClientHelper httpClientHelper)

getHttpClientHelper

public final HttpClientHelper getHttpClientHelper()

getDummyHttpClientHelper

public final HttpClientHelper getDummyHttpClientHelper()

getCurrentXmlRpcClientHelper

protected final XmlRpcClientHelper getCurrentXmlRpcClientHelper()

setDummyXmlRpcClientHelper

public final void setDummyXmlRpcClientHelper(XmlRpcClientHelper dummyXmlRpcClientHelper)

setXmlRpcClientHelper

public final void setXmlRpcClientHelper(XmlRpcClientHelper xmlRpcClientHelper)

getXmlRpcClientHelper

public final XmlRpcClientHelper getXmlRpcClientHelper()

getDummyXmlRpcClientHelper

public final XmlRpcClientHelper getDummyXmlRpcClientHelper()

listParameterDefinitions

public List<ParameterDefinition> listParameterDefinitions()

listParameterDefinitions

public List<ParameterDefinition> listParameterDefinitions(boolean registeringMode)

getJaxwsSoapProxyHelper

public JaxwsSoapProxyHelper getJaxwsSoapProxyHelper()

setJaxwsSoapProxyHelper

public void setJaxwsSoapProxyHelper(JaxwsSoapProxyHelper jaxwsSoapProxyHelper)

getJaxRpcSoapProxyHelper

public JaxRpcSoapProxyHelper getJaxRpcSoapProxyHelper()

setJaxRpcSoapProxyHelper

public void setJaxRpcSoapProxyHelper(JaxRpcSoapProxyHelper jaxRpcSoapProxyHelper)

isDemoPlugin

public boolean isDemoPlugin()

getUniqueValuesHelper

public UniqueValuesHelper getUniqueValuesHelper()

setUniqueValuesHelper

public void setUniqueValuesHelper(UniqueValuesHelper uniqueValuesHelper)

getMappingReader

public MappingReader getMappingReader()

setMappingReader

public void setMappingReader(MappingReader mappingReader)

logDownloadableData

public void logDownloadableData(LogLevel lvl,
                                String fileName,
                                String data,
                                String message,
                                String... translations)

Allows to store data downloadable from a link in the executions.

Parameters:

lvl - : log level

fileName - : name of the downloadable file.

data - : content of the data.

message - : Optional : may contain a message accompanying the file.

translations - : possible translations for the message, in the format en=First translation in EN, fr=Translation in FR, etc.

getExecutorServiceProvider

public ExecutorServiceProvider getExecutorServiceProvider()

setExecutorServiceProvider

public void setExecutorServiceProvider(ExecutorServiceProvider executorServiceProvider)