quarchpy 2.1.22__py2.py3-none-any.whl → 2.1.24.dev1__py2.py3-none-any.whl

quarchpy/connection_specific/connection_QPS.py

@@ -52,6 +52,31 @@ class QpsInterface:
         else:
             self.client.send( data )
 
+    def sendCommand(self, cmd, timeout=20, expectedResponse=True ):
+        cmd = cmd + "\r\n"
+        logging.debug("Sending cmd to QPS: " + str(cmd))
+        self.send(cmd)
+
+        start = time.time()
+        response = self.recv().strip()
+        while response.rfind('\r\n>') == -1:  # If true then the resposnse is large and multi packeted
+            time.sleep(0.1)
+            t_response = self.recv().strip()
+            # Add current response to new response
+            response += t_response
+            # Keep reading from the socket if there's stuff that was retreived
+            if len(str(t_response)) == 0:
+                if time.time() - start > timeout:
+                    logging.warning("Command : " + str(cmd) + " Hit timeout during QPS read. timeout = " + str(timeout))
+                    break
+
+        pos = response.rfind('\r\n>')
+        if pos == -1:
+            logging.warning("Did not retrieve trailing '\\r\\n>' from QPS read, returned full response so far")
+            logging.warning("command : " + cmd.replace('\r\n', '\\r\\n'))
+            logging.warning("returned : " + response.replace('\r\n', '\\r\\n'))
+            pos = len(str(response))
+        return response[:pos]
 
     def sendCmdVerbose(self, cmd, timeout=20):
         cmd = cmd + "\r\n"
@@ -83,7 +108,6 @@ class QpsInterface:
     def connect(self, targetDevice):
         cmd="$connect " + targetDevice
         retVal = self.sendCmdVerbose(cmd)
-        #print(cmd+" : "+retVal)
         time.sleep(0.3)
         return retVal
 

quarchpy/connection_specific/connection_ReST.py

@@ -15,9 +15,9 @@ class ReSTConn:
     def close(self):
         return True
 
-    def sendCommand(self, Command, expectedResponse = True, max_retries=1):
+    def sendCommand(self, Command, expectedResponse = True, max_retries=2):
         Command = "/" + Command.replace(" ", "%20")
-        for attempt in range(1, max_retries + 1):
+        for attempt in range(0, max_retries ):
             try:
                 self.Connection.request("GET", Command)
                 if expectedResponse == True:
@@ -37,6 +37,7 @@ class ReSTConn:
             except socket.timeout as e:
                 if attempt < max_retries:
                     logging.warning("Socket timed out, retrying command...")
+                    time.sleep(0.1)
                 else:
                     logging.error("Maximum number of retries reached on module at: "+self.ConnTarget+". Exiting.")
                     raise e

quarchpy/connection_specific/jdk-j21-jres/JDK 21 JREs Notes.txt

@@ -0,0 +1,93 @@
+*** JDK 21 JREs ***
+
+J21 JREs 21.0.1_12 as of the 17th of October 2023 release.
+
+J8 used to consist of a JDK and a JRE. Later versions of Java have dropped the JRE as it is now part of the JDK.
+The problem is that if we are to ship a JRE it can be a bit bloated at ~365MB.
+
+This article describes stripping jmods and src.zip from the jdk when shipping a JRE:
+
+https://dzone.com/articles/no-more-jre-packaging-no-big-deal-1
+
+I copied Java-21 jdk from /usr/lib/jvm/ into quarch/software/j21 and deleted /jmods and src.zip and then pointed to this Java and ran QPS, and worked fine.
+Size reduction: 365MB --> 223MB.
+
+The problem is, this is a bit of the seat of the pants hacking. A much better and proper way is to use jlink as described in this article:
+
+https://adoptium.net/en-GB/blog/2021/10/jlink-to-produce-own-runtime/
+
+Copied J21 jdk to temp folder /jres and ran:
+
+./amazon-corretto-21.0.0.35.1-linux-x64/bin/jlink --add-modules ALL-MODULE-PATH --output jdk-21-jre --strip-debug --no-man-pages --no-header-files --compress=zip-6
+
+which outputs "lin-amd64-jdk-21-jre" and of size 102MB, which is 365-102=263MB smaller or 28% the size.
+
+Again, pointing QPS to this JRE works fine.
+
+He then goes on to strip out extra modules such as jpackage, jshell that are not needed for running QPS.
+Note that incubator.foreign is no longer present and also had to add jdk.unsupported.desktop since used by javafx.swing.
+The following works fine for QPS:
+
+*** Windows ***
+
+./jdk21.0.1_12/bin/jlink --add-modules  java.base,java.compiler,java.datatransfer,java.desktop,java.instrument,java.logging,java.management,java.management.rmi,java.naming,java.net.http,java.prefs,java.rmi,java.scripting,java.se,java.security.jgss,java.security.sasl,java.smartcardio,java.sql,java.sql.rowset,java.transaction.xa,java.xml,java.xml.crypto,jdk.accessibility,jdk.charsets,jdk.crypto.cryptoki,jdk.crypto.ec,jdk.dynalink,jdk.httpserver,jdk.incubator.vector,jdk.internal.vm.ci,jdk.internal.vm.compiler,jdk.internal.vm.compiler.management,jdk.jdwp.agent,jdk.jfr,jdk.jsobject,jdk.localedata,jdk.management,jdk.management.agent,jdk.management.jfr,jdk.naming.dns,jdk.naming.rmi,jdk.net,jdk.nio.mapmode,jdk.sctp,jdk.security.auth,jdk.security.jgss,jdk.unsupported,jdk.unsupported.desktop,jdk.xml.dom,jdk.zipfs --output win-amd64-jdk-21-jre --strip-debug --no-man-pages --no-header-files --compress=zip-6
+
+*** Linux ***
+
+./amazon-corretto-jdk21.0.1_12.1-linux-x64/bin/jlink --add-modules  java.base,java.compiler,java.datatransfer,java.desktop,java.instrument,java.logging,java.management,java.management.rmi,java.naming,java.net.http,java.prefs,java.rmi,java.scripting,java.se,java.security.jgss,java.security.sasl,java.smartcardio,java.sql,java.sql.rowset,java.transaction.xa,java.xml,java.xml.crypto,jdk.accessibility,jdk.charsets,jdk.crypto.cryptoki,jdk.crypto.ec,jdk.dynalink,jdk.httpserver,jdk.incubator.vector,jdk.internal.vm.ci,jdk.internal.vm.compiler,jdk.internal.vm.compiler.management,jdk.jdwp.agent,jdk.jfr,jdk.jsobject,jdk.localedata,jdk.management,jdk.management.agent,jdk.management.jfr,jdk.naming.dns,jdk.naming.rmi,jdk.net,jdk.nio.mapmode,jdk.sctp,jdk.security.auth,jdk.security.jgss,jdk.unsupported,jdk.unsupported.desktop,jdk.xml.dom,jdk.zipfs --output lin-amd64-jdk-21-jre --strip-debug --no-man-pages --no-header-files --compress=zip-6
+
+*** Apple ***
+
+/Library/Java/JavaVirtualMachines/amazon-corretto-21.jdk/Contents/Home/bin/jlink --add-modules  java.base,java.compiler,java.datatransfer,java.desktop,java.instrument,java.logging,java.management,java.management.rmi,java.naming,java.net.http,java.prefs,java.rmi,java.scripting,java.se,java.security.jgss,java.security.sasl,java.smartcardio,java.sql,java.sql.rowset,java.transaction.xa,java.xml,java.xml.crypto,jdk.accessibility,jdk.charsets,jdk.crypto.cryptoki,jdk.crypto.ec,jdk.dynalink,jdk.httpserver,jdk.incubator.vector,jdk.internal.vm.ci,jdk.internal.vm.compiler,jdk.internal.vm.compiler.management,jdk.jdwp.agent,jdk.jfr,jdk.jsobject,jdk.localedata,jdk.management,jdk.management.agent,jdk.management.jfr,jdk.naming.dns,jdk.naming.rmi,jdk.net,jdk.nio.mapmode,jdk.sctp,jdk.security.auth,jdk.security.jgss,jdk.unsupported,jdk.unsupported.desktop,jdk.xml.dom,jdk.zipfs --output mac-amd64-jdk-21-jre --strip-debug --no-man-pages --no-header-files --compress=zip-6
+
+The above Apple command is generating the reduced JRE direct from the installed version, which works equally well.
+
+This reduces the sizes down to:
+
+Windows	326MB --> 66MB
+Linux	365MB --> 81MB, ~ 20-22% of original
+Mac     353MB --> 74MB
+
+Note that this has to be done for each machine. Worth noting that jlink generates a similar ../bin structure on all three OSs even though Mac starts off with /Contents/Home/...
+
+Also, these reduced JREs can be used as the J21 runtime when packaging with jpackage since we use --runtime-image. However, for Windows found that it reduces the 
+final packaged .msi down from 130MB to 109MB and so looks like jpackage may already be doing some stripping out of non-relevant JDK features.
+
+*** Copying ***
+
+Note that when copying the stripped down JDK on Linux/Apple, a simple copy will strip out legal licenses as they are symbolic links and so best to do the following,
+where L stands for de-reference and follow the symbol link, and R stands for recurse directory:
+
+Linux:
+cp -r -L lin-amd64-jdk-21-jre/ full_copy
+
+Mac:
+cp -LR mac-amd64-jdk-21-jre/ full_copy
+
+Also advisable to download the zipped up versions of the Corretto JDKs and work with these as opposed to copying folders from .deb/.dmg packagers.
+
+*** Permissions ***
+
+Noticed that when the Linux JRE was built and moved into the jres folder of QuarchPy that it wouldn't run and remained in the is-qis-running while loop due to a 
+permissions error. So, after running the above commands ensure to do a full rights chmod, where -R performs a recursive trace on all sub-folders and files:
+
+chmod -R 777 ./full_copy 
+
+Found that this isn't bullet proof and so added a subprocess() chmod call in the QuarchPy code specifically for Linux/Apple.
+
+*** SVN ***
+
+1) Found that if a blanket upload of the Linux JRE is committed to SVN that it doesn't like the .so lib files and excludes them from the commit.
+Ensure they are explicitly added.
+
+2) Apple is dumping its own hidden folder vieiwng attribute files .DS_Store into the directories. They shouldn't affect QuarchPy in any way but shouldn't be there
+and need to ensure they are removed.
+
+*** release File ***
+
+After the stripped down JREs have been built, a "release" file is deposited in the jre directory and is of the form:
+
+JAVA_VERSION="21.0.1"
+MODULES="java.base java.compiler ...
+
+showing the Java version and modules. This is useful as a double-check that things look correct.

quarchpy/connection_specific/jdk-j21-jres/lin-amd64-jdk-21-jre/conf/jaxp.properties

@@ -0,0 +1,180 @@
+################################################################################
+#           JAXP Configuration File
+#
+# jaxp.properties (this file) is the default configuration file for JAXP, the API
+# defined in the java.xml module. It is in java.util.Properties format and typically
+# located in the {java.home}/conf directory. It may contain key/value pairs for
+# specifying the implementation classes of JAXP factories and/or properties
+# that have corresponding system properties.
+#
+# A user-specified configuration file can be set up using the system property
+# java.xml.config.file to override any or all of the entries in jaxp.properties.
+# The following statement provides myConfigurationFile as a custom configuration
+# file:
+#     java -Djava.xml.config.file=myConfigurationFile
+################################################################################
+
+# ---- JAXP Default Configuration ----
+#
+# The JAXP default configuration (jaxp.properties) contains entries for the
+# Factory Lookup Mechanism and properties with corresponding system properties.
+# The values are generally set to the default values of the properties.
+#
+#
+# JAXP Lookup Mechanism:
+#
+# The JAXP configuration file ranks 2nd to the System Property in the precedent
+# order of the JAXP Lookup Mechanism. When the System Property is not specified,
+# a JAXP factory reads the configuration file in order to locate an implementation
+# class. If found, the class specified will be used as the factory implementation
+# class.
+#
+# The format of an entry is key=value where the key is the fully qualified name
+# of the factory and value that of the implementation class. The following entry
+# set a DocumentBuilderFactory implementation class:
+#
+# javax.xml.parsers.DocumentBuilderFactory=com.sun.org.apache.xerces.internal.jaxp.DocumentBuilderFactoryImpl
+#
+#
+# Java SE and JDK Implementation Specific Properties:
+#
+# The JAXP configuration file ranks above the default settings in the Property
+# Precedence in that its entries will override the default values of the corresponding
+# properties.
+#
+# All properties that have System Properties defined in Java SE or supported
+# by the JDK Implementation can be placed in the configuration file to override
+# the default property values. The format is:
+#     system-property-name=value
+#
+# For example, the FILES property in CatalogFeatures has an associated system
+# property called javax.xml.catalog.files. An entry for the FILES property in the
+# configuration file would therefore use javax.xml.catalog.files as the key, that
+# is:
+#     javax.xml.catalog.files=strict
+#
+#
+# Extension Functions:
+#
+# This property determines whether XSLT and XPath extension functions are allowed.
+# The value type is boolean and the default value is true (allowing
+# extension functions). The following entry would override the default value and
+# disallow extension functions:
+#
+# jdk.xml.enableExtensionFunctions=false
+#
+#
+# Overriding the default parser:
+#
+# This property allows using a third party implementation to override the default
+# parser provided by the JDK. The value type is boolean and the default value is
+# false, disallowing overriding the default parser. The setting below reflects
+# the default property setting:
+#
+jdk.xml.overrideDefaultParser=false
+#
+#
+# External Access Properties:
+#
+# The External Access Properties are defined in javax.xml.XMLConstants. Their
+# system properties are javax.xml.accessExternalDTD, javax.xml.accessExternalSchema,
+# and javax.xml.accessExternalStylesheet. The values are a list of protocols separated
+# by comma, plus empty string ("") to represent no protocol allowed and the key
+# word "all" for all access. The default is "all", allowing all external resources
+# to be fetched. The followings are example of external access settings:
+#
+# allow local (file) DTDs to be retrieved
+# javax.xml.accessExternalDTD=file
+#
+# allow local (file) and remote (http) external schemas
+# javax.xml.accessExternalSchema=file, http
+#
+# reject any external stylesheets
+# javax.xml.accessExternalStylesheet=""
+#
+# allow all external stylesheets
+# javax.xml.accessExternalStylesheet="all"
+#
+#
+# Catalog Properties:
+#
+# The Catalog API defines four features: FILES, PREFER, DEFER and RESOLVE.
+# Except PREFER, all other properties can be placed in the configuration file
+# using the system properties defined for them.
+#
+# FILES: A semicolon-delimited list of URIs to locate the catalog files. The URIs
+# must be absolute and have a URL protocol handler for the URI scheme. The following
+# is an example of setting up a catalog file:
+#
+# javax.xml.catalog.files = file:///users/auser/catalog/catalog.xml
+#
+# DEFER: Indicates that the alternative catalogs including those specified in
+# delegate entries or nextCatalog are not read until they are needed. The value
+# is a boolean and the default value is true.
+#
+# javax.xml.catalog.defer=true
+#
+# RESOLVE: Determines the action if there is no matching entry found after all of
+# the specified catalogs are exhausted. The values are key words: strict, continue,
+# and ignore. The default is strict. The following setting reflects the default
+# setting.
+#
+# javax.xml.catalog.resolve=strict
+#
+#
+# useCatalog:
+# This property instructs XML processors to use XML Catalogs to resolve entity
+# references. The value is a boolean and the default value is true.
+#
+# javax.xml.useCatalog=true
+#
+#
+# Implementation Specific Properties - Limits
+#
+# Limits have a value type Integer. The values must be positive integers. Zero
+# means no limit.
+#
+# Limits the number of entity expansions. The default value is 64000
+# jdk.xml.entityExpansionLimit=64000
+#
+# Limits the total size of all entities that include general and parameter entities.
+# The size is calculated as an aggregation of all entities. The default value is 5x10^7.
+# jdk.xml.totalEntitySizeLimit=5E7
+#
+# Limits the maximum size of any general entities. The default value is 0.
+# jdk.xml.maxGeneralEntitySizeLimit=0
+#
+# Limits the maximum size of any parameter entities, including the result of
+# nesting multiple parameter entities. The default value is 10^6.
+# jdk.xml.maxParameterEntitySizeLimit=1E6
+#
+# Limits the total number of nodes in all entity references. The default value is 3x10^6.
+# jdk.xml.entityReplacementLimit=3E6
+#
+# Limits the number of attributes an element can have. The default value is 10000.
+# jdk.xml.elementAttributeLimit=10000
+#
+# Limits the number of content model nodes that may be created when building a
+# grammar for a W3C XML Schema that contains maxOccurs attributes with values
+# other than "unbounded". The default value is 5000.
+# jdk.xml.maxOccurLimit=5000
+#
+# Limits the maximum element depth. The default value is 0.
+# jdk.xml.maxElementDepth=0
+#
+# Limits the maximum size of XML names, including element name, attribute name
+# and namespace prefix and URI. The default value is 1000.
+jdk.xml.maxXMLNameLimit=1000
+#
+#
+# XPath Limits
+#
+# Limits the number of groups an XPath expression can contain. The default value is 10.
+jdk.xml.xpathExprGrpLimit=10
+#
+# Limits the number of operators an XPath expression can contain. The default value is 100.
+jdk.xml.xpathExprOpLimit=100
+#
+# Limits the total number of XPath operators in an XSL Stylesheet. The default value is 10000.
+jdk.xml.xpathTotalOpLimit=10000
+

quarchpy/connection_specific/jdk-j21-jres/lin-amd64-jdk-21-jre/conf/logging.properties

@@ -0,0 +1,63 @@
+############################################################
+#  	Default Logging Configuration File
+#
+# You can use a different file by specifying a filename
+# with the java.util.logging.config.file system property.
+# For example, java -Djava.util.logging.config.file=myfile
+############################################################
+
+############################################################
+#  	Global properties
+############################################################
+
+# "handlers" specifies a comma-separated list of log Handler
+# classes.  These handlers will be installed during VM startup.
+# Note that these classes must be on the system classpath.
+# By default we only configure a ConsoleHandler, which will only
+# show messages at the INFO and above levels.
+handlers= java.util.logging.ConsoleHandler
+
+# To also add the FileHandler, use the following line instead.
+#handlers= java.util.logging.FileHandler, java.util.logging.ConsoleHandler
+
+# Default global logging level.
+# This specifies which kinds of events are logged across
+# all loggers.  For any given facility this global level
+# can be overridden by a facility-specific level
+# Note that the ConsoleHandler also has a separate level
+# setting to limit messages printed to the console.
+.level= INFO
+
+############################################################
+# Handler specific properties.
+# Describes specific configuration info for Handlers.
+############################################################
+
+# default file output is in user's home directory.
+java.util.logging.FileHandler.pattern = %h/java%u.log
+java.util.logging.FileHandler.limit = 50000
+java.util.logging.FileHandler.count = 1
+# Default number of locks FileHandler can obtain synchronously.
+# This specifies maximum number of attempts to obtain lock file by FileHandler
+# implemented by incrementing the unique field %u as per FileHandler API documentation.
+java.util.logging.FileHandler.maxLocks = 100
+java.util.logging.FileHandler.formatter = java.util.logging.XMLFormatter
+
+# Limit the messages that are printed on the console to INFO and above.
+java.util.logging.ConsoleHandler.level = INFO
+java.util.logging.ConsoleHandler.formatter = java.util.logging.SimpleFormatter
+
+# Example to customize the SimpleFormatter output format
+# to print one-line log message like this:
+#     <level>: <log message> [<date/time>]
+#
+# java.util.logging.SimpleFormatter.format=%4$s: %5$s [%1$tc]%n
+
+############################################################
+# Facility-specific properties.
+# Provides extra control for each logger.
+############################################################
+
+# For example, set the com.xyz.foo logger to only log SEVERE
+# messages:
+# com.xyz.foo.level = SEVERE

quarchpy/connection_specific/jdk-j21-jres/lin-amd64-jdk-21-jre/conf/management/jmxremote.access

@@ -0,0 +1,79 @@
+######################################################################
+#     Default Access Control File for Remote JMX(TM) Monitoring
+######################################################################
+#
+# Access control file for Remote JMX API access to monitoring.
+# This file defines the allowed access for different roles.  The
+# password file (jmxremote.password by default) defines the roles and their
+# passwords.  To be functional, a role must have an entry in
+# both the password and the access files.
+#
+# The default location of this file is $JRE/conf/management/jmxremote.access
+# You can specify an alternate location by specifying a property in
+# the management config file $JRE/conf/management/management.properties
+# (See that file for details)
+#
+# The file format for password and access files is syntactically the same
+# as the Properties file format.  The syntax is described in the Javadoc
+# for java.util.Properties.load.
+# A typical access file has multiple lines, where each line is blank,
+# a comment (like this one), or an access control entry.
+#
+# An access control entry consists of a role name, and an
+# associated access level.  The role name is any string that does not
+# itself contain spaces or tabs.  It corresponds to an entry in the
+# password file (jmxremote.password).  The access level is one of the
+# following:
+#       "readonly" grants access to read attributes of MBeans.
+#                   For monitoring, this means that a remote client in this
+#                   role can read measurements but cannot perform any action
+#                   that changes the environment of the running program.
+#       "readwrite" grants access to read and write attributes of MBeans,
+#                   to invoke operations on them, and optionally
+#                   to create or remove them. This access should be granted
+#                   only to trusted clients, since they can potentially
+#                   interfere with the smooth operation of a running program.
+#
+# The "readwrite" access level can optionally be followed by the "create" and/or
+# "unregister" keywords.  The "unregister" keyword grants access to unregister
+# (delete) MBeans.  The "create" keyword grants access to create MBeans of a
+# particular class or of any class matching a particular pattern.  Access
+# should only be granted to create MBeans of known and trusted classes.
+#
+# For example, the following entry would grant readwrite access
+# to "controlRole", as well as access to create MBeans of the class
+# javax.management.monitor.CounterMonitor and to unregister any MBean:
+#  controlRole readwrite \
+#              create javax.management.monitor.CounterMonitorMBean \
+#              unregister
+# or equivalently:
+#  controlRole readwrite unregister create javax.management.monitor.CounterMBean
+#
+# The following entry would grant readwrite access as well as access to create
+# MBeans of any class in the packages javax.management.monitor and
+# javax.management.timer:
+#  controlRole readwrite \
+#              create javax.management.monitor.*,javax.management.timer.* \
+#              unregister
+#
+# The \ character is defined in the Properties file syntax to allow continuation
+# lines as shown here.  A * in a class pattern matches a sequence of characters
+# other than dot (.), so javax.management.monitor.* matches
+# javax.management.monitor.CounterMonitor but not
+# javax.management.monitor.foo.Bar.
+#
+# A given role should have at most one entry in this file.  If a role
+# has no entry, it has no access.
+# If multiple entries are found for the same role name, then the last
+# access entry is used.
+#
+#
+# Default access control entries:
+# o The "monitorRole" role has readonly access.
+# o The "controlRole" role has readwrite access and can create the standard
+#   Timer and Monitor MBeans defined by the JMX API.
+
+monitorRole   readonly
+controlRole   readwrite \
+              create javax.management.monitor.*,javax.management.timer.* \
+              unregister

quarchpy/connection_specific/jdk-j21-jres/lin-amd64-jdk-21-jre/conf/management/jmxremote.password.template

@@ -0,0 +1,115 @@
+# ----------------------------------------------------------------------
+#           Template for jmxremote.password
+#
+# o Copy this template to jmxremote.password
+# o Set the user/password entries in jmxremote.password
+# o Change the permission of jmxremote.password to be accessible
+#   only by the owner.
+# o The jmxremote.passwords file will be re-written by the server
+#   to replace all plain text passwords with hashed passwords when
+#   the file is read by the server.
+#
+
+##############################################################
+#        Password File for Remote JMX Monitoring
+##############################################################
+#
+# Password file for Remote JMX API access to monitoring.  This
+# file defines the different roles and their passwords.  The access
+# control file (jmxremote.access by default) defines the allowed
+# access for each role.  To be functional, a role must have an entry
+# in both the password and the access files.
+#
+# Default location of this file is $JRE/conf/management/jmxremote.password
+# You can specify an alternate location by specifying a property in
+# the management config file $JRE/conf/management/management.properties
+# or by specifying a system property (See that file for details).
+
+##############################################################
+#    File format of the jmxremote.password file
+##############################################################
+#
+# The file contains multiple lines where each line is blank,
+# a comment (like this one), or a password entry.
+#
+# password entry follows the below syntax
+#   role_name W [clearPassword|hashedPassword]
+#
+# role_name is any string that does not itself contain spaces or tabs.
+# W = spaces or tabs
+#
+# Passwords can be specified via clear text or via a hash. Clear text password
+# is any string that does not contain spaces or tabs. Hashed passwords must
+# follow the below format.
+# hashedPassword = base64_encoded_64_byte_salt W base64_encoded_hash W hash_algorithm
+# where,
+#   base64_encoded_64_byte_salt = 64 byte random salt
+#   base64_encoded_hash = Hash_algorithm(password + salt)
+#   W = spaces or tabs
+#   hash_algorithm = Algorithm string specified using the format below
+#       https://docs.oracle.com/javase/9/docs/specs/security/standard-names.html#messagedigest-algorithms
+#       This is an optional field. If not specified, SHA3-512 will be assumed.
+#
+# If passwords are in clear, they will be overwritten by their hash if all of
+# the below criteria are met.
+#   * com.sun.management.jmxremote.password.toHashes property is set to true in
+#     management.properties file
+#   * the password file is writable
+#   * the system security policy allows writing into the password file, if a
+#     security manager is configured
+#
+# In order to change the password for a role, replace the hashed password entry
+# with a new clear text password or a new hashed password. If the new password
+# is in clear, it will be replaced with its hash when a new login attempt is made.
+#
+# A given role should have at most one entry in this file.  If a role
+# has no entry, it has no access.
+# If multiple entries are found for the same role name, then the last one
+# is used.
+#
+# A user generated hashed password file can also be used instead of clear-text
+# password file. If generated by the user, hashed passwords must follow the
+# format specified above.
+#
+# Caution: It is recommended not to edit the password file while the
+# agent is running, as edits could be lost if a client connection triggers the
+# hashing of the password file at the same time that the file is externally modified.
+# The integrity of the file is guaranteed, but any external edits made to the
+# file during the short period between the time that the agent reads the file
+# and the time that it writes it back might get lost
+
+##############################################################
+#    File permissions of the jmxremote.password file
+##############################################################
+#       This file must be made accessible by ONLY the owner,
+#       otherwise the program will exit with an error.
+#
+# In a typical installation, this file can be accessed by anybody on the
+# local machine, and possibly by people on other machines.
+# For security, you should either restrict the access to this file except for owner,
+# or specify another, less accessible file in the management config file
+# as described above.
+#
+# In order to prevent inadverent edits to the password file in the 
+# production environment, it is recommended to deploy a read-only 
+# hashed password file. The hashed entries for clear passwords can be generated 
+# in advance by running the JMX agent.
+#
+
+##############################################################
+#    Sample of the jmxremote.password file
+##############################################################
+# Following are two commented-out entries.  The "monitorRole" role has
+# password "QED".  The "controlRole" role has password "R&D". This is an example
+# of specifying passwords in the clear
+#
+#   monitorRole  QED
+#   controlRole  R&D
+# 
+# Once a login attempt is made, passwords will be hashed and the file will have 
+# below entries with clear passwords overwritten by their respective 
+# SHA3-512 hash
+#
+#   monitorRole trilby APzBTt34rV2l+OMbuvbnOQ4si8UZmfRCVbIY1+fAofV5CkQzXS/FDMGteQQk/R3q1wtt104qImzJEA7gCwl6dw== 4EeTdSJ7X6Imu0Mb+dWqIns7a7QPIBoM3NB/XlpMQSPSicE7PnlALVWn2pBY3Q3pGDHyAb32Hd8GUToQbUhAjA== SHA3-512
+#   controlRole roHEJSbRqSSTII4Z4+NOCV2OJaZVQ/dw153Fy2u4ILDP9XiZ426GwzCzc3RtpoqNMwqYIcfdd74xWXSMrWtGaA== w9qDsekgKn0WOVJycDyU0kLBa081zbStcCjUAVEqlfon5Sgx7XHtaodbmzpLegA1jT7Ag36T0zHaEWRHJe2fdA== SHA3-512
+#