https://github.com/oracle/coherence-eclipse-plugin
The Coherence Eclipse Plugin provides various features to help developer productivity when working with Coherence.
https://github.com/oracle/coherence-eclipse-plugin
coherence coherence-ce eclipse-plugin plugin
Last synced: 6 months ago
JSON representation
The Coherence Eclipse Plugin provides various features to help developer productivity when working with Coherence.
- Host: GitHub
- URL: https://github.com/oracle/coherence-eclipse-plugin
- Owner: oracle
- License: upl-1.0
- Created: 2021-01-13T19:28:55.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-07-17T02:43:51.000Z (about 1 year ago)
- Last Synced: 2024-07-17T05:39:13.712Z (about 1 year ago)
- Topics: coherence, coherence-ce, eclipse-plugin, plugin
- Language: Java
- Homepage:
- Size: 636 KB
- Stars: 3
- Watchers: 8
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Security: SECURITY.md
Awesome Lists containing this project
README
![]()
# Coherence Eclipse Plugin
[](https://oss.oracle.com/licenses/upl/)
## Contents
* [Overview](#overview)
* [Installation](#installation)
* [Using the Plugin](#using-the-plugin)
* [Example Projects](examples/pof-plugin-example-project)
* [Development](#development)
* [Build the Plugin](#build-the-plugin)
* [Install the Plugin Manually](#install-the-plugin-manually)
* [Open The Plugin Project](#open-the-plugin-project)
## Overview
The Coherence Eclipse Plugin provides various features to help developer productivity when working with Coherence.
Currently this plugin supports the following features:
* `Coherence POF Plugin` - Provides a development time instrumentation of classes with the `PortableType` annotation to generate
consistent (and correct) implementations of `Evolvable` POF serialization methods.
This development time plugin can be used in conjunction with the [POF Maven Plugin](https://github.com/oracle/coherence/tree/master/prj/plugins/maven/pof-maven-plugin) which instruments classes at project build time.
See the official [Portable Type](https://coherence.community/21.06/docs/#/docs/core/04_portable_types) documentation for more details on writing portable types in Coherence.
## Installation
### Using Eclipse Marketplace Client
If you are using Eclipse Marketplace Client, then you can use either of the following methods:
1. Drag the following to your running Eclipse workspace
[](http://marketplace.eclipse.org/marketplace-client-intro?mpc_install=5351771 "Drag to your running Eclipse* workspace. *Requires Eclipse Marketplace Client")
2. Open Eclipse Marketplace Client and search for Coherence, then choose Install on the Coherence Eclipse Plugin 1.0.0. Accept the terms and conditions and click Finish.
### Install Manually
To install the plugin carry out the following:
1. Choose Help -> Install New Software
1. Click on Add button on the right
1. Choose a name such as `Coherence Eclipse Plugin Update Site`
1. Enter the location of the Plugin Repository `https://oracle.github.io/coherence-eclipse-plugin/eclipse/1.0.0` and click Add.
1. Select the `Coherence Eclipse Plugin` displayed in the list and click Next, then Next
1. Accept the license terms and click Finish
1. Click Restart Now to restart Eclipse
## Using the plugin
> Note: You can use the example project [here](examples/pof-plugin-example-project) to test the plugin.
### Enable the Plugin
1. Right-click on your open project
2. Select Configure then Enable Coherence POF Plugin
### Disable the Plugin
1. Right-click on your open project
2. Select Configure then Disable Coherence POF Plugin
### Verifying
When you build your project, for any Java classes that use the `@PortableType` annotation
you will see an Info message in the `Problems` tab saying the class was instrumented.
A message indicating the class was not instrumented can indicate that it has already been instrumented
or is ignored because is does not implement the `PortableType` annotation.
## Uninstall the Plugin
1. Choose Help -> Install New Software
1. Click on What is already installed link
1. Search for Coherence and select Coherence Eclipse Plugin
1. Click Un-install then Finish
1. Click Restart Now to restart Eclipse
## Development
### Build the Plugin
You must have:
* JDK1.8
* Maven 3.6.3+
* Minimum Eclipse version 2020-03
1. Clone the repository
```bash
git clone https://github.com/oracle/coherence-eclipse-plugin.git
```
1. Build the plugin
```bash
cd coherence-eclipse-plugin
mvn clean install
```
This will generate a zip file called `./coherence.eclipse.plugin.repository/target/coherence-eclipse-plugin-repository-1.0.0-SNAPSHOT.zip`
### Install the Plugin manually
1. Choose Help -> Install New Software
1. Click on Add button on the right
1. Choose a name such as Coherence Local
1. Click on Archive and choose the zip file mentioned above and click Add
1. Select the Coherence Eclipse Plugin displayed in the list and click Next, then Next
1. Accept the license terms and click Finish
1. You may receive a warning that the plugin is unsigned. Choose Install Anyway
1. Click Restart Now to restart Eclipse
### Open the Plugin Project
To import the plugin project into your Eclipse IDE, carry out the following:
1. Clone the repository using:
```bash
git clone https://github.com/oracle/coherence-eclipse-plugin.git
```
1. Open Eclipse
1. Choose File -> Open Projects from Filesystem
1. Choose Directory and select the coherence-eclipse-plugin project you cloned, then click `Done`
1. Ensure you only select the `coherence-eclipse-plugin/coherence.eclipse.plugin` as shown below:
> Note: Ignore any errors from the `pom.xml` file as this is only used for a Maven build.
## Contributing
This project welcomes contributions from the community. Before submitting a pull request, please [review our contribution guide](./CONTRIBUTING.md)
## Security
Please consult the [security guide](./SECURITY.md) for our responsible security vulnerability disclosure process
## License
Copyright (c) 2020, 2023 Oracle and/or its affiliates.
Released under the Universal Permissive License v1.0 as shown at
.