{"id":18554360,"url":"https://github.com/oracle/coherence-eclipse-plugin","last_synced_at":"2025-04-09T23:31:17.756Z","repository":{"id":37730556,"uuid":"329410921","full_name":"oracle/coherence-eclipse-plugin","owner":"oracle","description":"The Coherence Eclipse Plugin provides various features to help developer productivity when working with Coherence.","archived":false,"fork":false,"pushed_at":"2024-07-17T02:43:51.000Z","size":651,"stargazers_count":3,"open_issues_count":0,"forks_count":4,"subscribers_count":8,"default_branch":"main","last_synced_at":"2024-07-17T05:39:13.712Z","etag":null,"topics":["coherence","coherence-ce","eclipse-plugin","plugin"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"upl-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/oracle.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-01-13T19:28:55.000Z","updated_at":"2024-07-17T02:43:48.000Z","dependencies_parsed_at":"2024-01-17T03:57:50.647Z","dependency_job_id":"8b7594ba-91d1-4629-ba35-f82d1ff9d1a5","html_url":"https://github.com/oracle/coherence-eclipse-plugin","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oracle%2Fcoherence-eclipse-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oracle%2Fcoherence-eclipse-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oracle%2Fcoherence-eclipse-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oracle%2Fcoherence-eclipse-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oracle","download_url":"https://codeload.github.com/oracle/coherence-eclipse-plugin/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223416788,"owners_count":17141887,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["coherence","coherence-ce","eclipse-plugin","plugin"],"created_at":"2024-11-06T21:21:32.276Z","updated_at":"2024-11-06T21:21:32.895Z","avatar_url":"https://github.com/oracle.png","language":"Java","readme":"\u003c!--\n\n  Copyright (c) 2021 Oracle and/or its affiliates.\n\n  Licensed under the Universal Permissive License v 1.0 as shown at\n  https://oss.oracle.com/licenses/upl.\n\n--\u003e\n\n\n\u003cimg src=https://oracle.github.io/coherence/assets/images/logo-red.png\u003e\u003cimg\u003e\n\n# Coherence Eclipse Plugin\n\n![CI Build](https://github.com/oracle/coherence-eclipse-plugin/workflows/Java%20CI/badge.svg)\n[![License](http://img.shields.io/badge/license-UPL%201.0-blue.svg)](https://oss.oracle.com/licenses/upl/)\n\n## Contents\n\n* [Overview](#overview)\n* [Installation](#installation)\n* [Using the Plugin](#using-the-plugin)\n* [Example Projects](examples/pof-plugin-example-project)\n* [Development](#development)\n  * [Build the Plugin](#build-the-plugin)\n  * [Install the Plugin Manually](#install-the-plugin-manually)\n  * [Open The Plugin Project](#open-the-plugin-project)\n\n\n## Overview\n\nThe Coherence Eclipse Plugin provides various features to help developer productivity when working with Coherence.\n\nCurrently this plugin supports the following features:\n* `Coherence POF Plugin` - Provides a development time instrumentation of classes with the `PortableType` annotation to generate\n  consistent (and correct) implementations of `Evolvable` POF serialization methods.\n  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.\n  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.\n\n## Installation\n\n### Using Eclipse Marketplace Client\n\nIf you are using Eclipse Marketplace Client, then you can use either of the following methods:\n\n1. Drag the following to your running Eclipse workspace\n\n   [![Drag to your running Eclipse* workspace. *Requires Eclipse Marketplace Client](https://marketplace.eclipse.org/sites/all/themes/solstice/public/images/marketplace/btn-install.svg)](http://marketplace.eclipse.org/marketplace-client-intro?mpc_install=5351771 \"Drag to your running Eclipse* workspace. *Requires Eclipse Marketplace Client\")\n\n2. Open Eclipse Marketplace Client and search for \u003ckbd\u003eCoherence\u003c/kbd\u003e, then choose \u003ckbd\u003eInstall\u003c/kbd\u003e on the \u003ckbd\u003eCoherence Eclipse Plugin 1.0.0\u003c/kbd\u003e. Accept the terms and conditions and click \u003ckbd\u003eFinish\u003c/kbd\u003e.\n\n   ![Eclipse Marketplace Client](assets/mpc.png)\n\n\n### Install Manually\n\nTo install the plugin carry out the following:\n\n1. Choose \u003ckbd\u003eHelp\u003c/kbd\u003e -\u003e \u003ckbd\u003eInstall New Software\u003c/kbd\u003e\n\n1. Click on \u003ckbd\u003eAdd\u003c/kbd\u003e button on the right\n\n1. Choose a name such as `Coherence Eclipse Plugin Update Site`\n\n1. Enter the location of the Plugin Repository `https://oracle.github.io/coherence-eclipse-plugin/eclipse/1.0.0` and click \u003ckbd\u003eAdd\u003c/kbd\u003e.\n\n1. Select the `Coherence Eclipse Plugin` displayed in the list and click \u003ckbd\u003eNext\u003c/kbd\u003e, then \u003ckbd\u003eNext\u003c/kbd\u003e\n\n1. Accept the license terms and click \u003ckbd\u003eFinish\u003c/kbd\u003e\n\n1. Click \u003ckbd\u003eRestart Now\u003c/kbd\u003e to restart Eclipse\n\n## Using the plugin\n\n\u003e Note: You can use the example project [here](examples/pof-plugin-example-project) to test the plugin.\n\n### Enable the Plugin\n\n1. Right-click on your open project\n\n2. Select \u003ckbd\u003eConfigure\u003c/kbd\u003e then \u003ckbd\u003eEnable Coherence POF Plugin\u003c/kbd\u003e\n\n![Messages](assets/enable.png)\n\n### Disable the Plugin\n\n1. Right-click on your open project\n\n2. Select \u003ckbd\u003eConfigure\u003c/kbd\u003e then \u003ckbd\u003eDisable Coherence POF Plugin\u003c/kbd\u003e\n\n### Verifying\n\nWhen you build your project, for any Java classes that use the `@PortableType` annotation\nyou will see an Info message in the `Problems` tab saying the class was instrumented.\n\nA message indicating the class was not instrumented can indicate that it has already been instrumented\nor is ignored because is does not implement the `PortableType` annotation.\n\n![Messages](assets/messages.png)\n\n## Uninstall the Plugin\n\n1. Choose \u003ckbd\u003eHelp\u003c/kbd\u003e -\u003e \u003ckbd\u003eInstall New Software\u003c/kbd\u003e\n\n1. Click on \u003ckbd\u003eWhat is already installed\u003c/kbd\u003e link\n\n1. Search for \u003ckbd\u003eCoherence\u003c/kbd\u003e and select \u003ckbd\u003eCoherence Eclipse Plugin\u003c/kbd\u003e\n\n1. Click \u003ckbd\u003eUn-install\u003c/kbd\u003e then \u003ckbd\u003eFinish\u003c/kbd\u003e\n\n1. Click \u003ckbd\u003eRestart Now\u003c/kbd\u003e to restart Eclipse  \n\n## Development\n\n### Build the Plugin\n\nYou must have:\n* JDK1.8\n* Maven 3.6.3+\n* Minimum Eclipse version 2020-03\n\n1. Clone the repository\n\n   ```bash\n   git clone https://github.com/oracle/coherence-eclipse-plugin.git\n   ```\n\n1. Build the plugin\n\n   ```bash\n   cd coherence-eclipse-plugin\n\n   mvn clean install\n   ```\n\nThis will generate a zip file called `./coherence.eclipse.plugin.repository/target/coherence-eclipse-plugin-repository-1.0.0-SNAPSHOT.zip`\n\n### Install the Plugin manually\n\n1. Choose \u003ckbd\u003eHelp\u003c/kbd\u003e -\u003e \u003ckbd\u003eInstall New Software\u003c/kbd\u003e\n\n1. Click on \u003ckbd\u003eAdd\u003c/kbd\u003e button on the right\n\n1. Choose a name such as \u003ckbd\u003eCoherence Local\u003c/kbd\u003e\n\n1. Click on \u003ckbd\u003eArchive\u003c/kbd\u003e and choose the zip file mentioned above and click \u003ckbd\u003eAdd\u003c/kbd\u003e\n\n1. Select the \u003ckbd\u003eCoherence Eclipse Plugin\u003c/kbd\u003e displayed in the list and click \u003ckbd\u003eNext\u003c/kbd\u003e, then \u003ckbd\u003eNext\u003c/kbd\u003e\n\n1. Accept the license terms and click \u003ckbd\u003eFinish\u003c/kbd\u003e\n\n1. You may receive a warning that the plugin is unsigned. Choose \u003ckbd\u003eInstall Anyway\u003c/kbd\u003e\n\n1. Click \u003ckbd\u003eRestart Now\u003c/kbd\u003e to restart Eclipse  \n\n### Open the Plugin Project\n\nTo import the plugin project into your Eclipse IDE, carry out the following:\n\n1. Clone the repository using:\n\n   ```bash\n   git clone https://github.com/oracle/coherence-eclipse-plugin.git\n   ```\n\n1. Open Eclipse\n\n1. Choose \u003ckbd\u003eFile\u003c/kbd\u003e -\u003e \u003ckbd\u003eOpen Projects from Filesystem\u003c/kbd\u003e\n\n1. Choose \u003ckbd\u003eDirectory\u003c/kbd\u003e and select the \u003ckbd\u003ecoherence-eclipse-plugin\u003c/kbd\u003e project you cloned, then click `Done`\n\n1. Ensure you only select the `coherence-eclipse-plugin/coherence.eclipse.plugin` as shown below:\n\n   ![Import](assets/import.png)\n\n\u003e Note: Ignore any errors from the `pom.xml` file as this is only used for a Maven build.\n\n## Contributing\n\nThis project welcomes contributions from the community. Before submitting a pull request, please [review our contribution guide](./CONTRIBUTING.md)\n\n## Security\n\nPlease consult the [security guide](./SECURITY.md) for our responsible security vulnerability disclosure process\n\n## License\n\nCopyright (c) 2020, 2023 Oracle and/or its affiliates.\n\nReleased under the Universal Permissive License v1.0 as shown at\n\u003chttps://oss.oracle.com/licenses/upl/\u003e.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foracle%2Fcoherence-eclipse-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foracle%2Fcoherence-eclipse-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foracle%2Fcoherence-eclipse-plugin/lists"}