blob: 4370d80ac158005d1e93d918aa722e2fba8d4788 [file] [log] [blame]
//
// ============LICENSE_START=======================================================
// Copyright (C) 2016-2018 Ericsson. All rights reserved.
// ================================================================================
// This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE
// Full license text at https://creativecommons.org/licenses/by/4.0/legalcode
//
// SPDX-License-Identifier: CC-BY-4.0
// ============LICENSE_END=========================================================
//
// @author Sven van der Meer (sven.van.der.meer@ericsson.com)
//
== The APEX Full Client
The APEX Full Client combines the REST Editor, the Monitoring Client, and the Deployment Client into a single application.
The standard way to use the APEX Full Client is via an installation of the __war__ file on a webserver.
However, the Full Client can also be started via command line.
This will start a Grizzly webserver with the __war__ deployed.
Access to the Full Client is then via the provided URL
On UNIX and Cygwin systems use:
- `apexApps.sh full-client` - simply starts the webserver with the Full Client
On Windows systems use:
- `apexApps.bat full-client` - simply starts the webserver with the Full Client
The option `-h` provides a help screen with all command line arguments.
[source%nowrap,sh]
----
usage: org.onap.policy.apex.client.full.rest.ApexServicesRestMain [options...]
-h,--help outputs the usage of this command
-p,--port <PORT> port to use for the Apex Services REST calls
-t,--time-to-live <TIME_TO_LIVE> the amount of time in seconds that the server will run for before terminating
----
If the Full Client is started without any arguments the final messages will look similar to this:
[source%nowrap,sh]
----
Apex Editor REST endpoint (ApexServicesRestMain: Config=[ApexServicesRestParameters: URI=http://localhost:18989/apexservices/, TTL=-1sec], State=READY) starting at http://localhost:18989/apexservices/ . . .
Sep 05, 2018 11:28:28 PM org.glassfish.grizzly.http.server.NetworkListener start
INFO: Started listener bound to [localhost:18989]
Sep 05, 2018 11:28:28 PM org.glassfish.grizzly.http.server.HttpServer start
INFO: [HttpServer] Started.
Apex Editor REST endpoint (ApexServicesRestMain: Config=[ApexServicesRestParameters: URI=http://localhost:18989/apexservices/, TTL=-1sec], State=RUNNING) started at http://localhost:18989/apexservices/
----
The last line states the URL on which the Monitoring Client can be accessed.
The example above stated `http://localhost:18989/apexservices`.
In a web browser use the URL `http://localhost:18989`.