ManagedProcess (Apache UIMA DUCC: uima-ducc-agent 2.2.0 API)

java.lang.Object
- org.apache.uima.ducc.agent.launcher.ManagedProcess

All Implemented Interfaces:

Serializable, Process
```
public class ManagedProcess
extends Object
implements Process
```
See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ManagedProcess.ProcessType

static class ManagedProcess.StopPriority

Nested Classes
Modifier and Type	Class and Description
`static class`	`ManagedProcess.ProcessType`
`static class`	`ManagedProcess.StopPriority`

Field Summary

Fields
Modifier and Type Field and Description

protected ProcessStreamConsumer stdErrReader

protected ProcessStreamConsumer stdOutReader

Fields
Modifier and Type	Field and Description
`protected ProcessStreamConsumer`	`stdErrReader`
`protected ProcessStreamConsumer`	`stdOutReader`

Constructor Summary

Constructors
Constructor and Description
`ManagedProcess(org.apache.uima.ducc.transport.event.common.IDuccProcess process, org.apache.uima.ducc.transport.cmdline.ICommandLine commandLine)`
`ManagedProcess(org.apache.uima.ducc.transport.event.common.IDuccProcess process, org.apache.uima.ducc.transport.cmdline.ICommandLine commandLine, boolean agentProcess)`
`ManagedProcess(org.apache.uima.ducc.transport.event.common.IDuccProcess process, org.apache.uima.ducc.transport.cmdline.ICommandLine commandLine, ProcessLifecycleObserver observer, org.apache.uima.ducc.common.utils.DuccLogger logger, org.apache.uima.ducc.transport.event.common.ProcessMemoryAssignment processMemoryAssignment)`
`ManagedProcess(Process process, boolean agentProcess)`
`ManagedProcess(Process process, boolean agentProcess, String correlationId)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`awaitPid()`
`boolean`	`doKill()`
`void`	`drainProcessStreams(Process process, org.apache.uima.ducc.common.utils.DuccLogger logger, PrintStream pStream, boolean isKillCmd)`
`void`	`failed()`
`String`	`getAbsoluteLogPath()`
`String`	`getAgentLogPath()`
`String`	`getClientId()`
`List<String>`	`getCommand()`
`org.apache.uima.ducc.transport.cmdline.ICommandLine`	`getCommandLine()`
`String`	`getDescription()`
`org.apache.uima.ducc.common.utils.id.DuccId`	`getDuccId()`
`org.apache.uima.ducc.transport.event.common.IDuccProcess`	`getDuccProcess()`
`Throwable`	`getExceptionStackTrace()`
`Future<?>`	`getFuture()`
`Process`	`getInstance()` Return current state of this object.
`String`	`getLogPath()`
`long`	`getMaxSwapThreshold()`
`LinuxProcessMetricsProcessor`	`getMetricsProcessor()`
`String`	`getNodeIp()`
`String`	`getNodeName()`
`String`	`getOwner()`
`String`	`getParent()`
`String`	`getPid()`
`String`	`getPort()`
`String`	`getProcessId()`
`org.apache.uima.ducc.transport.event.common.IDuccStandardInfo`	`getProcessInfo()`
`org.apache.uima.ducc.transport.event.common.ProcessMemoryAssignment`	`getProcessMemoryAssignment()`
`ManagedProcess.ProcessType`	`getProcessType()`
`String`	`getSocketEndpoint()`
`ManagedServiceInfo.ServiceState`	`getStatus()`
`ManagedProcess.StopPriority`	`getStopPriority()`
`org.apache.uima.ducc.common.utils.id.DuccId`	`getWorkDuccId()`
`boolean`	`isAgentProcess()`
`boolean`	`isAttached()`
`boolean`	`isDestroyed()`
`boolean`	`isJd()`
`boolean`	`isStopping()`
`void`	`kill()`
`boolean`	`killAfterLaunch()`
`void`	`killAfterLaunch(boolean killAfterLaunch)`
`void`	`notifyProcessObserver(org.apache.uima.ducc.transport.event.common.IProcessState.ProcessState state)`
`void`	`releasePidLatch()`
`void`	`setAbsoluteLogPath(String absoluteLogPath)`
`void`	`setAgentLogPath(String logPath)`
`void`	`setAttached()`
`void`	`setClientId(String clientId)`
`void`	`setCommand(List<String> commandToRun)`
`void`	`setDescription(String description)`
`void`	`setExceptionStackTrace(Throwable exceptionStackTrace)`
`void`	`setFuture(Future<?> future)`
`void`	`setIsJD()`
`void`	`setLogPath(String logPath)`
`void`	`setLogStream(OutputStream os)`
`void`	`setMaxSwapThreshold(long maxSwapThreshold)`
`void`	`setMetricsProcessor(LinuxProcessMetricsProcessor processor)`
`void`	`setNodeIp(String nodeIp)`
`void`	`setNodeName(String nodeName)`
`void`	`setOSProcess(Process process)`
`void`	`setParent(String parent)`
`void`	`setPid(String pid)`
`void`	`setPort(String port)`
`void`	`setProcessId(String processId)`
`void`	`setProcessInfo(org.apache.uima.ducc.transport.event.common.IDuccStandardInfo processInfo)`
`void`	`setProcessType(ManagedProcess.ProcessType processType)`
`void`	`setSocketEndpoint(String socketEndpoint)`
`void`	`setStopping()`
`void`	`setStopPriority(ManagedProcess.StopPriority sp)`
`void`	`setWorkDuccId(org.apache.uima.ducc.common.utils.id.DuccId workDuccId)`
`void`	`startInitializationTimer(long timeout)`
`void`	`stop()`
`void`	`stopInitializationTimer()` Stops service initialization timer and starts a new timer that will cleanup UIMA pipeline initialization stats.
`void`	`terminateRemoteProcess()`
`void`	`waitFor()`

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

Field Detail

stdOutReader

protected transient ProcessStreamConsumer stdOutReader

stdErrReader

protected transient ProcessStreamConsumer stdErrReader

Constructor Detail

ManagedProcess

public ManagedProcess(org.apache.uima.ducc.transport.event.common.IDuccProcess process,
              org.apache.uima.ducc.transport.cmdline.ICommandLine commandLine)

ManagedProcess

public ManagedProcess(org.apache.uima.ducc.transport.event.common.IDuccProcess process,
              org.apache.uima.ducc.transport.cmdline.ICommandLine commandLine,
              boolean agentProcess)

ManagedProcess

public ManagedProcess(org.apache.uima.ducc.transport.event.common.IDuccProcess process,
              org.apache.uima.ducc.transport.cmdline.ICommandLine commandLine,
              ProcessLifecycleObserver observer,
              org.apache.uima.ducc.common.utils.DuccLogger logger,
              org.apache.uima.ducc.transport.event.common.ProcessMemoryAssignment processMemoryAssignment)

ManagedProcess

public ManagedProcess(Process process,
              boolean agentProcess,
              String correlationId)

ManagedProcess

public ManagedProcess(Process process,
              boolean agentProcess)

Method Detail

setMetricsProcessor

public void setMetricsProcessor(LinuxProcessMetricsProcessor processor)

setStopPriority

public void setStopPriority(ManagedProcess.StopPriority sp)

getStopPriority

public ManagedProcess.StopPriority getStopPriority()

getMetricsProcessor

public LinuxProcessMetricsProcessor getMetricsProcessor()

doKill
```
public boolean doKill()
```

kill
```
public void kill()
```

setStopping
```
public void setStopping()
```

isStopping
```
public boolean isStopping()
```

setWorkDuccId

public void setWorkDuccId(org.apache.uima.ducc.common.utils.id.DuccId workDuccId)

getWorkDuccId

public org.apache.uima.ducc.common.utils.id.DuccId getWorkDuccId()

getDuccId

public org.apache.uima.ducc.common.utils.id.DuccId getDuccId()

setParent
```
public void setParent(String parent)
```
Specified by:

setParent in interface Process

getParent
```
public String getParent()
```
Specified by:

getParent in interface Process

setClientId
```
public void setClientId(String clientId)
```
Specified by:

setClientId in interface Process

getClientId
```
public String getClientId()
```
Specified by:

getClientId in interface Process

isAttached
```
public boolean isAttached()
```
Specified by:

isAttached in interface Process

setAttached
```
public void setAttached()
```
Specified by:

setAttached in interface Process

getNodeName
```
public String getNodeName()
```
Specified by:

getNodeName in interface Process

setNodeName
```
public void setNodeName(String nodeName)
```
Specified by:

setNodeName in interface Process

getNodeIp
```
public String getNodeIp()
```
Specified by:

getNodeIp in interface Process

setNodeIp
```
public void setNodeIp(String nodeIp)
```
Specified by:

setNodeIp in interface Process

getInstance
```
public Process getInstance()
```
Return current state of this object.

Returns:
Process - process object

getProcessType

public ManagedProcess.ProcessType getProcessType()

setProcessType

public void setProcessType(ManagedProcess.ProcessType processType)

setLogStream
```
public void setLogStream(OutputStream os)
```
Specified by:

setLogStream in interface Process

isAgentProcess
```
public boolean isAgentProcess()
```
Specified by:

isAgentProcess in interface Process

setLogPath
```
public void setLogPath(String logPath)
```
Specified by:

setLogPath in interface Process

Parameters:
logPath - the uimaLogPath to set

getLogPath
```
public String getLogPath()
```
Specified by:

getLogPath in interface Process

Returns:
the stdErrLogPath

setAgentLogPath
```
public void setAgentLogPath(String logPath)
```
Specified by:

setAgentLogPath in interface Process

getAgentLogPath
```
public String getAgentLogPath()
```
Specified by:

getAgentLogPath in interface Process

Returns:
the stdErrLogPath

getOwner
```
public String getOwner()
```
Returns:
the owner

setOSProcess

public void setOSProcess(Process process)

drainProcessStreams

public void drainProcessStreams(Process process,
                       org.apache.uima.ducc.common.utils.DuccLogger logger,
                       PrintStream pStream,
                       boolean isKillCmd)

getStatus

public ManagedServiceInfo.ServiceState getStatus()

Returns:: the state

getPid
```
public String getPid()
```
Specified by:

getPid in interface Process

Returns:
the pid

setPid
```
public void setPid(String pid)
```
Specified by:

setPid in interface Process

Parameters:
pid - the pid to set

awaitPid
```
public void awaitPid()
```

releasePidLatch
```
public void releasePidLatch()
```

getCommand
```
public List<String> getCommand()
```
Specified by:

getCommand in interface Process

Returns:
the command

setCommand
```
public void setCommand(List<String> commandToRun)
```
Parameters:
commandToRun - the command as List

getProcessId
```
public String getProcessId()
```
Specified by:

getProcessId in interface Process

Returns:
the processCorrelationId

setProcessId
```
public void setProcessId(String processId)
```
Specified by:

setProcessId in interface Process

Parameters:
processId - the processId to set

getPort
```
public String getPort()
```
Specified by:

getPort in interface Process

Returns:
the jmxPort

setPort
```
public void setPort(String port)
```
Specified by:

setPort in interface Process

Parameters:
port - the jmxPort to set

terminateRemoteProcess

public void terminateRemoteProcess()
                            throws Exception

Throws:: Exception

failed
```
public void failed()
```

stop
```
public void stop()
```

waitFor

public void waitFor()
             throws InterruptedException

Throws:: InterruptedException

isDestroyed
```
public boolean isDestroyed()
```

getAbsoluteLogPath
```
public String getAbsoluteLogPath()
```
Specified by:

getAbsoluteLogPath in interface Process

setAbsoluteLogPath
```
public void setAbsoluteLogPath(String absoluteLogPath)
```
Specified by:

setAbsoluteLogPath in interface Process

getDescription
```
public String getDescription()
```
Specified by:

getDescription in interface Process

setDescription
```
public void setDescription(String description)
```
Specified by:

setDescription in interface Process

getExceptionStackTrace
```
public Throwable getExceptionStackTrace()
```
Specified by:

getExceptionStackTrace in interface Process

setExceptionStackTrace
```
public void setExceptionStackTrace(Throwable exceptionStackTrace)
```
Specified by:

setExceptionStackTrace in interface Process

getCommandLine

public org.apache.uima.ducc.transport.cmdline.ICommandLine getCommandLine()

Returns:: the processSpecification

getDuccProcess

public org.apache.uima.ducc.transport.event.common.IDuccProcess getDuccProcess()

Returns:: the duccProcess

notifyProcessObserver

public void notifyProcessObserver(org.apache.uima.ducc.transport.event.common.IProcessState.ProcessState state)

startInitializationTimer

public void startInitializationTimer(long timeout)

stopInitializationTimer
```
public void stopInitializationTimer()
```
Stops service initialization timer and starts a new timer that will cleanup UIMA pipeline initialization stats. These states are only needed during the initialization of a service.

getProcessInfo

public org.apache.uima.ducc.transport.event.common.IDuccStandardInfo getProcessInfo()

setProcessInfo

public void setProcessInfo(org.apache.uima.ducc.transport.event.common.IDuccStandardInfo processInfo)

killAfterLaunch
```
public boolean killAfterLaunch()
```

killAfterLaunch

public void killAfterLaunch(boolean killAfterLaunch)

getFuture
```
public Future<?> getFuture()
```

setFuture

public void setFuture(Future<?> future)

getProcessMemoryAssignment

public org.apache.uima.ducc.transport.event.common.ProcessMemoryAssignment getProcessMemoryAssignment()

getSocketEndpoint
```
public String getSocketEndpoint()
```

setSocketEndpoint

public void setSocketEndpoint(String socketEndpoint)

getMaxSwapThreshold
```
public long getMaxSwapThreshold()
```

setMaxSwapThreshold

public void setMaxSwapThreshold(long maxSwapThreshold)

setIsJD
```
public void setIsJD()
```

isJd
```
public boolean isJd()
```

Class ManagedProcess

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

stdOutReader

stdErrReader

Constructor Detail

ManagedProcess

ManagedProcess

ManagedProcess

ManagedProcess

ManagedProcess

Method Detail

setMetricsProcessor

setStopPriority

getStopPriority

getMetricsProcessor

doKill

kill

setStopping

isStopping

setWorkDuccId

getWorkDuccId

getDuccId

setParent

getParent

setClientId

getClientId

isAttached

setAttached

getNodeName

setNodeName

getNodeIp

setNodeIp

getInstance

getProcessType

setProcessType

setLogStream

isAgentProcess

setLogPath

getLogPath

setAgentLogPath

getAgentLogPath

getOwner

setOSProcess

drainProcessStreams

getStatus

getPid

setPid

awaitPid

releasePidLatch

getCommand

setCommand

getProcessId

setProcessId

getPort

setPort

terminateRemoteProcess

failed

stop

waitFor

isDestroyed

getAbsoluteLogPath

setAbsoluteLogPath

getDescription

setDescription

getExceptionStackTrace

setExceptionStackTrace

getCommandLine

getDuccProcess

notifyProcessObserver

startInitializationTimer

stopInitializationTimer

getProcessInfo

setProcessInfo

killAfterLaunch

killAfterLaunch