Merge pull request #2 from googlielmo/bundle-0.3-hazelcast-all-3.11.1

Update to Hazelcast 3.11

Author: googlielmo

README.md

@@ -13,26 +13,15 @@ This repository contains Hazelcast DynaCache feature for Liberty Profile.
 In Liberty WAS, you can use dynamic cache engine (which is the default) in order to cache your data.
 With this feature, you can use Hazelcast as cache provider.
 
+Tested with Liberty 16.0.0.3.
+
 # Requirements
 
 - Maven
 - Download and extract [Liberty 16.0.0.3](https://public.dhe.ibm.com/ibmdl/export/pub/software/websphere/wasdev/downloads/wlp/16.0.0.3/wlp-javaee7-16.0.0.3.zip)
 
 # Creating Development Environment
 
-- Clone `bundle` branch of the modified version of Hazelcast library:
- 
-    ```
-    git clone -b bundle https://github.com/emre-aydin/hazelcast.git
-    ```
-
-- Install the modified version of Hazelcast into local Maven repository. Execute the following in `hazelcast` 
-project root directory:
-
-    ```
-    mvn clean install -DskipTests=true
-    ```
-
 - Clone this GitHub repository: 
 
     ```
@@ -46,7 +35,7 @@ project root directory:
 Install the `.esa` file by executing the following command:
 
 ```
-<liberty dir>/bin/featureManager install hazelcast-dynacache/hazelcast-dynacache/target/hazelcast-dynacache-0.2.esa
+<liberty dir>/bin/featureManager install hazelcast-dynacache/hazelcast-dynacache/target/hazelcast-dynacache-0.3.esa
 ```    
 
 Use `hazelcast` as your cache provider name in your `cacheinstances.properties` file.
@@ -68,8 +57,7 @@ Enable Hazelcast DynaCache by adding the following snippet to your `server.xml`
 [Apply the iFix](http://www.ibm.com/support/knowledgecenter/SS7K4U_8.5.5/com.ibm.websphere.installation.nd.doc/ae/tins_install_fixes_dist.html)
  under `twas-ifix` directory to your WebSphere server and put the following files under `WAS_HOME/lib/ext`:
 
-* hazelcast-3.8-BUNDLE.jar
-* hazelcast-client-3.8-BUNDLE.jar
-* hazelcast-dynacache-bundle-0.2.jar
+* hazelcast-all-3.11.jar
+* hazelcast-dynacache-bundle-0.3.jar
 
 Use `com.hazelcast.ibm.dynacache.CacheProviderImpl` as your cache provider name in your `cacheinstances.properties` file.

hazelcast-dynacache-bundle/pom.xml

@@ -1,5 +1,5 @@
 <!--
-  ~ Copyright (c) 2008-2016, Hazelcast, Inc. All Rights Reserved.
+  ~ Copyright (c) 2008-2019, Hazelcast, Inc. All Rights Reserved.
   ~
   ~ Licensed under the Apache License, Version 2.0 (the "License");
   ~ you may not use this file except in compliance with the License.
@@ -21,7 +21,7 @@
     <parent>
         <groupId>com.hazelcast</groupId>
         <artifactId>hazelcast-dynacache-root</artifactId>
-        <version>0.2</version>
+        <version>0.3</version>
     </parent>
 
     <artifactId>hazelcast-dynacache-bundle</artifactId>
@@ -31,7 +31,7 @@
     <dependencies>
         <dependency>
             <groupId>com.hazelcast</groupId>
-            <artifactId>hazelcast-client</artifactId>
+            <artifactId>hazelcast-all</artifactId>
             <version>${hazelcast.version}</version>
         </dependency>
         <dependency>
@@ -70,18 +70,13 @@
                 <extensions>true</extensions>
                 <configuration>
                     <instructions>
-                        <Bundle-Activator>com.hazelcast.ibm.dynacache.Activator</Bundle-Activator>
+                        <Bundle-Activator>com.hazelcast.client.osgi.Activator</Bundle-Activator>
                         <Export-Package>
-                            com.hazelcast.ibm.dynacache
+                            com.hazelcast.ibm.dynacache,
+                            com.hazelcast.client.osgi
                         </Export-Package>
                         <Import-Package>
-                            com.hazelcast.client;version="3.8.0.BUNDLE",
-                            com.hazelcast.client.osgi;version="3.8.0.BUNDLE",
-                            com.hazelcast.client.config;version="3.8.0.BUNDLE",
-                            com.hazelcast.client.impl;version="3.8.0.BUNDLE",
-                            com.hazelcast.config;version="3.8.0.BUNDLE",
-                            com.hazelcast.core;version="3.8.0.BUNDLE",
-                            com.hazelcast.map;version="3.8.0.BUNDLE",
+                            com.hazelcast.*;version="3.11.0",
                             com.ibm.websphere.cache;version="1.0.0",
                             com.ibm.wsspi.cache;version="1.1.0",
                             org.osgi.framework;version="1.8.0",
@@ -91,7 +86,6 @@
                             OSGI-INF/com.hazelcast.ibm.dynacache.CacheProviderImpl.xml
                         </Service-Component>
                         <Bundle-RequiredExecutionEnvironment>JavaSE-1.7</Bundle-RequiredExecutionEnvironment>
-                        <Application-Content>com.hazelcast.client;version="[3.8.0.BUNDLE,3.8.0.BUNDLE]"</Application-Content>
                     </instructions>
                 </configuration>
             </plugin>

hazelcast-dynacache-bundle/src/main/java/com/hazelcast/client/osgi/Activator.java

@@ -0,0 +1,91 @@
+/*
+ * Copyright (c) 2008-2019, Hazelcast, Inc. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.hazelcast.client.osgi;
+
+import com.hazelcast.logging.ILogger;
+import com.hazelcast.logging.Logger;
+import org.osgi.framework.BundleActivator;
+import org.osgi.framework.BundleContext;
+
+import java.lang.reflect.Method;
+
+/**
+ * Hazelcast OSGi bundle activator.
+ *
+ * @see org.osgi.framework.BundleActivator
+ */
+public class Activator
+        implements BundleActivator {
+
+    private static final ILogger LOGGER = Logger.getLogger(Activator.class);
+
+    // Defined as `volatile` since Javadoc of `BundleActivator` says that
+    // `The Framework must not concurrently call a BundleActivator object`
+    // and also it is marked as `@NotThreadSafe`.
+    // So it can be called from different threads but cannot be called concurrently.
+    private volatile HazelcastClientInternalOSGiService hazelcastClientOSGiService;
+
+    @Override
+    public void start(BundleContext context)
+            throws Exception {
+        // Try to start javax.scripting - JSR 223
+        activateJavaxScripting(context);
+
+        assert hazelcastClientOSGiService == null : "Hazelcast OSGI service should be null while starting!";
+
+        // Create a new Hazelcast OSGI service with given bundle and its context
+        hazelcastClientOSGiService = new HazelcastClientOSGiServiceImpl(context.getBundle());
+
+        // Activate new created Hazelcast OSGI service
+        hazelcastClientOSGiService.activate();
+
+        LOGGER.finest("hazelcast-dynacache bundle started");
+    }
+
+    @Override
+    public void stop(BundleContext context)
+            throws Exception {
+        assert hazelcastClientOSGiService != null : "Hazelcast OSGI service should not be null while stopping!";
+
+        hazelcastClientOSGiService.deactivate();
+        hazelcastClientOSGiService = null;
+
+        LOGGER.finest("hazelcast-dynacache bundle stopped");
+    }
+
+    private void activateJavaxScripting(BundleContext context)
+            throws Exception {
+        if (isJavaxScriptingAvailable()) {
+            Class<?> clazz = context.getBundle().loadClass("com.hazelcast.osgi.impl.ScriptEngineActivator");
+            Method register = clazz.getDeclaredMethod("registerOsgiScriptEngineManager", BundleContext.class);
+            register.setAccessible(true);
+            register.invoke(clazz, context);
+        } else {
+            LOGGER.warning("Hazelcast: javax.scripting is not available, scripts from Management Center cannot be executed!");
+        }
+    }
+
+    static boolean isJavaxScriptingAvailable() {
+        try {
+            Class.forName("javax.script.ScriptEngineManager");
+            return true;
+        } catch (ClassNotFoundException e) {
+            return false;
+        }
+    }
+
+}

hazelcast-dynacache-bundle/src/main/java/com/hazelcast/client/osgi/HazelcastClientInternalOSGiService.java

@@ -0,0 +1,61 @@
+/*
+ * Copyright (c) 2008-2019, Hazelcast, Inc. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.hazelcast.client.osgi;
+
+import com.hazelcast.instance.BuildInfoProvider;
+import com.hazelcast.osgi.HazelcastOSGiService;
+
+/**
+ * Contract point for internal Hazelcast services on top of OSGI.
+ *
+ * @see HazelcastOSGiService
+ */
+public interface HazelcastClientInternalOSGiService
+        extends HazelcastClientOSGiService {
+
+    /**
+     * Default id for {@link HazelcastClientInternalOSGiService} instance
+     */
+    String DEFAULT_ID =
+            BuildInfoProvider.getBuildInfo().getVersion()
+            + "#"
+            + (BuildInfoProvider.getBuildInfo().isEnterprise() ? "EE" : "OSS");
+
+    /**
+     * Default group name to be used when grouping is not disabled with
+     * {@link HazelcastOSGiService#HAZELCAST_OSGI_GROUPING_DISABLED}.
+     */
+    String DEFAULT_GROUP_NAME = DEFAULT_ID;
+
+    /**
+     * Returns the state of the service about if it is active or not.
+     *
+     * @return <code>true</code> if the service is active, otherwise <code>false</code>
+     */
+    boolean isActive();
+
+    /**
+     * Activates the service.
+     */
+    void activate();
+
+    /**
+     * Deactivates the service.
+     */
+    void deactivate();
+
+}

hazelcast-dynacache-bundle/src/main/java/com/hazelcast/client/osgi/HazelcastClientOSGiService.java

@@ -0,0 +1,111 @@
+/*
+ * Copyright (c) 2008-2019, Hazelcast, Inc. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.hazelcast.client.osgi;
+
+import com.hazelcast.client.config.ClientConfig;
+import com.hazelcast.osgi.HazelcastOSGiInstance;
+import org.osgi.framework.Bundle;
+
+import java.util.Set;
+
+/**
+ * Contract point for Hazelcast services on top of OSGI.
+ */
+public interface HazelcastClientOSGiService {
+
+    /**
+     * System property for starting a default Hazelcast instance per Hazelcast OSGI bundle.
+     */
+    String HAZELCAST_OSGI_START = "hazelcast.osgi.start";
+
+    /**
+     * System property for disabling the behaviour that registers created Hazelcast instances as OSGI service.
+     */
+    String HAZELCAST_OSGI_REGISTER_DISABLED = "hazelcast.osgi.register.disabled";
+
+    /**
+     * System property for disabling the behaviour that gives different group name
+     * to each Hazelcast bundle.
+     */
+    String HAZELCAST_OSGI_GROUPING_DISABLED = "hazelcast.osgi.grouping.disabled";
+
+    /**
+     * Gets the id of service.
+     *
+     * @return the id of service
+     */
+    String getId();
+
+    /**
+     * Gets the owner {@link Bundle} of this instance.
+     *
+     * @return the owner {@link Bundle} of this instance
+     */
+    Bundle getOwnerBundle();
+
+    /**
+     * Gets the default {@link HazelcastOSGiClientInstance}.
+     *
+     * @return the default {@link HazelcastOSGiClientInstance}
+     */
+    HazelcastOSGiClientInstance getDefaultHazelcastInstance();
+
+    /**
+     * Creates a new {@link HazelcastOSGiClientInstance}
+     * on the owner bundle with specified configuration.
+     *
+     * @param config Configuration for the new {@link HazelcastOSGiClientInstance} (member)
+     * @return the new {@link HazelcastOSGiClientInstance}
+     */
+    HazelcastOSGiClientInstance newHazelcastInstance(ClientConfig config);
+
+    /**
+     * Creates a new {@link HazelcastOSGiClientInstance}
+     * on the owner bundle with default configuration.
+     *
+     * @return the new {@link HazelcastOSGiClientInstance}
+     */
+    HazelcastOSGiClientInstance newHazelcastInstance();
+
+    /**
+     * Gets an existing {@link HazelcastOSGiInstance} with its <code>instanceName</code>.
+     *
+     * @param instanceName Name of the {@link HazelcastOSGiClientInstance} (member)
+     * @return an existing {@link HazelcastOSGiClientInstance}
+     */
+    HazelcastOSGiClientInstance getHazelcastInstanceByName(String instanceName);
+
+    /**
+     * Gets all active/running {@link HazelcastOSGiClientInstance}s on the owner bundle.
+     *
+     * @return all active/running {@link HazelcastOSGiClientInstance}s on the owner bundle
+     */
+    Set<HazelcastOSGiClientInstance> getAllHazelcastInstances();
+
+    /**
+     * Shuts down the given {@link HazelcastOSGiInstance} on the owner bundle.
+     *
+     * @param instance the {@link HazelcastOSGiClientInstance} to shutdown
+     */
+    void shutdownHazelcastInstance(HazelcastOSGiClientInstance instance);
+
+    /**
+     * Shuts down all running {@link HazelcastOSGiClientInstance}s on the owner bundle.
+     */
+    void shutdownAll();
+
+}