at.gv.egiz.pdfas.lib.api

Interface Configuration

All Known Implementing Classes:

ConfigurationImpl

public interface Configuration

Configuration interface This interface is used to configure one PDF-AS run. It contains the configuration values from the configuration file. Use this interface to override properties during runtime.

Method Summary

Methods

Modifier and Type	Method and Description
void	cloneProfile(String originalPrefix, String clonedPrefix) Clone configuration values at runtime only All configuration values with originalPrefix are copied and inserted as clonedPrefix Example usage might be the generation of dynamic signature profiles: cloneProfile(PdfAsConfigurationConstants.SIG_OBJECT_PREFIX + "SIGNATURBLOCK_DE", PdfAsConfigurationConstants.SIG_OBJECT_PREFIX + "MY_DYNAMIC_PROFILE");
String	getValue(String key) Gets a specific Value
boolean	hasValue(String key) Is the configuration key set
void	removeProfile(String configurationPrefix) Removes all dynamically configured values with a given prefix.
void	setValue(String key, String value) Sets or overrides a configuration value

Method Detail

getValue

String getValue(String key)

Gets a specific Value

Parameters:

key - The configuration key

Returns:

The configured value

hasValue

boolean hasValue(String key)

Is the configuration key set

Parameters:

key - The configuration key

Returns:

true | false

setValue

void setValue(String key,
            String value)

Sets or overrides a configuration value

Parameters:

key - The configuration key

value - The configuration value

cloneProfile

void cloneProfile(String originalPrefix,
                String clonedPrefix)

Clone configuration values at runtime only All configuration values with originalPrefix are copied and inserted as clonedPrefix Example usage might be the generation of dynamic signature profiles: cloneProfile(PdfAsConfigurationConstants.SIG_OBJECT_PREFIX + "SIGNATURBLOCK_DE", PdfAsConfigurationConstants.SIG_OBJECT_PREFIX + "MY_DYNAMIC_PROFILE");

Parameters:

originalPrefix - The original configuration key prefix

clonedPrefix - The cloned configuration key prefix

removeProfile

void removeProfile(String configurationPrefix)

Removes all dynamically configured values with a given prefix. It can be used to remove a profile during runtime. Example usage might be the generation of dynamic signature profiles: removeProfile(PdfAsConfigurationConstants.SIG_OBJECT_PREFIX + "MY_DYNAMIC_PROFILE");

Parameters:

configurationPrefix - The configuration key prefix