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.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate String
private String
private int
private List
private String
private CpeComponentDescriptor
private int
private long
private String
private boolean
private JavaApplication
private int
private int
private int
private String
private NonJavaApplication
private boolean
private boolean
private ResourceManager
private boolean
private long
private int
-
Constructor Summary
ConstructorsConstructorDescriptionCasProcessorConfigurationJAXBImpl
(CpeCasProcessor aCasProcessorConfig, ResourceManager aResourceManager) Initializes instance and copies configuation from cpe descriptor. -
Method Summary
Modifier and TypeMethodDescriptionprivate void
addBatchSize
(CpeCasProcessor aCasProcessorConfig) Copies batch size associated with this Cas Processorprivate void
addDeploymentParameters
(CpeCasProcessor aCasProcessorConfig) Copies deployment parameters associated with this Cas Processor These parameters are used to construct appropriate command line for launching the Cas Processor in external processprivate void
addDeploymentType
(CpeCasProcessor aCasProcessorConfig) Copies deployment type associated with this Cas Processorprivate void
addDescriptor
(CpeCasProcessor aCasProcessorConfig) Copies path of the Cas Processor descriptor.private void
addErrorHandling
(CpeCasProcessor aCasProcessorConfig) Copies Error handling settingsprivate void
addFiltering
(CpeCasProcessor aCasProcessorConfig) Copies filter expression used during processing.private void
addIsJavaProcess
(CpeCasProcessor aCasProcessorConfig) Determines if this Cas Processor should run in java jvm.private void
addRunInSeparateProcess
(CpeCasProcessor aCasProcessorConfig) Copies runtime informationReturns 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 ssociated with this Cas ProcessorReturns deployment type associated with this Cas ProcessorReturns descriptor associated with this Cas Processorint
long
Returns executable section of the Cas Processor configuration.Returns parsed filter expressions as List.Returns unparsed filter expressionString[]
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 resending CAS after failuregetName()
Returns Cas Processor namelong
Returns the max amount of time the CPE will wait for Cas Processor reponse.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 processprivate boolean
validActionOnError
(String aActionOnError) Varifies action String.
-
Field Details
-
actionOnMaxError
-
actionOnMaxRestarts
-
name
-
descriptor
-
deploymentType
-
filterString
-
errorSampleSize
private long errorSampleSize -
timeOut
private long timeOut -
errorRate
private int errorRate -
maxErrorThreshold
private int maxErrorThreshold -
maxRestartThreshold
private int maxRestartThreshold -
maxRetryThreshold
private int maxRetryThreshold -
batchSize
private int batchSize -
runInSeparateProcess
private boolean runInSeparateProcess -
isJavaProcess
private boolean isJavaProcess -
nonJavaApp
-
javaApp
-
deploymentParameters
-
waitTimeBetweenRestarts
private int waitTimeBetweenRestarts -
parallelizable
private boolean parallelizable -
readOnly
private boolean readOnly -
resourceManager
-
-
Constructor Details
-
CasProcessorConfigurationJAXBImpl
public CasProcessorConfigurationJAXBImpl(CpeCasProcessor aCasProcessorConfig, ResourceManager aResourceManager) throws ResourceConfigurationException Initializes instance and copies configuation 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 resending 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
-
addRunInSeparateProcess
Copies runtime information- Parameters:
aJaxbCasProcessorConfig
- - configuration object containing Cas Processor configuration
-
addIsJavaProcess
Determines if this Cas Processor should run in java jvm.- Parameters:
aJaxbCasProcessorConfig
- - configuration object containing Cas Processor configuration
-
addErrorHandling
private void addErrorHandling(CpeCasProcessor aCasProcessorConfig) throws ResourceConfigurationException Copies Error handling settings- Parameters:
aJaxbCasProcessorConfig
- - configuration object containing Cas Processor configuration- Throws:
ResourceConfigurationException
-
addDeploymentParameters
private void addDeploymentParameters(CpeCasProcessor aCasProcessorConfig) throws ResourceConfigurationException Copies deployment parameters associated with this Cas Processor These parameters are used to construct appropriate command line for launching the Cas Processor in external process- Parameters:
aJaxbCasProcessorConfig
- - configuration object containing Cas Processor configuration- Throws:
ResourceConfigurationException
-
addDeploymentType
private void addDeploymentType(CpeCasProcessor aCasProcessorConfig) throws ResourceConfigurationException Copies deployment type associated with this Cas Processor- Parameters:
aJaxbCasProcessorConfig
- - - configuration object containing Cas Processor configuration- Throws:
ResourceConfigurationException
- -
-
addFiltering
private void addFiltering(CpeCasProcessor aCasProcessorConfig) throws ResourceConfigurationException Copies filter expression used during processing.- Parameters:
aJaxbCasProcessorConfig
- - configuration object containing Cas Processor configuration- Throws:
ResourceConfigurationException
-
addBatchSize
private void addBatchSize(CpeCasProcessor aCasProcessorConfig) throws ResourceConfigurationException Copies batch size associated with this Cas Processor- Parameters:
aJaxbCasProcessorConfig
- - configuration object containing Cas Processor configuration- Throws:
ResourceConfigurationException
-
addDescriptor
private void addDescriptor(CpeCasProcessor aCasProcessorConfig) throws ResourceConfigurationException Copies path of the Cas Processor descriptor.- Parameters:
aJaxbCasProcessorConfig
- - configuration object holding path to the descriptor- Throws:
ResourceConfigurationException
- -
-
validActionOnError
Varifies action String. It must any of the three possible values:- continue
- terminate
- disable
- kill-pipeline
- Parameters:
aActionOnError
- - action string to verify- Returns:
- - true if action is valid, 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 reponse.- Specified by:
getTimeout
in interfaceCasProcessorConfiguration
- Returns:
- - value for timeout
-
getDeploymentParameters
Returns a list of deployment parameters ssociated with this Cas Processor- Specified by:
getDeploymentParameters
in interfaceCasProcessorConfiguration
- Returns:
- - deployment paramaters as List
-
getDeploymentType
Returns deployment type associated with this Cas Processor- integrated
- local
- remote
- Specified by:
getDeploymentType
in interfaceCasProcessorConfiguration
- Returns:
- - deployment type
-
getFilterString
Returns unparsed filter expression- Specified by:
getFilterString
in interfaceCasProcessorConfiguration
- Returns:
- - fliter String
-
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 seperate 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 seperate process with Cas Processor running as vinci service.- Specified by:
getExecSpec
in interfaceCasProcessorConfiguration
- Returns:
- - Execute object
-