Skip to content

Commit c35e0ef

Browse files
author
Glyn Normington
committed
Add examples other than Tomcat
[#59910222]
1 parent 9a6dd12 commit c35e0ef

2 files changed

Lines changed: 23 additions & 1 deletion

File tree

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ To use this buildpack specify the URI of the repository when pushing an applicat
1313
## Configuration and Extension
1414
The buildpack supports configuration and extension through the use of Git repository forking. The easiest way to accomplish this is to use [GitHub's forking functionality][] to create a copy of this repository. Make the required configuration and extension changes in the copy of the repository. Then specify the URL of the new repository when pushing Cloud Foundry applications. If the modifications are generally applicable to the Cloud Foundry community, please submit a [pull request][] with the changes.
1515

16+
To learn how to configure various properties of the buildpack, follow the "Configuration" links below. More information on extending the buildpack is available [here](docs/extending.md).
17+
1618
## Additional Documentation
1719
* [Design](docs/design.md)
1820
* [Migrating from the Previous Java Buildpack](docs/migration.md)

docs/extending.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
# Extending
2+
3+
For general information on extending the buildpack, refer to [Configuration and Extension](../README.md#Configuration-and-Extension).
4+
25
To add a component, its class file must be put in a specific location and the class name added to [`config/components.yml`][].
36

47
| Component Type | Location
@@ -39,7 +42,7 @@ def release
3942

4043

4144
## Component Context
42-
Each component class must have an `initialize` method that takes a `Hash` containg contextual information about the application. It is this "whiteboard" that is used by the components to communicate with one another. The context contains the following entries:
45+
Each component class must have an `initialize` method that takes a `Hash` containing contextual information about the application. It is this "whiteboard" that is used by the components to communicate with one another. The context contains the following entries:
4346

4447
| Name | Type | Description
4548
| ---- | ---- | -----------
@@ -71,3 +74,20 @@ This base class is recommended for use by any component that uses the buildpack
7174
[`lib/java_buildpack/jre`]: ../lib/java_buildpack/jre
7275
[`lib/java_buildpack/versioned_dependency_component.rb`]: ../lib/java_buildpack/versioned_dependency_component.rb
7376
[repository support]: util-repositories.md
77+
78+
## Examples
79+
The following example components are relatively simple and good for copying as the basis for a new component.
80+
81+
### `JAVA_OPTS` Framework
82+
83+
The [`JAVA_OPTS` Framework](framework-java_opts.md) ([`lib/java_buildpack/framework/java_opts.rb`](../lib/java_buildpack/framework/java_opts.rb)) extends the [`BaseComponent`](../lib/java_buildpack/base_component.rb) base class described above.
84+
85+
### Java Main Class Container
86+
87+
The [Java Main Class Container](container-java-main.md) ([`lib/java_buildpack/container/main.rb`](../lib/java_buildpack/container/main.rb)) extends the [`BaseComponent`](../lib/java_buildpack/base_component.rb) base class described above.
88+
89+
### Spring Boot CLI Container
90+
91+
The [Spring Boot CLI Container](container-spring-boot-cli.md) ([`lib/java_buildpack/container/spring_boot_cli.rb`](../lib/java_buildpack/container/spring_boot_cli.rb)) extends the [`VersionedDependencyComponent`](../lib/java_buildpack/versioned_dependency_component.rb) base class described above.
92+
93+

0 commit comments

Comments
 (0)