Module org.yamcs.web

Package org.yamcs.web

Class WebFileDeployer

java.lang.Object

org.yamcs.web.WebFileDeployer

public class WebFileDeployer
extends Object

Deploys web files from a source to a target directory, while tweaking some files.

The source is determined in order to be either:

• (1) Check system property yamcs.web.staticRoot
• (2) Check a property in etc/yamcs.yaml
• (3) Load from classpath (packaged inside yamcs-web jar)

A production deployment will use a precompiled web application, and use (3).

(1) and (2) are intended for enabling local development on the web sources. (1) allows doing so without needing to modify the etc/yamcs.yaml.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PATH_INDEX
static final String	PATH_NGSW
static final String	PATH_WEBMANIFEST

Constructor Summary

Constructors

Constructor	Description
WebFileDeployer(YConfiguration config, String contextPath)	Deploy the website, for practical reasons we have three different mechanisms.

Method Summary

Modifier and Type	Method	Description
Path	getDirectory()	Returns the directory where files are deployed

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

PATH_INDEX

public static final String PATH_INDEX

See Also:

• Constant Field Values

PATH_NGSW

public static final String PATH_NGSW

See Also:

• Constant Field Values

PATH_WEBMANIFEST

public static final String PATH_WEBMANIFEST

See Also:

• Constant Field Values

Constructor Details

WebFileDeployer

public WebFileDeployer(YConfiguration config,
 String contextPath)
                throws IOException,
ParseException

Deploy the website, for practical reasons we have three different mechanisms. In order:

• (1) Check a system property yamcs.web.staticRoot
• (2) Check a property in yamcs.yaml
• (3) Load from classpath (packaged inside yamcs-web)

End-users should use (3). (1) and (2) make it possible to develop on the web sources. (1) Allows doing so without needing to modify the yamcs.yaml

Throws:

IOException

ParseException

Method Details

getDirectory

public Path getDirectory()

Returns the directory where files are deployed