ServiceContextImpl (Apache UIMA-AS Java SDK 2.8.1 User-Level API Documentation)

java.lang.Object
- org.apache.uima.resourceSpecifier.factory.impl.ServiceContextImpl

All Implemented Interfaces:: ServiceContext

public class ServiceContextImpl
extends Object
implements ServiceContext

The Class ServiceContextImpl.

Constructor Summary

Constructors
Constructor and Description
`ServiceContextImpl(String name, String description, String descriptor, String endpoint)` This class describes UIMA AS service.
`ServiceContextImpl(String name, String description, String descriptor, String endpoint, String brokerURL)`

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getBrokerURL()` Gets the broker url.
`int`	`getCasPoolSize()` Gets the cas pool size.
`Action`	`getCpCAdditionalAction()` Gets the cp c additional action.
`String`	`getDescription()` Gets the description.
`String`	`getDescriptor()` Gets the descriptor.
`String`	`getEndpoint()` Gets the endpoint.
`int`	`getInitialHeapSize()` Gets the initial heap size.
`String`	`getName()` Gets the name.
`int`	`getPrefetch()` Gets the prefetch.
`Action`	`getProcessErrorThresholdAction()` Gets the process error threshold action.
`int`	`getProcessErrorThresholdCount()` Gets the process error threshold count.
`int`	`getProcessErrorThresholdWindow()` Gets the process error threshold window.
`String`	`getProtocol()` Gets the protocol.
`String`	`getProvider()` Gets the provider.
`int`	`getScaleup()` Gets the scaleup.
`boolean`	`isAggregate()` Checks if is aggregate.
`boolean`	`isAsync()` Checks if is async.
`boolean`	`isCasMultiplier()` Checks if is cas multiplier.
`boolean`	`processParentLast()` Process parent last.
`void`	`setAggregate(boolean aggregate)` Sets the aggregate.
`void`	`setAsync(boolean async)` Sets the async.
`void`	`setBrokerURL(String brokerURL)` Sets the broker url.
`void`	`setCasMultiplier(boolean casMultiplier)` Sets the cas multiplier.
`void`	`setCasPoolSize(int casPoolSize)` Sets the cas pool size.
`void`	`setCpCAdditionalAction(Action action)` Sets the cp c additional action.
`void`	`setDescription(String description)` Sets the description.
`void`	`setDescriptor(String descriptor)` Sets the descriptor.
`void`	`setEndpoint(String endpoint)` Sets the endpoint.
`void`	`setInitialHeapSize(int initialHeapSize)` Sets the initial heap size.
`void`	`setName(String name)` Sets the name.
`void`	`setPrefetch(int prefetch)` Sets the prefetch.
`void`	`setProcessErrorThresholdAction(Action action)` Sets the process error threshold action.
`void`	`setProcessErrorThresholdCount(int thresholdCount)` Sets the process error threshold count.
`void`	`setProcessErrorThresholdWindow(int thresholdWindow)` Sets the process error threshold window.
`void`	`setProcessParentLast(boolean processParentLast)` Sets the process parent last.
`void`	`setProtocol(String protocol)` Sets the protocol.
`void`	`setProvider(String provider)` Sets the provider.
`void`	`setScaleup(int scaleUp)` Sets the scaleup.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ServiceContextImpl
```
public ServiceContextImpl(String name,
                  String description,
                  String descriptor,
                  String endpoint)
```
    This class describes UIMA AS service. The minimal information needed is the service name, description, the AnalysisEngine descriptor and the queue name. If not provided, the class uses defaults to fully describe the service.
    
    Parameters:
    name - - service name
    description - - service description
    descriptor - - analysis engine descriptor
    endpoint - - the name of of the service input queue
  - ServiceContextImpl
```
public ServiceContextImpl(String name,
                  String description,
                  String descriptor,
                  String endpoint,
                  String brokerURL)
```
- Method Detail
  - setName
```
public void setName(String name)
```
    Description copied from interface: ServiceContext
    
    Sets the name.
    
    Specified by:
    
    setName in interface ServiceContext
    
    Parameters:
    name - the new name
  - getName
```
public String getName()
```
    Description copied from interface: ServiceContext
    
    Gets the name.
    
    Specified by:
    
    getName in interface ServiceContext
    
    Returns:
    the name
  - setDescription
```
public void setDescription(String description)
```
    Description copied from interface: ServiceContext
    
    Sets the description.
    
    Specified by:
    
    setDescription in interface ServiceContext
    
    Parameters:
    description - the new description
  - getDescription
```
public String getDescription()
```
    Description copied from interface: ServiceContext
    
    Gets the description.
    
    Specified by:
    
    getDescription in interface ServiceContext
    
    Returns:
    the description
  - setDescriptor
```
public void setDescriptor(String descriptor)
```
    Description copied from interface: ServiceContext
    
    Sets the descriptor.
    
    Specified by:
    
    setDescriptor in interface ServiceContext
    
    Parameters:
    descriptor - the new descriptor
  - getDescriptor
```
public String getDescriptor()
```
    Description copied from interface: ServiceContext
    
    Gets the descriptor.
    
    Specified by:
    
    getDescriptor in interface ServiceContext
    
    Returns:
    the descriptor
  - setProtocol
```
public void setProtocol(String protocol)
```
    Description copied from interface: ServiceContext
    
    Sets the protocol.
    
    Specified by:
    
    setProtocol in interface ServiceContext
    
    Parameters:
    protocol - the new protocol
  - getProtocol
```
public String getProtocol()
```
    Description copied from interface: ServiceContext
    
    Gets the protocol.
    
    Specified by:
    
    getProtocol in interface ServiceContext
    
    Returns:
    the protocol
  - setProvider
```
public void setProvider(String provider)
```
    Description copied from interface: ServiceContext
    
    Sets the provider.
    
    Specified by:
    
    setProvider in interface ServiceContext
    
    Parameters:
    provider - the new provider
  - getProvider
```
public String getProvider()
```
    Description copied from interface: ServiceContext
    
    Gets the provider.
    
    Specified by:
    
    getProvider in interface ServiceContext
    
    Returns:
    the provider
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from interface: ServiceContext
    
    Sets the endpoint.
    
    Specified by:
    
    setEndpoint in interface ServiceContext
    
    Parameters:
    endpoint - the new endpoint
  - getEndpoint
```
public String getEndpoint()
```
    Description copied from interface: ServiceContext
    
    Gets the endpoint.
    
    Specified by:
    
    getEndpoint in interface ServiceContext
    
    Returns:
    the endpoint
  - setBrokerURL
```
public void setBrokerURL(String brokerURL)
```
    Description copied from interface: ServiceContext
    
    Sets the broker url.
    
    Specified by:
    
    setBrokerURL in interface ServiceContext
    
    Parameters:
    brokerURL - the new broker url
  - getBrokerURL
```
public String getBrokerURL()
```
    Description copied from interface: ServiceContext
    
    Gets the broker url.
    
    Specified by:
    
    getBrokerURL in interface ServiceContext
    
    Returns:
    the broker url
  - setPrefetch
```
public void setPrefetch(int prefetch)
```
    Description copied from interface: ServiceContext
    
    Sets the prefetch.
    
    Specified by:
    
    setPrefetch in interface ServiceContext
    
    Parameters:
    prefetch - the new prefetch
  - getPrefetch
```
public int getPrefetch()
```
    Description copied from interface: ServiceContext
    
    Gets the prefetch.
    
    Specified by:
    
    getPrefetch in interface ServiceContext
    
    Returns:
    the prefetch
  - setScaleup
```
public void setScaleup(int scaleUp)
```
    Description copied from interface: ServiceContext
    
    Sets the scaleup.
    
    Specified by:
    
    setScaleup in interface ServiceContext
    
    Parameters:
    scaleUp - the new scaleup
  - getScaleup
```
public int getScaleup()
```
    Description copied from interface: ServiceContext
    
    Gets the scaleup.
    
    Specified by:
    
    getScaleup in interface ServiceContext
    
    Returns:
    the scaleup
  - setCasMultiplier
```
public void setCasMultiplier(boolean casMultiplier)
```
    Description copied from interface: ServiceContext
    
    Sets the cas multiplier.
    
    Specified by:
    
    setCasMultiplier in interface ServiceContext
    
    Parameters:
    casMultiplier - the new cas multiplier
  - isCasMultiplier
```
public boolean isCasMultiplier()
```
    Description copied from interface: ServiceContext
    
    Checks if is cas multiplier.
    
    Specified by:
    
    isCasMultiplier in interface ServiceContext
    
    Returns:
    true, if is cas multiplier
  - setAggregate
```
public void setAggregate(boolean aggregate)
```
    Description copied from interface: ServiceContext
    
    Sets the aggregate.
    
    Specified by:
    
    setAggregate in interface ServiceContext
    
    Parameters:
    aggregate - the new aggregate
  - isAggregate
```
public boolean isAggregate()
```
    Description copied from interface: ServiceContext
    
    Checks if is aggregate.
    
    Specified by:
    
    isAggregate in interface ServiceContext
    
    Returns:
    true, if is aggregate
  - setCasPoolSize
```
public void setCasPoolSize(int casPoolSize)
```
    Description copied from interface: ServiceContext
    
    Sets the cas pool size.
    
    Specified by:
    
    setCasPoolSize in interface ServiceContext
    
    Parameters:
    casPoolSize - the new cas pool size
  - getCasPoolSize
```
public int getCasPoolSize()
```
    Description copied from interface: ServiceContext
    
    Gets the cas pool size.
    
    Specified by:
    
    getCasPoolSize in interface ServiceContext
    
    Returns:
    the cas pool size
  - setInitialHeapSize
```
public void setInitialHeapSize(int initialHeapSize)
```
    Description copied from interface: ServiceContext
    
    Sets the initial heap size.
    
    Specified by:
    
    setInitialHeapSize in interface ServiceContext
    
    Parameters:
    initialHeapSize - the new initial heap size
  - getInitialHeapSize
```
public int getInitialHeapSize()
```
    Description copied from interface: ServiceContext
    
    Gets the initial heap size.
    
    Specified by:
    
    getInitialHeapSize in interface ServiceContext
    
    Returns:
    the initial heap size
  - setProcessParentLast
```
public void setProcessParentLast(boolean processParentLast)
```
    Description copied from interface: ServiceContext
    
    Sets the process parent last.
    
    Specified by:
    
    setProcessParentLast in interface ServiceContext
    
    Parameters:
    processParentLast - the new process parent last
  - processParentLast
```
public boolean processParentLast()
```
    Description copied from interface: ServiceContext
    
    Process parent last.
    
    Specified by:
    
    processParentLast in interface ServiceContext
    
    Returns:
    true, if successful
  - setProcessErrorThresholdCount
```
public void setProcessErrorThresholdCount(int thresholdCount)
```
    Description copied from interface: ServiceContext
    
    Sets the process error threshold count.
    
    Specified by:
    
    setProcessErrorThresholdCount in interface ServiceContext
    
    Parameters:
    thresholdCount - the new process error threshold count
  - getProcessErrorThresholdCount
```
public int getProcessErrorThresholdCount()
```
    Description copied from interface: ServiceContext
    
    Gets the process error threshold count.
    
    Specified by:
    
    getProcessErrorThresholdCount in interface ServiceContext
    
    Returns:
    the process error threshold count
  - setProcessErrorThresholdWindow
```
public void setProcessErrorThresholdWindow(int thresholdWindow)
```
    Description copied from interface: ServiceContext
    
    Sets the process error threshold window.
    
    Specified by:
    
    setProcessErrorThresholdWindow in interface ServiceContext
    
    Parameters:
    thresholdWindow - the new process error threshold window
  - getProcessErrorThresholdWindow
```
public int getProcessErrorThresholdWindow()
```
    Description copied from interface: ServiceContext
    
    Gets the process error threshold window.
    
    Specified by:
    
    getProcessErrorThresholdWindow in interface ServiceContext
    
    Returns:
    the process error threshold window
  - setProcessErrorThresholdAction
```
public void setProcessErrorThresholdAction(Action action)
```
    Description copied from interface: ServiceContext
    
    Sets the process error threshold action.
    
    Specified by:
    
    setProcessErrorThresholdAction in interface ServiceContext
    
    Parameters:
    action - the new process error threshold action
  - getProcessErrorThresholdAction
```
public Action getProcessErrorThresholdAction()
```
    Description copied from interface: ServiceContext
    
    Gets the process error threshold action.
    
    Specified by:
    
    getProcessErrorThresholdAction in interface ServiceContext
    
    Returns:
    the process error threshold action
  - setCpCAdditionalAction
```
public void setCpCAdditionalAction(Action action)
```
    Description copied from interface: ServiceContext
    
    Sets the cp c additional action.
    
    Specified by:
    
    setCpCAdditionalAction in interface ServiceContext
    
    Parameters:
    action - the new cp c additional action
  - getCpCAdditionalAction
```
public Action getCpCAdditionalAction()
```
    Description copied from interface: ServiceContext
    
    Gets the cp c additional action.
    
    Specified by:
    
    getCpCAdditionalAction in interface ServiceContext
    
    Returns:
    the cp c additional action
  - setAsync
```
public void setAsync(boolean async)
```
    Description copied from interface: ServiceContext
    
    Sets the async.
    
    Specified by:
    
    setAsync in interface ServiceContext
    
    Parameters:
    async - the new async
  - isAsync
```
public boolean isAsync()
```
    Description copied from interface: ServiceContext
    
    Checks if is async.
    
    Specified by:
    
    isAsync in interface ServiceContext
    
    Returns:
    true, if is async

Class ServiceContextImpl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ServiceContextImpl

ServiceContextImpl

Method Detail

setName

getName

setDescription

getDescription

setDescriptor

getDescriptor

setProtocol

getProtocol

setProvider

getProvider

setEndpoint

getEndpoint

setBrokerURL

getBrokerURL

setPrefetch

getPrefetch

setScaleup

getScaleup

setCasMultiplier

isCasMultiplier

setAggregate

isAggregate

setCasPoolSize

getCasPoolSize

setInitialHeapSize

getInitialHeapSize

setProcessParentLast

processParentLast

setProcessErrorThresholdCount

getProcessErrorThresholdCount

setProcessErrorThresholdWindow

getProcessErrorThresholdWindow

setProcessErrorThresholdAction

getProcessErrorThresholdAction

setCpCAdditionalAction

getCpCAdditionalAction

setAsync

isAsync