The Apache Tomee Buildpack is a Cloud Native Buildpack that contributes Apache Tomee and Process Types for WARs.

This buildpack will participate all the following conditions are met

• <APPLICATION_ROOT>/WEB-INF exists
• Main-Class is NOT defined in the manifest
• BP_JAVA_APP_SERVER is set to tomee

The buildpack will do the following:

• Requests that a JRE be installed
• Contribute a Tomee instance to $CATALINA_HOME
• Contribute a Tomee instance to $CATALINA_BASE
  • Contribute context.xml, logging.properties, server.xml, and web.xml to conf/
  • Contribute Access Logging Support, Lifecycle Support, and Logging Support
  • Contribute external configuration if available
• Contributes tomee, task, and web process types

When this buildpack runs on the Tiny stack, which has no shell, the following notes apply:

• As there is no shell, the catalina.sh script cannot be used to start Tomee
• The Tomee Buildpack will generate a start command directly. It does not support all the functionality in catalina.sh.
• Some configuration options such as bin/setenv.sh and setting CATALINA_* environment variables, will not be available.
• Tomee will be run with umask set to 0022 instead of the catalina.shprovided default of 0027

The artifacts that the repository provides must be in TAR format and must follow the Tomee archive structure:

<CATALINA_BASE>
└── conf
    ├── context.xml
    ├── server.xml
    ├── web.xml
    ├── ...

When the Environment Property Source is configured, configuration for Tomcats configuration files can be loaded from environment variables. To use this feature, the name of the environment variable must match the name of the property.

The buildpack optionally accepts the following bindings:

Buildpacks can contribute JARs to the CLASSPATH of Tomcat by appending a path to BPI_TOMCAT_ADDITIONAL_JARS.

func (s) Contribute(layer libcnb.Layer) (libcnb.Layer, error) {
	// Copy dependency into the layer
	file := filepath.Join(layer.Path, filepath.Base(s.Dependency.URI))

	layer, err := s.LayerContributor.Contribute(layer, func(artifact *os.File) (libcnb.Layer, error) {
		if err := sherpa.CopyFile(artifact, file); err != nil {
			return libcnb.Layer{}, fmt.Errorf("unable to copy artifact to %s\n%w", file, err)
		}
		return layer, nil
	})

	additionalJars := []string{file}
  // Add dependency to BPI_TOMCAT_ADDITIONAL_JARS
	layer.LaunchEnvironment.Append("BPI_TOMCAT_ADDITIONAL_JARS", ":", strings.Join(additionalJars, ":"))
	return layer, nil
}

This buildpack is released under version 2.0 of the Apache License.