Palisade Java Collection Script Instructions
for macOS
This document is Copyright © 2011-2023 by Palisade Compliance, LLC. It contains confidential and proprietary
information that may only be disclosed to individuals and entities under a Non-Disclosure Agreement (NDA).
The terms Palisade Compliance, Audit Intervention, Compliance Assurance and ULA Optimization are marks of Palisade
Compliance, LLC. All other trademarks are the property of their owners.
Contents
Overview ....................................................................................................................................................... 2
Introduction .............................................................................................................................................. 2
Prerequisites............................................................................................................................................. 2
Important Notes ....................................................................................................................................... 3
Running the Palisade Java Collection Script.................................................................................................. 4
Installation ................................................................................................................................................ 4
Silent mode execution ............................................................................................................................. 4
Uploading the Collected Data .................................................................................................................. 5
Confidential and Proprietary – © 2011-2023 Palisade Compliance, LLC. All Rights Reserved. 1
Palisade Java Collection Script Instructions
Overview
This document describes the technical steps to be performed by system administrators to extracting
Java related deployment configuration for analysis.
Introduction
The Java Collection Script is designed to extract all deployment configuration required for utilization
analysis from a Java environment. The script should be executed on each macOS workstation or server
where Java software is installed. The data collected is in text format.
The Palisade Java Collection script include executable file ‘collect_java_macos.sh’ that is compressed as
.GZ file.
The script file named ‘collect_java_macos.sh’ should be executed to collect data from Java machines
running on macOS operating systems.
Prerequisites
To properly run the Palisade Java Collection script, certain conditions and credentials are required.
Before proceeding with the script execution, please make sure the following conditions are met and the
required information is readily available:
1. This script can only be used on macOS environments
2. Check that the operating system user that will be used to run the tool has access to the
following OS level commands: TAR, GZIP
3. The operating system user executing the script should have read permissions to the directories
locations where Java is installed. It is not required, nor recommended, that the user have write
permissions to those directories locations
4. The operating system user should also have read/write permissions to the directory from which
the Data Collection script will be executed, the same directory is used as default location for the
script output
5. The script has execution access rights set at the user level.
Confidential and Proprietary – © 2011-2023 Palisade Compliance, LLC. All Rights Reserved. 2
Important Notes
• File Compression Utilities
o The compression formats listed below are the only acceptable formats that
are to be used when consolidating script output files.
▪ ZIP (.zip)
▪ GNU ZIP (.gz, .[Link])
• Script Generated File Names and File Content
o Do not alter or edit the script generated file name – the script creates a
unique file name for each program instance measured under the current
directory using the host name and a timestamp.
o Do not alter or edit the content contained in the script generated file.
• Duplicates
o When executing a script more than once against the same set of data only
provide the most recent script output.
• Script Execution on All Environments
o Scripts are to be executed on all machines across all environments, including
Disaster Recovery, if possible.
o If a Clone and the host name is an exact duplicate of a host in another
environment, place the cloned output in a folder that describes the cloned
machine (for example, sub-folder names may be something like
“test_clone_location”, “dev_clone_location”, or “qa_clone_location”).
Confidential and Proprietary – © 2011-2023 Palisade Compliance, LLC. All Rights Reserved. 3
Running the Palisade Java Collection Script
This section provides instructions on running the Java Data Collection script.
Installation
Copy the ‘collect_java_macos.[Link]’ archive file into the location where you intend to run the script
from and extract all files into its own subdirectory.
The collect_java_macos.sh file should be extracted under its own subdirectory. Please check that the
following file exists in that subdirectory:
collect_java_macos.sh
At runtime, the output file will be created in this subdirectory automatically by the script. Therefore, full
access rights are required to this subdirectory for the operating system user being used to run the script.
Silent mode execution
1. Start the tool by running the corresponding executable file using Terminal. The script is written in
ZSH and it will not be executed correctly with another shell. The user can control the script using the
available command line options.
./collect_java_macos.sh
zsh ./collect_java_macos.sh
./collect_java_macos.sh -output “/Users/shared”
Option Description
-output “<PATH>” By default, the output will be stored in the directory from which the script is
called. When this option is used, the script will check the existence of the
PATH specified by the user. If the path exists, then the output files will be
created on this path. Relative and absolute paths are permitted. The script
will exit with a specific error message if there is something wrong with the
path provided with -output option.
Confidential and Proprietary – © 2011-2023 Palisade Compliance, LLC. All Rights Reserved. 4
The script is running in silent mode, unattended and will search all local filesystems for java binaries. The
following root directories are excluded: /System /Users /Volumes /.vol /cores /.fseventsd /private /usr
/dev
Any Java installation deployed on /Users root folder will not be detected by the script. /Users root folder
has been excluded because it cannot be scanned without explicit user approval.
List of potential error messages:
Error message Cause
PALJVERR: <parameter> is an The specified parameter is not valid. Please use only the
invalid entry. parameters listed in this document
PALJVERR: <dir> directory does The directory specified in the -scandirs or -output parameter
not exist or is not readable. does not exist or is not readable
PALJVERR: <dir> directory is Unable to write in the directory specified in the -output
read-only. parameter
2. Upon successful completion, the script will produce an output file with a name similar to this
format:
palcust-paljv-servername__20181116151015.txt
Uploading the Collected Data
Once completed successfully, all the output files, from all machines will be packaged into a [Link] or zip
file and delivered back to Palisade for analysis.
Confidential and Proprietary – © 2011-2023 Palisade Compliance, LLC. All Rights Reserved. 5