Class CasProcessorConfigurationJAXBImpl
java.lang.Object
org.apache.uima.collection.impl.cpm.container.CasProcessorConfigurationJAXBImpl
- All Implemented Interfaces:
CasProcessorConfiguration
A wrapper containing CAS Processor configuration. An instance of this class is associated with
each CAS Processor.
-
Constructor Summary
ConstructorsConstructorDescriptionCasProcessorConfigurationJAXBImpl
(CpeCasProcessor aCasProcessorConfig, ResourceManager aResourceManager) Initializes instance and copies configuration from CPE descriptor. -
Method Summary
Modifier and TypeMethodDescriptionReturns an action as String to identify an action to take in case of excessive Cas Processor errors.Returns an action as String to identify an action to take in case of excessive Cas Processor restarts.int
Returns configured batch size setup for this Cas ProcessorgetDeploymentParameter
(String aDeployParameter) Returns a value for a given deployment parameterReturns a list of deployment parameters associated with this CAS ProcessorReturns deployment type associated with this CAS Processor integrated local remoteReturns descriptor associated with this Cas Processorint
long
Returns executable section of the CAS Processor configuration.Returns parsed filter expressions as List.String[]
Returns an array of types that should not be sent to CAS Processor.int
Returns max number of tolerated errorsint
Returns max number of Cas Processor restartsint
Returns max number of tries to process each bundle of Casint
Returns how long to wait between re-sending CAS after failuregetName()
Returns Cas Processor namelong
Returns the max amount of time the CPE will wait for CAS Processor response.boolean
Returns true it the CAS Processor is written in java and will be run with Java JVM.boolean
Returns if the Cas Processor is able to run in parallelboolean
readOnly()
Returns if the Cas Processor is read onlyboolean
Returns true if this CAS Processor will run in its own process
-
Constructor Details
-
CasProcessorConfigurationJAXBImpl
public CasProcessorConfigurationJAXBImpl(CpeCasProcessor aCasProcessorConfig, ResourceManager aResourceManager) throws ResourceConfigurationException Initializes instance and copies configuration from CPE descriptor.- Parameters:
aCasProcessorConfig
- - configuration object containing CAS Processor configurationaResourceManager
- - needed to resolve import by name- Throws:
ResourceConfigurationException
- if descriptor error
-
-
Method Details
-
getMaxTimeToWaitBetweenRetries
public int getMaxTimeToWaitBetweenRetries()Returns how long to wait between re-sending CAS after failure- Specified by:
getMaxTimeToWaitBetweenRetries
in interfaceCasProcessorConfiguration
-
isParallelizable
public boolean isParallelizable()Returns if the Cas Processor is able to run in parallel- Returns:
- - true if the component can run in parallel, false otherwise
-
readOnly
public boolean readOnly()Returns if the Cas Processor is read only- Returns:
- - true if read only, false otherwise
-
getActionOnError
Returns an action as String to identify an action to take in case of excessive Cas Processor errors.- continue
- terminate
- disable
- Specified by:
getActionOnError
in interfaceCasProcessorConfiguration
- Returns:
- - action
-
getActionOnMaxRestart
Returns an action as String to identify an action to take in case of excessive Cas Processor restarts.- continue
- terminate
- disable
- Specified by:
getActionOnMaxRestart
in interfaceCasProcessorConfiguration
- Returns:
- - action
-
getErrorRate
public int getErrorRate()- Specified by:
getErrorRate
in interfaceCasProcessorConfiguration
-
getErrorSampleSize
public long getErrorSampleSize()- Specified by:
getErrorSampleSize
in interfaceCasProcessorConfiguration
-
getMaxErrorCount
public int getMaxErrorCount()Returns max number of tolerated errors- Specified by:
getMaxErrorCount
in interfaceCasProcessorConfiguration
- Returns:
- - max number of allowed errors
-
getMaxRestartCount
public int getMaxRestartCount()Returns max number of Cas Processor restarts- Specified by:
getMaxRestartCount
in interfaceCasProcessorConfiguration
- Returns:
- - max number of restarts
-
getMaxRetryCount
public int getMaxRetryCount()Returns max number of tries to process each bundle of Cas- Specified by:
getMaxRetryCount
in interfaceCasProcessorConfiguration
- Returns:
- - max retry count
-
getName
Returns Cas Processor name- Specified by:
getName
in interfaceCasProcessorConfiguration
- Returns:
- - Name
-
getTimeout
public long getTimeout()Returns the max amount of time the CPE will wait for CAS Processor response.- Specified by:
getTimeout
in interfaceCasProcessorConfiguration
- Returns:
- - value for timeout
-
getDeploymentParameters
Returns a list of deployment parameters associated with this CAS Processor- Specified by:
getDeploymentParameters
in interfaceCasProcessorConfiguration
- Returns:
- - deployment parameters as List
-
getDeploymentType
Returns deployment type associated with this CAS Processor- integrated
- local
- remote
- Specified by:
getDeploymentType
in interfaceCasProcessorConfiguration
- Returns:
- - deployment type
-
getFilterString
- Specified by:
getFilterString
in interfaceCasProcessorConfiguration
- Returns:
- unparsed filter expression
-
getFilter
Returns parsed filter expressions as List.- Specified by:
getFilter
in interfaceCasProcessorConfiguration
- Throws:
ResourceConfigurationException
-
getKeysToDrop
Returns an array of types that should not be sent to CAS Processor. The drop types are defined in the CPE descriptor.- Specified by:
getKeysToDrop
in interfaceCasProcessorConfiguration
- Throws:
ResourceConfigurationException
-
getBatchSize
public int getBatchSize()Returns configured batch size setup for this Cas Processor- Specified by:
getBatchSize
in interfaceCasProcessorConfiguration
- Returns:
- - batch size
-
getDescriptorUrl
Returns descriptor associated with this Cas Processor- Specified by:
getDescriptorUrl
in interfaceCasProcessorConfiguration
- Returns:
- object that identifies location of descriptor
- Throws:
ResourceConfigurationException
- if an import could not be resolved
-
getDeploymentParameter
Returns a value for a given deployment parameter- Specified by:
getDeploymentParameter
in interfaceCasProcessorConfiguration
- Parameters:
aDeployParameter
- - name of the parameter- Returns:
- - value for parameter name
-
runInSeparateProcess
public boolean runInSeparateProcess()Returns true if this CAS Processor will run in its own process- Specified by:
runInSeparateProcess
in interfaceCasProcessorConfiguration
- Returns:
- - true if running in separate process
-
isJavaProcess
public boolean isJavaProcess()Returns true it the CAS Processor is written in java and will be run with Java JVM.- Specified by:
isJavaProcess
in interfaceCasProcessorConfiguration
-
getExecSpec
Returns executable section of the CAS Processor configuration. It contains the name of executable program to be used when launching a separate process with CAS Processor running as Vinci service.- Specified by:
getExecSpec
in interfaceCasProcessorConfiguration
- Returns:
- - Execute object
-