/*
* 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.sling.testing.mock.osgi;
import java.util.Dictionary;
import java.util.Hashtable;
import java.util.Map;
import org.osgi.framework.BundleContext;
import org.osgi.framework.BundleEvent;
import org.osgi.service.component.ComponentContext;
import org.osgi.service.log.LogService;
/**
* Factory for mock OSGi objects.
*/
public final class MockOsgi {
private MockOsgi() {
// static methods only
}
/**
* @return Mocked {@link BundleContext} instance
*/
public static BundleContext newBundleContext() {
return new MockBundleContext();
}
/**
* Simulates a bundle event on the given bundle context (that is forwarded
* to registered bundle listeners).
* @param bundleContext Bundle context
* @param bundleEvent Bundle event
*/
public static void sendBundleEvent(BundleContext bundleContext, BundleEvent bundleEvent) {
((MockBundleContext) bundleContext).sendBundleEvent(bundleEvent);
}
/**
* @return Mocked {@link ComponentContext} instance
*/
public static ComponentContext newComponentContext() {
return new MockComponentContext((MockBundleContext) newBundleContext());
}
/**
* @param properties Properties
* @return Mocked {@link ComponentContext} instance
*/
public static ComponentContext newComponentContext(Dictionary<String, Object> properties) {
return newComponentContext(newBundleContext(), properties);
}
/**
* @param properties Properties
* @return Mocked {@link ComponentContext} instance
*/
public static ComponentContext newComponentContext(Map<String, Object> properties) {
return newComponentContext(toDictionary(properties));
}
/**
* @param bundleContext Bundle context
* @param properties Properties
* @return Mocked {@link ComponentContext} instance
*/
public static ComponentContext newComponentContext(BundleContext bundleContext,
Dictionary<String, Object> properties) {
return new MockComponentContext((MockBundleContext) bundleContext, properties);
}
/**
* @param bundleContext Bundle context
* @param properties Properties
* @return Mocked {@link ComponentContext} instance
*/
public static ComponentContext newComponentContext(BundleContext bundleContext, Map<String, Object> properties) {
return newComponentContext(bundleContext, toDictionary(properties));
}
/**
* @param loggerContext Context class for logging
* @return Mocked {@link LogService} instance
*/
public static LogService newLogService(final Class<?> loggerContext) {
return new MockLogService(loggerContext);
}
/**
* Simulate OSGi service dependency injection. Injects direct references and
* multiple references. If a some references could not be injected no error
* is thrown.
* @param target Service instance
* @param bundleContext Bundle context from which services are fetched to inject.
* @return true if all dependencies could be injected
*/
public static boolean injectServices(Object target, BundleContext bundleContext) {
return ReflectionServiceUtil.injectServices(target, bundleContext);
}
/**
* Simulate activation of service instance. Invokes the @Activate annotated
* method.
* @param target Service instance.
* @return true if activation method was called. False if such a method did
* not exist.
*/
public static boolean activate(Object target) {
ComponentContext componentContext = newComponentContext();
return ReflectionServiceUtil.activateDeactivate(target, componentContext, true);
}
/**
* Simulate activation of service instance. Invokes the @Activate annotated
* method.
* @param target Service instance.
* @param properties Properties
* @return true if activation method was called. False if such a method did
* not exist.
*/
public static boolean activate(Object target, Dictionary<String, Object> properties) {
ComponentContext componentContext = newComponentContext(properties);
return ReflectionServiceUtil.activateDeactivate(target, componentContext, true);
}
/**
* Simulate activation of service instance. Invokes the @Activate annotated
* method.
* @param target Service instance.
* @param properties Properties
* @return true if activation method was called. False if such a method did
* not exist.
*/
public static boolean activate(Object target, Map<String, Object> properties) {
return activate(target, toDictionary(properties));
}
/**
* Simulate activation of service instance. Invokes the @Activate annotated
* method.
* @param target Service instance.
* @param bundleContext Bundle context
* @param properties Properties
* @return true if activation method was called. False if such a method did
* not exist.
*/
public static boolean activate(Object target, BundleContext bundleContext, Dictionary<String, Object> properties) {
ComponentContext componentContext = newComponentContext(bundleContext, properties);
return ReflectionServiceUtil.activateDeactivate(target, componentContext, true);
}
/**
* Simulate activation of service instance. Invokes the @Activate annotated
* method.
* @param target Service instance.
* @param bundleContext Bundle context
* @param properties Properties
* @return true if activation method was called. False if such a method did
* not exist.
*/
public static boolean activate(Object target, BundleContext bundleContext, Map<String, Object> properties) {
return activate(target, bundleContext, toDictionary(properties));
}
/**
* Simulate deactivation of service instance. Invokes the @Activate
* annotated method.
* @param target Service instance.
* @return true if deactivation method was called. False if such a method
* did not exist.
*/
public static boolean deactivate(Object target) {
ComponentContext componentContext = newComponentContext();
return ReflectionServiceUtil.activateDeactivate(target, componentContext, false);
}
/**
* Simulate deactivation of service instance. Invokes the @Activate
* annotated method.
* @param target Service instance.
* @param properties Properties
* @return true if deactivation method was called. False if such a method
* did not exist.
*/
public static boolean deactivate(Object target, Dictionary<String, Object> properties) {
ComponentContext componentContext = newComponentContext(properties);
return ReflectionServiceUtil.activateDeactivate(target, componentContext, false);
}
/**
* Simulate deactivation of service instance. Invokes the @Activate
* annotated method.
* @param target Service instance.
* @param properties Properties
* @return true if deactivation method was called. False if such a method
* did not exist.
*/
public static boolean deactivate(Object target, Map<String, Object> properties) {
return deactivate(target, toDictionary(properties));
}
/**
* Simulate deactivation of service instance. Invokes the @Activate
* annotated method.
* @param target Service instance.
* @param bundleContext Bundle context
* @param properties Properties
* @return true if deactivation method was called. False if such a method
* did not exist.
*/
public static boolean deactivate(Object target, BundleContext bundleContext, Dictionary<String, Object> properties) {
ComponentContext componentContext = newComponentContext(bundleContext, properties);
return ReflectionServiceUtil.activateDeactivate(target, componentContext, false);
}
/**
* Simulate activation of service instance. Invokes the @Activate annotated
* method.
* @param target Service instance.
* @param bundleContext Bundle context
* @param properties Properties
* @return true if activation method was called. False if such a method did
* not exist.
*/
public static boolean deactivate(Object target, BundleContext bundleContext, Map<String, Object> properties) {
return deactivate(target, bundleContext, toDictionary(properties));
}
private static Dictionary<String, Object> toDictionary(Map<String, Object> map) {
return new Hashtable<String, Object>(map);
}
}