Class CasProcessorConfigurationJAXBImpl
- java.lang.Object
-
- org.apache.uima.collection.impl.cpm.container.CasProcessorConfigurationJAXBImpl
-
- All Implemented Interfaces:
CasProcessorConfiguration
public class CasProcessorConfigurationJAXBImpl extends java.lang.Object implements CasProcessorConfiguration
A wrapper containing Cas Processor configuration. An instance of this class is associated with each Cas Processor.
-
-
Constructor Summary
Constructors Constructor Description CasProcessorConfigurationJAXBImpl(CpeCasProcessor aCasProcessorConfig, ResourceManager aResourceManager)Initializes instance and copies configuation from cpe descriptor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.StringgetActionOnError()Returns an action as String to identify an action to take in case of excessive Cas Processor errors.java.lang.StringgetActionOnMaxRestart()Returns an action as String to identify an action to take in case of excessive Cas Processor restarts.intgetBatchSize()Returns configured batch size setup for this Cas Processorjava.lang.StringgetDeploymentParameter(java.lang.String aDeployParameter)Returns a value for a given deployment parameterjava.util.ListgetDeploymentParameters()Returns a list of deployment parameters ssociated with this Cas Processorjava.lang.StringgetDeploymentType()Returns deployment type associated with this Cas Processor integrated local remotejava.net.URLgetDescriptorUrl()Returns descriptor associated with this Cas ProcessorintgetErrorRate()longgetErrorSampleSize()ExecutegetExecSpec()Returns executable section of the Cas Processor configuration.java.util.LinkedListgetFilter()Returns parsed filter expressions as List.java.lang.StringgetFilterString()Returns unparsed filter expressionjava.lang.String[]getKeysToDrop()Returns an array of types that should not be sent to Cas Processor.intgetMaxErrorCount()Returns max number of tolerated errorsintgetMaxRestartCount()Returns max number of Cas Processor restartsintgetMaxRetryCount()Returns max number of tries to process each bundle of CasintgetMaxTimeToWaitBetweenRetries()Returns how long to wait between resending CAS after failurejava.lang.StringgetName()Returns Cas Processor namelonggetTimeout()Returns the max amount of time the CPE will wait for Cas Processor reponse.booleanisJavaProcess()Returns true it the Cas Processor is written in java and will be run with java jvm.booleanisParallelizable()Returns if the Cas Processor is able to run in parallelbooleanreadOnly()Returns if the Cas Processor is read onlybooleanrunInSeparateProcess()Returns true if this Cas Processor will run in its own process
-
-
-
Constructor Detail
-
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 Detail
-
getMaxTimeToWaitBetweenRetries
public int getMaxTimeToWaitBetweenRetries()
Returns how long to wait between resending CAS after failure- Specified by:
getMaxTimeToWaitBetweenRetriesin 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
public java.lang.String getActionOnError()
Returns an action as String to identify an action to take in case of excessive Cas Processor errors.- continue
- terminate
- disable
- Specified by:
getActionOnErrorin interfaceCasProcessorConfiguration- Returns:
- - action
-
getActionOnMaxRestart
public java.lang.String getActionOnMaxRestart()
Returns an action as String to identify an action to take in case of excessive Cas Processor restarts.- continue
- terminate
- disable
- Specified by:
getActionOnMaxRestartin interfaceCasProcessorConfiguration- Returns:
- - action
-
getErrorRate
public int getErrorRate()
- Specified by:
getErrorRatein interfaceCasProcessorConfiguration
-
getErrorSampleSize
public long getErrorSampleSize()
- Specified by:
getErrorSampleSizein interfaceCasProcessorConfiguration
-
getMaxErrorCount
public int getMaxErrorCount()
Returns max number of tolerated errors- Specified by:
getMaxErrorCountin interfaceCasProcessorConfiguration- Returns:
- - max number of allowed errors
-
getMaxRestartCount
public int getMaxRestartCount()
Returns max number of Cas Processor restarts- Specified by:
getMaxRestartCountin interfaceCasProcessorConfiguration- Returns:
- - max number of restarts
-
getMaxRetryCount
public int getMaxRetryCount()
Returns max number of tries to process each bundle of Cas- Specified by:
getMaxRetryCountin interfaceCasProcessorConfiguration- Returns:
- - max retry count
-
getName
public java.lang.String getName()
Returns Cas Processor name- Specified by:
getNamein interfaceCasProcessorConfiguration- Returns:
- - Name
-
getTimeout
public long getTimeout()
Returns the max amount of time the CPE will wait for Cas Processor reponse.- Specified by:
getTimeoutin interfaceCasProcessorConfiguration- Returns:
- - value for timeout
-
getDeploymentParameters
public java.util.List getDeploymentParameters()
Returns a list of deployment parameters ssociated with this Cas Processor- Specified by:
getDeploymentParametersin interfaceCasProcessorConfiguration- Returns:
- - deployment paramaters as List
-
getDeploymentType
public java.lang.String getDeploymentType()
Returns deployment type associated with this Cas Processor- integrated
- local
- remote
- Specified by:
getDeploymentTypein interfaceCasProcessorConfiguration- Returns:
- - deployment type
-
getFilterString
public java.lang.String getFilterString()
Returns unparsed filter expression- Specified by:
getFilterStringin interfaceCasProcessorConfiguration- Returns:
- - fliter String
-
getFilter
public java.util.LinkedList getFilter() throws ResourceConfigurationExceptionReturns parsed filter expressions as List.- Specified by:
getFilterin interfaceCasProcessorConfiguration- Throws:
ResourceConfigurationException
-
getKeysToDrop
public java.lang.String[] getKeysToDrop() throws ResourceConfigurationExceptionReturns an array of types that should not be sent to Cas Processor. The drop types are defined in the cpe descriptor.- Specified by:
getKeysToDropin interfaceCasProcessorConfiguration- Throws:
ResourceConfigurationException
-
getBatchSize
public int getBatchSize()
Returns configured batch size setup for this Cas Processor- Specified by:
getBatchSizein interfaceCasProcessorConfiguration- Returns:
- - batch size
-
getDescriptorUrl
public java.net.URL getDescriptorUrl() throws ResourceConfigurationExceptionReturns descriptor associated with this Cas Processor- Specified by:
getDescriptorUrlin interfaceCasProcessorConfiguration- Returns:
- object that identifies location of descriptor
- Throws:
ResourceConfigurationException- if an import could not be resolved
-
getDeploymentParameter
public java.lang.String getDeploymentParameter(java.lang.String aDeployParameter)
Returns a value for a given deployment parameter- Specified by:
getDeploymentParameterin 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:
runInSeparateProcessin 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:
isJavaProcessin interfaceCasProcessorConfiguration
-
getExecSpec
public Execute 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:
getExecSpecin interfaceCasProcessorConfiguration- Returns:
- - Execute object
-
-