fc-plugin-codbi/com.github.xima_formcycle_entwicklerkreis.fc.plugin.codbi.logic.bayVIS.auskunft/CodBiBayVISAuskunftAnsprechpartnerverzeichnisAction

CodBiBayVISAuskunftAnsprechpartnerverzeichnisAction

class CodBiBayVISAuskunftAnsprechpartnerverzeichnisAction : IPluginServletAction

This servlet acts as a nano server to pass request from a form using the CodBi along with the BayVIS related functionalities to the BayVIS-API that way prevent the exposure of credentials.

Configuration Keys:

BayVIS_Benutzername: The username to use to log into the BayVIS-API.
BayVIS_Passwort: The password to use to log into the BayVIS-API.
BayVIS_EP_Ansprechpartnerverzeichnis: Optional specification of where the endpoint for retrieving the authority directory can be found.

Constructors

CodBiBayVISAuskunftAnsprechpartnerverzeichnisAction

constructor()

Types

ValidationResult

class ValidationResult : IPluginInitializeValidationResult

Reflects the result of CodBiBayVISAuskunftAnsprechpartnerverzeichnisAction's validation.

Functions

execute

open override fun execute(p0: IPluginServletActionParams): IPluginServletActionRetVal

Retrieves the directory of authorities from the BayVIS-API. Missing implementation: Buffering of data and re-requesting after a certain amounts of hours.

getDescription

open fun ~~getDescription~~(): String

open fun getDescription(p0: Locale): String

getDisplayName

open override fun getDisplayName(p0: Locale): String

getName

open override fun getName(): String

Returns "CodBi_BayVIS_Auskunft_Ansprechpartnerverzeichnis"

initialize

open override fun initialize(configData: IPluginInitializeData)

Sets the username, password (also retrieving the contact directory into buffer using the provided credentials) & optionally url.

initPlugin

open fun ~~initPlugin~~()

install

open fun install(p0: IPluginInstallData)

shutdown

open fun ~~shutdown~~()

open fun shutdown(p0: IPluginShutdownData)

uninstall

open fun uninstall(p0: IPluginUninstallData)

validateConfigurationData

open override fun validateConfigurationData(configData: IPluginValidationData): IPluginInitializeValidationResult?

Updates the username, password, hrsTillUpdate and the contact directory into the buffer using the configuration-properties BayVIS_Benutzername&&BayVIS_Passwort. Furthermore, credential validity is checked.