Giter Club home page Giter Club logo

coherence-eclipse-plugin's Introduction

Coherence Eclipse Plugin

CI Build License

Contents

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 which instruments classes at project build time. See the official Portable Type 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

    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.

    Eclipse Marketplace Client

Install Manually

To install the plugin carry out the following:

  1. Choose Help -> Install New Software

  2. Click on Add button on the right

  3. Choose a name such as Coherence Eclipse Plugin Update Site

  4. Enter the location of the Plugin Repository https://oracle.github.io/coherence-eclipse-plugin/eclipse/1.0.0 and click Add.

  5. Select the Coherence Eclipse Plugin displayed in the list and click Next, then Next

  6. Accept the license terms and click Finish

  7. Click Restart Now to restart Eclipse

Using the plugin

Note: You can use the example project here to test the plugin.

Enable the Plugin

  1. Right-click on your open project

  2. Select Configure then Enable Coherence POF Plugin

Messages

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.

Messages

Uninstall the Plugin

  1. Choose Help -> Install New Software

  2. Click on What is already installed link

  3. Search for Coherence and select Coherence Eclipse Plugin

  4. Click Un-install then Finish

  5. 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

    git clone https://github.com/oracle/coherence-eclipse-plugin.git
  2. Build the plugin

    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

  2. Click on Add button on the right

  3. Choose a name such as Coherence Local

  4. Click on Archive and choose the zip file mentioned above and click Add

  5. Select the Coherence Eclipse Plugin displayed in the list and click Next, then Next

  6. Accept the license terms and click Finish

  7. You may receive a warning that the plugin is unsigned. Choose Install Anyway

  8. 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:

    git clone https://github.com/oracle/coherence-eclipse-plugin.git
  2. Open Eclipse

  3. Choose File -> Open Projects from Filesystem

  4. Choose Directory and select the coherence-eclipse-plugin project you cloned, then click Done

  5. Ensure you only select the coherence-eclipse-plugin/coherence.eclipse.plugin as shown below:

    Import

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

Security

Please consult the security guide 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 https://oss.oracle.com/licenses/upl/.

coherence-eclipse-plugin's People

Contributors

aseovic avatar dhirupandey avatar spavlusieva avatar thegridman avatar tmiddlet2666 avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.