blob: 4370d80ac158005d1e93d918aa722e2fba8d4788 [file] [log] [blame]
ramvermaaf74a622018-07-31 18:25:39 +01001//
2// ============LICENSE_START=======================================================
3// Copyright (C) 2016-2018 Ericsson. All rights reserved.
4// ================================================================================
5// This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE
6// Full license text at https://creativecommons.org/licenses/by/4.0/legalcode
7//
8// SPDX-License-Identifier: CC-BY-4.0
9// ============LICENSE_END=========================================================
10//
11// @author Sven van der Meer (sven.van.der.meer@ericsson.com)
12//
13
14== The APEX Full Client
15The APEX Full Client combines the REST Editor, the Monitoring Client, and the Deployment Client into a single application.
16The standard way to use the APEX Full Client is via an installation of the __war__ file on a webserver.
17However, the Full Client can also be started via command line.
18This will start a Grizzly webserver with the __war__ deployed.
19Access to the Full Client is then via the provided URL
20
21On UNIX and Cygwin systems use:
22
23- `apexApps.sh full-client` - simply starts the webserver with the Full Client
24
25On Windows systems use:
26
27- `apexApps.bat full-client` - simply starts the webserver with the Full Client
28
29
30The option `-h` provides a help screen with all command line arguments.
31
32[source%nowrap,sh]
33----
liamfallona41c8772018-09-05 15:46:31 +010034usage: org.onap.policy.apex.client.full.rest.ApexServicesRestMain [options...]
35-h,--help outputs the usage of this command
36-p,--port <PORT> port to use for the Apex Services REST calls
37-t,--time-to-live <TIME_TO_LIVE> the amount of time in seconds that the server will run for before terminating
38
ramvermaaf74a622018-07-31 18:25:39 +010039----
40
41If the Full Client is started without any arguments the final messages will look similar to this:
42
43[source%nowrap,sh]
44----
liamfallona41c8772018-09-05 15:46:31 +010045Apex Editor REST endpoint (ApexServicesRestMain: Config=[ApexServicesRestParameters: URI=http://localhost:18989/apexservices/, TTL=-1sec], State=READY) starting at http://localhost:18989/apexservices/ . . .
46Sep 05, 2018 11:28:28 PM org.glassfish.grizzly.http.server.NetworkListener start
47INFO: Started listener bound to [localhost:18989]
48Sep 05, 2018 11:28:28 PM org.glassfish.grizzly.http.server.HttpServer start
ramvermaaf74a622018-07-31 18:25:39 +010049INFO: [HttpServer] Started.
50Apex Editor REST endpoint (ApexServicesRestMain: Config=[ApexServicesRestParameters: URI=http://localhost:18989/apexservices/, TTL=-1sec], State=RUNNING) started at http://localhost:18989/apexservices/
51----
52
53The last line states the URL on which the Monitoring Client can be accessed.
54The example above stated `http://localhost:18989/apexservices`.
55In a web browser use the URL `http://localhost:18989`.
56