|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.uima.ducc.cli.CliBase
org.apache.uima.ducc.cli.DuccServiceApi
public class DuccServiceApi
Handle registered services. This class is also the implementation of the DUCC service CLI which internally uses its API to implement itself. Details on the DUCC service CLI are found in theDUCC CLI reference.
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface org.apache.uima.ducc.cli.IUiOptions |
---|
org.apache.uima.ducc.cli.IUiOptions.ClasspathOrderParms, org.apache.uima.ducc.cli.IUiOptions.UiOption |
Field Summary |
---|
Fields inherited from interface org.apache.uima.ducc.cli.IUiOptions |
---|
help_width |
Constructor Summary | |
---|---|
DuccServiceApi(IDuccCallback cb)
|
Method Summary | |
---|---|
boolean |
execute()
All extenders must implement execute - this method does whatever processing on the input is needed and passes the CLI request to the internal DUCC processes. |
static void |
main(String[] args)
This is the main entrypoint, used by the executable jars and callable directly from the command line. |
IServiceReply |
modify(String[] args)
The service 'modify' command is used to change various aspects of a registered service without the need to reregister it. |
IServiceReply |
query(String[] args)
The query API is used to query the status of services known to the service manager. |
IServiceReply |
register(String[] args)
The register API is used to register a service with the service manager. |
IServiceReply |
start(String[] args)
The start API is used to start one or more instances of a registered service. |
IServiceReply |
stop(String[] args)
The stop API is used to stop one or more service instances. |
IServiceReply |
unregister(String[] args)
The unregister API is used to unregister a service. |
Methods inherited from class org.apache.uima.ducc.cli.CliBase |
---|
getDuccId, getReturnCode, isConsoleAttached, makeOptions, setProperty, waitForCompletion |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DuccServiceApi(IDuccCallback cb)
Method Detail |
---|
public IServiceReply register(String[] args) throws Exception
args
- String rray of arguments as described in the DUCC CLI reference.
IServiceReply
object with register status.
Exception
public IServiceReply unregister(String[] args) throws Exception
args
- String array of arguments as described in the DUCC CLI reference.
IServiceReply
object with unregister reply status.
Exception
public IServiceReply start(String[] args) throws Exception
args
- String array of arguments as described in the DUCC CLI reference.
IServiceReply
object with start reply status.
Exception
public IServiceReply stop(String[] args) throws Exception
args
- String array of arguments as described in the DUCC CLI reference.
IServiceReply
object with stop status.
Exception
public IServiceReply modify(String[] args) throws Exception
args
- String array of arguments as described in the DUCC CLI reference.
IServiceReply
object with modify status.
Exception
public IServiceReply query(String[] args) throws Exception
args
- String array of arguments as described in the DUCC CLI reference.
IServiceReply
object with query results status.
Exception
public boolean execute()
CliBase
execute
in class CliBase
public static void main(String[] args)
args
- arguments as described in the DUCC CLI reference.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |