Package org.epics.archiverappliance.config

Class ConfigServiceForTests

java.lang.Object

org.epics.archiverappliance.config.DefaultConfigService

org.epics.archiverappliance.config.ConfigServiceForTests

All Implemented Interfaces:

ConfigService

public class ConfigServiceForTests
extends DefaultConfigService

Nested Class Summary

Nested classes/interfaces inherited from class org.epics.archiverappliance.config.DefaultConfigService

DefaultConfigService.Tuple<T>

Nested classes/interfaces inherited from interface org.epics.archiverappliance.config.ConfigService

ConfigService.CachedPVCounts, ConfigService.EAABulkOperation<T>, ConfigService.STARTUP_SEQUENCE, ConfigService.WAR_FILE

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ARCH_UNIT_TEST_PVNAME_PREFIX	All unit test PV names are expected to begin with this.
static final String	DATA_RETRIEVAL_URL
static final int	DEFAULT_MGMT_PORT
protected static final String	DEFAULT_PB_SHORT_TERM_TEST_DATA_FOLDER
protected static final String	DEFAULT_PB_TEST_DATA_FOLDER	A folder which is used to store the data for the unit tests...
static final int	defaultMinutesDisconnect
static final int	defaultSecondsDisconnect
static final String	ENGINE_BPL
static final String	ENGINE_URL
static final String	ETL_BPL
static final String	ETL_URL
static final String	GETDATAATTIME_DATA
static final String	GETDATAATTIME_URL
static final String	HTTP_LOCALHOST
static final String	MGMT_BPL
static final String	MGMT_INDEX_URL
static final String	MGMT_UI_URL
static final String	MGMT_URL
static final String	RAW_RETRIEVAL_URL
static final String	RETRIEVAL_BPL
static final String	RETRIEVAL_DATA
static final int	RETRIEVAL_TEST_PORT	Tomcat is launched listening to this port when running the unit tests
static final String	RETRIEVAL_URL
static final String	TESTAPPLIANCE0

Fields inherited from class org.epics.archiverappliance.config.DefaultConfigService

aliasNamesToRealNames, applianceAggregateInfo, appliances, appliancesConfigLoaded, appliancesInCluster, ARCHAPPL_NAME, archapplproperties, archivePVRequests, channelArchiverDataServers, CLUSTER_INET_2_APPLIANCE_IDENTITY, clusterInet2ApplianceIdentity, engineContext, etlPVLookup, eventBus, failoverPVs, LOCAL_HOST_ADDRESS, LOGGING_TYPE, mgmtRuntime, myApplianceInfo, myIdentity, namedFlags, parts2PVNamesForThisAppliance, pausedPVCountOnThisAppliance, persistanceLayer, processMetrics, pubSub, pv2appliancemapping, pv2ChannelArchiverDataServer, pvName2KeyConverter, retrievalState, shutdownHooks, SITE_FOR_UNIT_TESTS_NAME, SITE_FOR_UNIT_TESTS_VALUE, startupExecutor, startupState, totalPVCountOnThisAppliance, TYPEINFO, typeInfos, warFile

Fields inherited from interface org.epics.archiverappliance.config.ConfigService

ARCHAPPL_APPLIANCES, ARCHAPPL_CONFIGSERVICE_IMPL, ARCHAPPL_MYIDENTITY, ARCHAPPL_NAMEDFLAGS_PROPERTIES_FILE_PROPERTY, ARCHAPPL_PERSISTENCE_LAYER, ARCHAPPL_POLICIES, ARCHAPPL_PROPERTIES_FILENAME, ARCHAPPL_SITEID, CONFIG_SERVICE_NAME, DEFAULT_ARCHAPPL_PROPERTIES_FILENAME

Constructor Summary

Constructors

Constructor	Description
ConfigServiceForTests()	Special Constructor for Integration tests Do not use in unit tests.
ConfigServiceForTests(int jcaCommandThreadCount)
ConfigServiceForTests(File WebInfClassesFolder, int jcaCommandThreadCount)

Method Summary

Modifier and Type	Method	Description
ApplianceInfo	getApplianceForPV(String pvName)	Given a PV, get us the appliance that is responsible for archiving it.
static String	getDefaultPBTestFolder()
static String	getDefaultShortTermFolder()
int	getInitialDelayBeforeStartingArchiveRequestWorkflow()	In clustered environments, to give capacity planning a chance to work correctly, we want to kick off the archive PV workflow only after all the machines have started.
String	getPBRootFolder()	Get the root folder for the PB storage plugin
InputStream	getPolicyText()	Return the text of the policy for this installation.
PVTypeInfo	getTypeInfoForPV(String pvName)	Gets information about a PV's type, i.e its DBR type, graphic limits etc.
String	getWebInfFolder()	We expect to live within a servlet container.
void	initialize(jakarta.servlet.ServletContext sce)	If you have a null constructor and need a ServletContext, implement this method.
void	registerPVToAppliance(String pvName, ApplianceInfo applianceInfo, PVRegistrationType registrationType)	Register the pv to the appliance Note this restarts any ETL JOBs in unit tests, so you'll need to call manualControlForUnitTests(); again if they should be stopped.
void	setPBRootFolder(String rootFolder)	This should only be called in the unit tests....

Methods inherited from class org.epics.archiverappliance.config.DefaultConfigService

addAlias, addExternalArchiverDataServer, addShutdownHook, addToArchiveRequests, archiveRequestWorkflowCompleted, breakDownPVsByAppliance, computePolicyForPV, doesPVHaveArchiveRequestInWorkflow, executeClusterWide, executeOnAppliance, getAggregatedApplianceInfo, getAliasesForRealName, getAllAliases, getAllExpandedNames, getAllPVs, getAppliance, getAppliancesInCluster, getArchiveRequestsCurrentlyInWorkflow, getArchiverTypeSystem, getCachedPVCountsForThisAppliance, getChannelArchiverDataServers, getEngineContext, getETLLookup, getEventBus, getExternalArchiverDataServers, getExtraFields, getFailoverApplianceURL, getFailoverServerURLs, getFieldsArchivedAsPartOfStream, getInstallationProperties, getMgmtRuntimeState, getMyApplianceInfo, getNamedFlag, getNamedFlagNames, getPausedPVsInThisAppliance, getPoliciesInInstallation, getProcessMetrics, getPVNameToKeyConverter, getPVsForAppliance, getPVsForApplianceMatchingRegex, getPVsForThisAppliance, getRealNameForAlias, getRetrievalRuntimeState, getRuntimeFields, getStartupState, getTimeOfAppserverStartup, getUserSpecifiedSamplingParams, getWarFile, hasClusterFinishedInitialization, isShuttingDown, isStartupComplete, postStartup, publishEventIntoCluster, queryPVTypeInfos, refreshPVDataFromChannelArchiverDataServers, removeAlias, removeExternalArchiverDataServer, removePVFromCluster, resetFailoverCaches, setNamedFlag, shutdownNow, updateArchiveRequest, updatePVSForThisAppliance, updateTypeInfoForPV

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.epics.archiverappliance.config.ConfigService

registerPVToAppliance

Field Details

TESTAPPLIANCE0

public static final String TESTAPPLIANCE0

See Also:

• Constant Field Values

DEFAULT_MGMT_PORT

public static final int DEFAULT_MGMT_PORT

See Also:

• Constant Field Values

RETRIEVAL_TEST_PORT

public static final int RETRIEVAL_TEST_PORT

Tomcat is launched listening to this port when running the unit tests

See Also:

• Constant Field Values

ARCH_UNIT_TEST_PVNAME_PREFIX

public static final String ARCH_UNIT_TEST_PVNAME_PREFIX

All unit test PV names are expected to begin with this. This name is supposed to be something that we will not encounter in the field.

See Also:

• Constant Field Values

HTTP_LOCALHOST

public static final String HTTP_LOCALHOST

See Also:

• Constant Field Values

DATA_RETRIEVAL_URL

public static final String DATA_RETRIEVAL_URL

See Also:

• Constant Field Values

MGMT_BPL

public static final String MGMT_BPL

See Also:

• Constant Field Values

MGMT_URL

public static final String MGMT_URL

See Also:

• Constant Field Values

MGMT_UI_URL

public static final String MGMT_UI_URL

See Also:

• Constant Field Values

MGMT_INDEX_URL

public static final String MGMT_INDEX_URL

See Also:

• Constant Field Values

ENGINE_BPL

public static final String ENGINE_BPL

See Also:

• Constant Field Values

ENGINE_URL

public static final String ENGINE_URL

See Also:

• Constant Field Values

RETRIEVAL_BPL

public static final String RETRIEVAL_BPL

See Also:

• Constant Field Values

RETRIEVAL_URL

public static final String RETRIEVAL_URL

See Also:

• Constant Field Values

RETRIEVAL_DATA

public static final String RETRIEVAL_DATA

See Also:

• Constant Field Values

RAW_RETRIEVAL_URL

public static final String RAW_RETRIEVAL_URL

See Also:

• Constant Field Values

GETDATAATTIME_DATA

public static final String GETDATAATTIME_DATA

See Also:

• Constant Field Values

GETDATAATTIME_URL

public static final String GETDATAATTIME_URL

See Also:

• Constant Field Values

ETL_BPL

public static final String ETL_BPL

See Also:

• Constant Field Values

ETL_URL

public static final String ETL_URL

See Also:

• Constant Field Values

DEFAULT_PB_SHORT_TERM_TEST_DATA_FOLDER

protected static final String DEFAULT_PB_SHORT_TERM_TEST_DATA_FOLDER

DEFAULT_PB_TEST_DATA_FOLDER

protected static final String DEFAULT_PB_TEST_DATA_FOLDER

A folder which is used to store the data for the unit tests...

defaultSecondsDisconnect

public static final int defaultSecondsDisconnect

See Also:

• Constant Field Values

defaultMinutesDisconnect

public static final int defaultMinutesDisconnect

See Also:

• Constant Field Values

Constructor Details

ConfigServiceForTests

public ConfigServiceForTests()
                      throws ConfigException

Special Constructor for Integration tests Do not use in unit tests.

Throws:

ConfigException

ConfigServiceForTests

public ConfigServiceForTests(int jcaCommandThreadCount)
                      throws ConfigException

Throws:

ConfigException

ConfigServiceForTests

public ConfigServiceForTests(File WebInfClassesFolder,
 int jcaCommandThreadCount)
                      throws ConfigException

Throws:

ConfigException

Method Details

getDefaultPBTestFolder

public static String getDefaultPBTestFolder()

getDefaultShortTermFolder

public static String getDefaultShortTermFolder()

initialize

public void initialize(jakarta.servlet.ServletContext sce)
                throws ConfigException

Description copied from interface: ConfigService

If you have a null constructor and need a ServletContext, implement this method.

Specified by:

initialize in interface ConfigService

Overrides:

initialize in class DefaultConfigService

Parameters:

sce - ServletContext

Throws:

ConfigException -  

getApplianceForPV

public ApplianceInfo getApplianceForPV(String pvName)

Description copied from interface: ConfigService

Given a PV, get us the appliance that is responsible for archiving it. Note that this may be null as the assignment of PV's to appliances can take some time.

Specified by:

getApplianceForPV in interface ConfigService

Overrides:

getApplianceForPV in class DefaultConfigService

Parameters:

pvName - The name of PV.

Returns:

ApplianceInfo  

registerPVToAppliance

public void registerPVToAppliance(String pvName,
 ApplianceInfo applianceInfo,
 PVRegistrationType registrationType)
                           throws AlreadyRegisteredException

Register the pv to the appliance Note this restarts any ETL JOBs in unit tests, so you'll need to call manualControlForUnitTests(); again if they should be stopped.

Specified by:

registerPVToAppliance in interface ConfigService

Overrides:

registerPVToAppliance in class DefaultConfigService

Parameters:

pvName - The name of PV.

applianceInfo - ApplianceInfo

registrationType - If reassigning; then an AlreadyRegisteredException is not raised

Throws:

AlreadyRegisteredException - pv already registered.

getPolicyText

public InputStream getPolicyText()
                          throws IOException

Description copied from interface: ConfigService

Return the text of the policy for this installation. Gets you an InputStream; remember to close it.

Specified by:

getPolicyText in interface ConfigService

Overrides:

getPolicyText in class DefaultConfigService

Returns:

InputStream  

Throws:

IOException -  

getTypeInfoForPV

public PVTypeInfo getTypeInfoForPV(String pvName)

Description copied from interface: ConfigService

Gets information about a PV's type, i.e its DBR type, graphic limits etc. This information is assumed to be somewhat static and is expected to come from a cache if possible as it is used in data retrieval.

Specified by:

getTypeInfoForPV in interface ConfigService

Overrides:

getTypeInfoForPV in class DefaultConfigService

Parameters:

pvName - The name of PV.

Returns:

PVTypeInfo  

getPBRootFolder

public String getPBRootFolder()

Get the root folder for the PB storage plugin

Returns:

setPBRootFolder

public void setPBRootFolder(String rootFolder)

This should only be called in the unit tests....

Parameters:

rootFolder -

getWebInfFolder

public String getWebInfFolder()

Description copied from interface: ConfigService

We expect to live within a servlet container. This call returns the full path to the WEB-INF folder of the webapp as it is deployed in the container. Is typically a call to the servletContext.getRealPath("WEB-INF/")

Specified by:

getWebInfFolder in interface ConfigService

Overrides:

getWebInfFolder in class DefaultConfigService

Returns:

String WebInfFolder  

getInitialDelayBeforeStartingArchiveRequestWorkflow

public int getInitialDelayBeforeStartingArchiveRequestWorkflow()

Description copied from interface: ConfigService

In clustered environments, to give capacity planning a chance to work correctly, we want to kick off the archive PV workflow only after all the machines have started. This is an approximation for that metric; though not a very satisfactory approximation. TODO -- Think thru implications of making the appliances.xml strict...

Specified by:

getInitialDelayBeforeStartingArchiveRequestWorkflow in interface ConfigService

Overrides:

getInitialDelayBeforeStartingArchiveRequestWorkflow in class DefaultConfigService

Returns:

- Initial delay in seconds.