/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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 org.apache.felix.dm.test.integration.api;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.HashMap;
import java.util.Map;
import java.util.Map.Entry;
import junit.framework.Assert;
import org.apache.felix.dm.Component;
import org.apache.felix.dm.ComponentStateListener;
import org.apache.felix.dm.Dependency;
import org.apache.felix.dm.DependencyManager;
import org.apache.felix.dm.ResourceHandler;
import org.apache.felix.dm.ResourceUtil;
import org.apache.felix.dm.ServiceDependency;
import org.apache.felix.dm.test.components.Ensure;
import org.apache.felix.dm.test.integration.common.TestBase;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.ops4j.pax.exam.junit.PaxExam;
import org.osgi.framework.BundleContext;
import org.osgi.framework.Filter;
import org.osgi.framework.InvalidSyntaxException;
import org.osgi.framework.ServiceReference;
@RunWith(PaxExam.class)
public class ResourceAdapterDependencyAddAndRemoveTest extends TestBase {
@Test
public void testBasicResourceAdapter() throws Exception {
DependencyManager m = new DependencyManager(context);
// helper class that ensures certain steps get executed in sequence
Ensure e = new Ensure();
// create and add a service provider
m.add(m.createComponent()
.setInterface(ServiceInterface.class.getName(), null)
.setImplementation(new ServiceProvider(e)));
// create and add a resource provider
ResourceProvider provider = new ResourceProvider(e);
m.add(m.createComponent()
.setImplementation(provider)
.add(m.createServiceDependency()
.setService(ResourceHandler.class)
.setCallbacks("add", "remove"))
);
// create a resource adapter for our single resource
// note that we can provide an actual implementation instance here because there will be only one
// adapter, normally you'd want to specify a Class here
// also, create a callback instance which will be used for both callbacks on resource changes and
// life cycle callbacks on the adapters themselves
CallbackInstance callbackInstance = new CallbackInstance(e);
Component component = m.createResourceAdapterService("(&(path=/path/to/*.txt)(host=localhost))", false, callbackInstance, "changed")
.setImplementation(new ResourceAdapter(e))
.setCallbacks(callbackInstance, "init", "start", "stop", "destroy")
.add(m.createServiceDependency()
.setService(ServiceInterface.class)
.setRequired(true)
.setInstanceBound(true));
// add a component state listener
component.addStateListener(new ComponentStateListenerImpl(e));
// add the resource adapter
m.add(component);
// wait until the single resource is available (the adapter has been started)
e.waitForStep(1, 5000);
// trigger a 'change' in our resource
provider.change();
// wait until the changed callback is invoked
e.waitForStep(2, 5000);
// and has completed (ensuring no "extra" steps are invoked in the mean time)
e.waitForStep(3, 5000);
// remove the resource adapter again
m.remove(component);
// wait for the stopped callback in the state listener
e.waitForStep(4, 5000);
}
static class ResourceAdapter {
protected URL m_resource; // injected by reflection.
private Ensure m_ensure;
ResourceAdapter(Ensure e) {
m_ensure = e;
}
}
static class ResourceProvider {
private volatile BundleContext m_context;
private final Ensure m_ensure;
private final Map m_handlers = new HashMap();
private URL[] m_resources;
public ResourceProvider(Ensure ensure) throws MalformedURLException {
m_ensure = ensure;
m_resources = new URL[] {
new URL("file://localhost/path/to/file1.txt")
};
}
public void change() {
ResourceHandler[] handlers;
synchronized (m_handlers) {
handlers = (ResourceHandler[]) m_handlers.keySet().toArray(new ResourceHandler[m_handlers.size()]);
}
for (int i = 0; i < m_resources.length; i++) {
for (int j = 0; j < handlers.length; j++) {
ResourceHandler handler = handlers[j];
handler.changed(m_resources[i]);
}
}
}
public void add(ServiceReference ref, ResourceHandler handler) {
String filterString = (String) ref.getProperty("filter");
Filter filter = null;
if (filterString != null) {
try {
filter = m_context.createFilter(filterString);
}
catch (InvalidSyntaxException e) {
Assert.fail("Could not create filter for resource handler: " + e);
return;
}
}
synchronized (m_handlers) {
m_handlers.put(handler, filter);
}
for (int i = 0; i < m_resources.length; i++) {
if (filter == null || filter.match(ResourceUtil.createProperties(m_resources[i]))) {
handler.added(m_resources[i]);
}
}
}
public void remove(ServiceReference ref, ResourceHandler handler) {
Filter filter;
synchronized (m_handlers) {
filter = (Filter) m_handlers.remove(handler);
}
removeResources(handler, filter);
}
private void removeResources(ResourceHandler handler, Filter filter) {
for (int i = 0; i < m_resources.length; i++) {
if (filter == null || filter.match(ResourceUtil.createProperties(m_resources[i]))) {
handler.removed(m_resources[i]);
}
}
}
public void destroy() {
Entry[] handlers;
synchronized (m_handlers) {
handlers = (Entry[]) m_handlers.entrySet().toArray(new Entry[m_handlers.size()]);
}
for (int i = 0; i < handlers.length; i++) {
removeResources((ResourceHandler) handlers[i].getKey(), (Filter) handlers[i].getValue());
}
System.out.println("DESTROY..." + m_handlers.size());
}
}
static interface ServiceInterface {
public void invoke();
}
static class ServiceProvider implements ServiceInterface {
private final Ensure m_ensure;
public ServiceProvider(Ensure e) {
m_ensure = e;
}
public void invoke() {
}
}
static class CallbackInstance {
private final Ensure m_ensure;
public CallbackInstance(Ensure e) {
m_ensure = e;
}
void init() {
System.out.println("init");
}
void start() {
System.out.println("start");
m_ensure.step(1);
}
void stop() {
System.out.println("stop");
}
void destroy() {
System.out.println("destroy");
}
void changed(Component component) {
m_ensure.step(2);
Dependency oldDependency = null;
for (Object dependency : component.getDependencies()) {
if (dependency instanceof ServiceDependency) {
// remove the dependency
oldDependency = (Dependency) dependency;
}
}
// and add a new dependency
component.add(component.getDependencyManager().createServiceDependency().setService(ServiceInterface.class).setRequired(true).setInstanceBound(true));
// remove the old dependency
component.remove(oldDependency);
System.out.println("Changed the dependencies");
m_ensure.step(3);
}
}
static class ComponentStateListenerImpl implements ComponentStateListener {
private final Ensure m_ensure;
public ComponentStateListenerImpl(Ensure e) {
this.m_ensure = e;
}
public void started(Component c) {
System.out.println("started");
}
public void starting(Component c) {
System.out.println("starting");
}
public void stopped(Component c) {
System.out.println("stopped");
m_ensure.step(4);
}
public void stopping(Component c) {
System.out.println("stopping");
}
}
}