java

Table of Contents

1. Overview
2. Module Description - What the module does and why it is useful
3. Setup - The basics of getting started with the java module
   • Beginning with the java module
4. Usage - Configuration options and additional functionality
5. Reference - An under-the-hood peek at what the module is doing and how
6. Limitations - OS compatibility, etc.
7. Development - Guide for contributing to the module

Overview

Installs the correct Java package on various platforms.

Module Description

The java module can automatically install Java jdk or jre on a wide variety of systems. Java is a base component for many software platforms, but Java system packages don't always follow packaging conventions. The java module simplifies the Java installation process.

Setup

Beginning with the java module

To install the correct Java package on your system, include the java class: include java.

Usage

The java module installs the correct jdk or jre package on a wide variety of systems. By default, the module installs the jdk package, but you can set different installation parameters as needed. For example, to install jre instead of jdk, you would set the distribution parameter:

class { 'java':
  distribution => 'jre',
}

To install the latest patch version of Java 8 on CentOS

class { 'java' :
  package => 'java-1.8.0-openjdk-devel',
}

The defined type java::oracle installs one or more versions of Oracle Java SE. java::oracle depends on puppet/archive. By using java::oracle you agree to Oracle's licensing terms for Java SE.

java::oracle { 'jdk6' :
  ensure  => 'present',
  version => '6',
  java_se => 'jdk',
}

java::oracle { 'jdk8' :
  ensure  => 'present',
  version => '8',
  java_se => 'jdk',
}

To install a specific release of a Java version, e.g. 8u101-b13, provide both parameters version_major and version_minor as follows:

java::oracle { 'jdk8' :
  ensure  => 'present',
  version_major => '8u101',
  version_minor => 'b13',
  java_se => 'jdk',
}

To install Oracle Java to a non-default basedir (defaults: /usr/lib/jvm for Debian; /usr/java for RedHat):

java::oracle { 'jdk8' :
  ensure  => 'present',
  version_major => '8u101',
  version_minor => 'b13',
  java_se => 'jdk',
  basedir => '/custom/java',
}

To ensure that a custom basedir is a directory before Oracle Java is installed (note: manage separately for custom ownership or perms):

java::oracle { 'jdk8' :
  ensure  => 'present',
  version_major => '8u101',
  version_minor => 'b13',
  java_se => 'jdk',
  manage_basedir => true,
  basedir => '/custom/java',
}

Reference

For information on the classes and types, see the REFERENCE.md. For information on the facts, see below.

Facts

The java module includes a few facts to describe the version of Java installed on the system:

• java_major_version: The major version of Java.
• java_patch_level: The patch level of Java.
• java_version: The full Java version string.
• java_default_home: The absolute path to the java system home directory (only available on Linux). For instance, the java executable's path would be ${::java_default_home}/jre/bin/java. This is slightly different from the "standard" JAVA_HOME environment variable.
• java_libjvm_path: The absolute path to the directory containing the shared library libjvm.so (only available on Linux). Useful for setting LD_LIBRARY_PATH or configuring the dynamic linker.

Note: The facts return nil if Java is not installed on the system.

Limitations

For an extensive list of supported operating systems, see metadata.json

This module cannot guarantee installation of Java versions that are not available on platform repositories.

This module only manages a singular installation of Java, meaning it is not possible to manage e.g. OpenJDK 7, Oracle Java 7 and Oracle Java 8 in parallel on the same system.

Oracle Java packages are not included in Debian 7 and Ubuntu 12.04/14.04 repositories. To install Java on those systems, you'll need to package Oracle JDK/JRE, and then the module can install the package. For more information on how to package Oracle JDK/JRE, see the Debian wiki.

This module is officially supported for the following Java versions and platforms:

OpenJDK is supported on:

• Red Hat Enterprise Linux (RHEL) 5, 6, 7
• CentOS 5, 6, 7
• Oracle Linux 6, 7
• Scientific Linux 6
• Debian 8, 9
• Ubuntu 14.04, 16.04, 18.04
• Solaris 11
• SLES 11, 12

Sun Java is supported on:

• Debian 6

Oracle Java is supported on:

• CentOS 6
• CentOS 7
• Red Hat Enterprise Linux (RHEL) 7

Known issues

Where Oracle change the format of the URLs to different installer packages, the curl to fetch the package may fail with a HTTP/404 error. In this case, passing a full known good URL using the url parameter will allow the module to still be able to install specific versions of the JRE/JDK. Note the version_major and version_minor parameters must be passed and must match the version downloaded using the known URL in the url parameter.

OpenBSD

OpenBSD packages install Java JRE/JDK in a unique directory structure, not linking the binaries to a standard directory. Because of that, the path to this location is hardcoded in the java_version fact. Whenever you upgrade Java to a newer version, you have to update the path in this fact.

FreeBSD

By default on FreeBSD, Puppet versions prior to 4.0 throw an error saying pkgng is not the default provider. To fix this, install the zleslie/pkgng module and set it as the default package provider:

Package {
  provider => 'pkgng',
}

On Puppet 4.0 and later, pkgng is included within Puppet and is the default package provider.

Development

Puppet modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. To contribute to Puppet projects, see our module contribution guide.

Contributors

The list of contributors can be found at https://github.com/puppetlabs/puppetlabs-java/graphs/contributors.

Reference

Table of Contents

Classes

Public Classes

• java: This module manages the Java runtime package

Private Classes

• java::config:
• java::params: This class builds a hash of JDK/JRE packages and (for Debian) alternatives. For wheezy/precise, we provide Oracle JDK/JRE options, even though those are not in the package repositories.

Defined types

• java::oracle: Installs Oracle Java. By using this module you agree to the Oracle licensing agreement.

Classes

java

This module manages the Java runtime package

Parameters

The following parameters are available in the java class.

distribution

Data type: String

The java distribution to install. Can be one of "jdk" or "jre", or other platform-specific options where there are multiple implementations available (eg: OpenJDK vs Oracle JDK).

Default value: 'jdk'

version

Data type: Pattern[/present|installed|latest|^[.+_0-9a-zA-Z:~-]+$/]

The version of java to install. By default, this module simply ensures that java is present, and does not require a specific version.

Default value: 'present'

package

Data type: Optional[String]

The name of the java package. This is configurable in case a non-standard java package is desired.

Default value: undef

package_options

Data type: Optional[Array]

Array of strings to pass installation options to the 'package' Puppet resource. Options available depend on the 'package' provider for the target OS.

Default value: undef

java_alternative

Data type: Optional[String]

The name of the java alternative to use on Debian systems. "update-java-alternatives -l" will show which choices are available. If you specify a particular package, you will almost always also want to specify which java_alternative to choose. If you set this, you also need to set the path below.

Default value: undef

java_alternative_path

Data type: Optional[String]

The path to the "java" command on Debian systems. Since the alternatives system makes it difficult to verify which alternative is actually enabled, this is required to ensure the correct JVM is enabled.

Default value: undef

java_home

Data type: Optional[String]

The path to where the JRE is installed. This will be set as an environment variable.

Default value: undef

Defined types

java::oracle

Defined Type java::oracle

Install one or more versions of Oracle Java.

Uses the following to download the package and automatically accept the licensing terms:

wget --no-cookies --no-check-certificate --header \
"Cookie: gpw_e24=http%3A%2F%2Fwww.oracle.com%2F; oraclelicense=accept-securebackup-cookie" \
"http://download.oracle.com/otn-pub/java/jdk/8u131-b11/d54c1d3a095b4ff2b6607d096fa80163/jdk-8u131-linux-x64.tar.gz"

Parameters

The following parameters are available in the java::oracle defined type.

ensure

Data type: Any

Install or remove the package.

Default value: 'present'

version

Data type: Any

Version of Java to install, e.g. '7' or '8'. Default values for major and minor versions will be used.

Default value: '8'

version_major

Data type: Any

Major version which should be installed, e.g. '8u101'. Must be used together with version_minor.

Default value: undef

version_minor

Data type: Any

Minor version which should be installed, e.g. 'b12'. Must be used together with version_major.

Default value: undef

java_se

Data type: Any

Type of Java Standard Edition to install, jdk or jre.

Default value: 'jdk'

oracle_url

Data type: Any

Official Oracle URL to download binaries from.

Default value: 'http://download.oracle.com/otn-pub/java/jdk/'

proxy_server

Data type: Any

Specify a proxy server, with port number if needed. ie: https://example.com:8080. (passed to archive)

Default value: undef

proxy_type

Data type: Any

Proxy server type (none|http|https|ftp). (passed to archive)

Default value: undef

url

Data type: Any

Full URL, including oracle_url, release_major, release_minor and package_name, to download the Oracle java_se installer. Originally present but not used, activated to workaround MODULES-5058.

Default value: undef

url_hash

Data type: Any

Directory hash used by the download.oracle.com site. This value is a 32 character string which is part of the file URL returned by the JDK download site.

Default value: undef

jce

Data type: Any

Install Oracles Java Cryptographic Extensions into the JRE or JDK

Default value: false

basedir

Data type: Any

Directory under which the installation will occur. If not set, defaults to /usr/lib/jvm for Debian and /usr/java for RedHat.

Default value: undef

manage_basedir

Data type: Any

Whether to manage the basedir directory. Defaults to false. Note: /usr/lib/jvm is managed for Debian by default, separate from this parameter.

Default value: false

package_type

Data type: Any

Type of installation package for specified version of java_se. java_se 6 comes in a few installation package flavors and we need to account for them. Optional forced package types: rpm, rpmbin, tar.gz

Default value: undef

manage_symlink

Data type: Any

Whether to manage a symlink that points to the installation directory. Defaults to false.

Default value: false

symlink_name

Data type: Any

The name for the optional symlink in the installation directory.

Default value: undef

Change log

All notable changes to this project will be documented in this file. The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

v4.0.0 (2019-05-16)

Full Changelog

Changed

• pdksync - (MODULES-8444) - Raise lower Puppet bound #356 (david22swan)

Added

• (FM-7921) - Implement Puppet Strings #353 (david22swan)
• Update default version & java 8 version from 8u192 to 8u201 #347 (valentinsavenko)
• Add ability to override basedir and package type for oracle java #345 (fraenki)
• MODULES-8613: Add option to set a custom JCE download URL #344 (HielkeJ)

Fixed

• MODULES-8698: Fix $install_path on CentOS with tar.gz package type #349 (fraenki)

3.3.0 (2019-01-17)

Full Changelog

Added

• (MODULES-8234) - Add SLES 15 support #336 (eimlav)
• (MODULES-8234) - Upgrade Oracle Java version to 8u192 #334 (eimlav)
• Support for installing JCE. Fixes MODULES-1681 #326 (dploeger)
• MODULES-8044: upgrade Oracle Java 8 to 181, make it the default release #314 (ojongerius)

Fixed

• pdksync - (FM-7655) Fix rubygems-update for ruby \< 2.3 #338 (tphoney)
• (FM-7520) - Removing Solaris from the support matrix #335 (pmcmaw)
• Optimized code for making java::oracle atomic. Fixes MODULES-8085 #330 (dploeger)
• Fix OpenJDK paths on Debian based OS with ARM #329 (mmoll)
• (MODULES-7050) - Fix OracleJDK reinstalling on Puppet runs #323 (eimlav)
• (MODULES-8025) Switch default for Ubuntu 18.04 to 11 #322 (baurmatt)
• MODULES-7819 fix set JAVA_HOME environments on FreeBSD platform #315 (olevole)

3.2.0 (2018-09-27)

Full Changelog

Added

• pdksync - (MODULES-6805) metadata.json shows support for puppet 6 #317 (tphoney)

3.1.0 (2018-09-06)

Full Changelog

Added

• pdksync - (MODULES-7705) - Bumping stdlib dependency from \< 5.0.0 to \< 6.0.0 #310 (pmcmaw)

3.0.0 (2018-08-13)

Full Changelog

Changed

• [FM-6963] Removal of unsupported OS from java #295 (david22swan)

Added

• (MODULES-7561) - Addition of support for Ubuntu 18.04 to java #299 (david22swan)

Fixed

• Remove ensure_resource to avoid potential conflict #287 (sevencastles)

2.4.0

Summary

This release uses the PDK convert functionality which in return makes the module PDK compliant. Also includes a clean up from Rubocop.

Changed

• 1.3.2 PDK convert has been applied MODULES-6456
• The modules has undergone a Rubocop cleanup.

Fixed

• $java_home for SLES 11.4 has been updated to the correct location.

Supported Release 2.3.0

Summary

This release is in order to implement Rubocop changes into the module.

Added

• Several Modulesync changes have been made.
• Rubocop has been implemented in the module.
• CentOS 7 is now supported.
• Red Hat Enterprise Linux (RHEL) 7 is now supported.
• Ubuntu artful 1710 now supported.
• Bionic 1804 now supported.

Supported Release 2.2.0

Summary

This release is a maintenance release that includes a roll up of minor changes.

Added

• Addition of Ubuntu for Oracle Java.
• Addition of Debian 9 in supported versions.
• Addition of OpenBSD case and use realpath rather than readlink in Java Default Home Facter fact.

Removed

• Removal of OpenBSD as a special case and deprecated with_env in Java Version Facter Facter fact.

Supported Release 2.1.1

Summary

This release is a maintenance release that includes a roll up of minor changes.

Added

• Basic Arch Linux, Cloud Linux and Ubuntu 17.04 compatibility.
• Metadata bump for Puppet 5.
• Search for matching line with java version.
• (MODULES-4069) Fail when required params are not available in params.
• A test for java version when java not installed.
• Allow latest archive version as dependency.

Changed

• CONTRIBUTING.md document includes updates.
• Removal of Ubuntu 10.04 ad 12.04, Debian 6 in supported versions.

Supported Release 2.1.0

Summary

This release adds fixes to restore the ability to install Oracle Java. It also fixes the paths for the latest RHEL 7 1.7.0 and 1.8.0 OpenJDKs.

Added

• java::oracle parameter url
• java::oracle parameter url_hash

Fixed

• Let java_default_home fact work when /usr/bin/java does not exist
• Add puppet 4 parameter types
• Use /usr/lib/jvm/java-1.x.0 symlinks for java_home defaults.

Supported Release 2.0.0

Summary

This is a major release including some bug fixes, new parameters, and general module updates.

This release drops Puppet 3 support

Added

• Debian Stretch, Yakkety Yak, Amazon Linux, Oracle Linux, Scientific Linux CERN compatibility
• version_major and version_minor parameters for specifying Java SE version to install
• $JAVA_HOME now set by the module on compatible systems. The java_home parameter is also provided for manual setting. MODULES-2971
• proxy_server and proxy_type for choosing a proxy server to get Java from

Changed

• Moved lower Puppet version requirement to 4.7.0

Fixed

• Module no longer downloads the Java archive on Puppet runs if Java is already installed.
• java_default_home fact is not always correct on oracle packages MODULES-4050
• Order of operations for archives MODULES-4751
• Increase Xmx setting for java_version fact MODULES-4736

Supported Release 1.6.0

Summary

Addition of a new supported OS, along with several other features and bugfixes.

Features

• Ubuntu 16.04 support.
• Addition example for installing Java 8.
• Update to newest modulesync_configs.
• Addition of RedHat for Oracle Java.

Bugfixes

• Custom archive type now given extract_path.
• Fix for rspec deprectation warnings.
• Typo fixes for readme.
• Fixed tests to run under strict variables.
• Updated Java package for SLES 11.4.

Supported Release 1.5.0

Summary

A release which has several support additions for different OSes. Also a couple of additional features and a few bug fixes.

Features

• Added Ubuntu 15.10 compatibility.
• Addition of two facts: java_libjvm_path and java_default_home.
• Added support for oracle-j2re1.8 and oracle-j2sdk1.8.
• Adds FreeBSD Support.
• Exposed the Puppet package resources install_options parameter via a new class parameter named package_options.
• Debian 8 support.
• Add support for official Oracle Java SE jdk and jre packages for CentOS.
• Use java 8 as the default on RHEL > 7.0.

Bugfixes

• Updated fixtures.yml to use git instead of http for stdlib.
• Updates to current msync configs.
• Small README updates and syntax error fixes.

Supported Release 1.4.3

Summary

Small release for support of newer PE versions. This increments the version of PE in the metadata.json file.

2015-10-07 - Supported Release 1.4.2

Summary

This release fixes the fact to not trigger java every time on OS X when it is not available.

Bugfixes

• Causes java_version fact to not run java when java is not installed on OS X

2015-07-16 - Supported Release 1.4.1

Summary

This release updates the metadata for the upcoming release of PE and update params for OEL to match metadata

Bugfixes:

• Add missing OEL to params

2015-07-07 - Supported Release 1.4.0

Summary

This release adds several new features, bugfixes, documentation updates, and test improvements.

Features:

• Puppet 4 support and testing
• Adds support for several Operating Systems
  • Ubuntu 15.04
  • OpenBSD 5.6, 5.7
  • Fedora 20, 21, 22

Bugfixes:

• Fixes java_version fact to work on large systems. (MODULES-1749)
• Improves maintainability of java_version fact.
• Fixes java package names on Fedora 21+.
• Fixes java install problems on Puppet 3.7.5 - 3.8.1 (PUP-4520)
• Fixes create-java-alternatives commands on RedHat distros.
• Fixes bug with Debian systems missing java-common package.

2015-01-20 - Supported Release 1.3.0

Summary

This release adds 3 new facts for determining Java version, adds RHEL alternatives support, adds utopic support, and fixes the flag for update-java-alternatives when installed from a headless pacakge.

Features

• Added RHEL support for alternatives
• New facts
  • java_major_version
  • java_patch_level
  • java_version
• Add support for utopic

Bugfixes

• Use --jre-headless in the update-java-alternatives command when installed from a headless package

2014-11-11 - Supported Version 1.2.0

Summary:

This release adds SLES 12 support and is tested for Future Parser Support

Bugfixes:

• Several readme updates
• Testcase flexability increased

Features:

• Add SLES 12 support
• Future Parser tested
• Validated against PE 3.7

2014-08-25 - Supported Version 1.1.2

Summary:

This release begins the support coverage of the puppetlabs-java module.

Bugfixes:

• Update java alternative values from deprecated names
• Readme updated
• Testing updated

2014-05-02 - Version 1.1.1

Summary:

Add support for new versions of Debian and Ubuntu!

Features:

• Add support for Ubuntu Trusty (14.04)
• Add support for Debian Jessie (8.x)

2014-01-06 - Version 1.1.0

Summary:

Primarily a release for Ubuntu users!

Features:

• Add support for Ubuntu Saucy (13.10)
• Add java_home parameter for centralized setting of JAVA_HOME.
• Add Scientific Linux

Bugfixes:

• Plus signs are valid in debian/ubuntu package names.

2013-08-01 - Version 1.0.1

Matthaus Owens matthaus@puppetlabs.com

• Update java packages for Fedora systems

2013-07-29 - Version 1.0.0

Detailed Changes

Krzysztof Suszyński krzysztof.suszynski@coi.gov.pl

• Adding support for Oracle Enterprise Linux

Peter Drake pdrake@allplayers.com

• Add support for natty

Robert Munteanu rmuntean@adobe.com

• Add support for OpenSUSE

Martin Jackson martin@uncommonsense-uk.com

• Added support Amazon Linux using facter >= 1.7.x

Gareth Rushgrove gareth@morethanseven.net Brett Porter brett@apache.org

• Fixes for older versions of CentOS
• Improvements to module build and tests

Nathan R Valentine nrvale0@gmail.com

• Add support for Ubuntu quantal and raring

Sharif Nassar sharif@mediatemple.net

• Add support for Debian alternatives, and more than one JDK/JRE per platform.

2013-04-04 - Version 0.3.0

Reid Vandewiele reid@puppetlabs.com -

• Refactor, introduce params pattern

2012-11-15 - Version 0.2.0

Scott Schneider sschneider@puppetlabs.com

• Add Solaris support

2011-06-16 - Version 0.1.5

Jeff McCune jeff@puppetlabs.com

• Add Debian based distro (Lucid) support

2011-06-02 - Version 0.1.4

Jeff McCune jeff@puppetlabs.com

• Fix class composition ordering problems

2011-05-28 - Version 0.1.3

Jeff McCune jeff@puppetlabs.com

• Remove stages

2011-05-26 - Version 0.1.2

Jeff McCune jeff@puppetlabs.com

• Changes JRE/JDK selection class parameter to $distribution

2011-05-25 - Version 0.1.1

Jeff McCune jeff@puppetlabs.com

• Re-did versioning to follow semantic versioning
• Add validation of class parameters

2011-05-24 - Version 0.1.0

Jeff McCune jeff@puppetlabs.com

• Default to JDK version 6u25

2011-05-24 - Version 0.0.1

Jeff McCune jeff@puppetlabs.com

• Initial release

* This Changelog was automatically generated by github_changelog_generator