Setting up - 4.4

Owned by Maciej Majchrzak
Last updated: May 12, 2017
1 min read

To use Slice in your project, you have to perform a simple setup.

Maven configuration

Dependencies

Include the following Maven dependencies into your project:

<dependency>
    <groupId>com.cognifide.slice</groupId>
    <artifactId>slice-core-api</artifactId>
    <version>4.4.0</version>
</dependency>
<dependency>
    <groupId>com.cognifide.slice</groupId>
    <artifactId>slice-core</artifactId>
    <version>4.4.0</version>
</dependency>
<dependency>
    <groupId>com.cognifide.slice</groupId>
    <artifactId>slice-mapper</artifactId>
    <version>4.4.0</version>
</dependency>
<dependency>
    <groupId>com.cognifide.slice</groupId>
    <artifactId>slice-mapper-api</artifactId>
    <version>4.4.0</version>
</dependency>

Depending on your project you might want to set the scope of the dependencies to provided.

Repositories

Slice is deployed to Maven central repository which means you don't have to specify any repositories to fetch id. However, you might want to add the following repositories to fetch CQ dependencies or other OSGi bundles.

<repositories>
    <repository>
        <id>adobe-public-releases</id>
        <name>Adobe Public Repository</name>
        <url>http://repo.adobe.com/nexus/content/groups/public</url>
        <releases>
            <enabled>true</enabled>
            <updatePolicy>never</updatePolicy>
        </releases>
        <snapshots>
            <enabled>false</enabled>
        </snapshots>
    </repository>
    <repository>
        <id>com.springsource.repository.bundles.external</id>
        <name>SpringSource Enterprise Bundle Repository - SpringSource Bundle Releases</name>
        <url>http://repository.springsource.com/maven/bundles/external/</url>
    </repository>
</repositories>

Prepare activator

In order Slice to work, you have to write and set up activator of your application. The activator will be responsible for creating and storing injector of your application.

Sample activator

Below code presents how an activator of your application should look like:

package com.cognifide.app.core;

import java.util.ArrayList;
import java.util.List;

import org.osgi.framework.BundleActivator;
import org.osgi.framework.BundleContext;

import com.cognifide.slice.api.injector.InjectorRunner;
import com.cognifide.slice.commons.SliceModulesFactory;
import com.cognifide.slice.cq.module.CQModulesFactory;

import com.google.inject.Module;

public class Activator implements BundleActivator {

	public static final String INJECTOR_NAME = "app";

	private static final String BUNDLE_NAME_FILTER = "app-.*";

	private static final String BASE_PACKAGE = "com.cognifide.app";

	@Override
	public void start(final BundleContext bundleContext) {

		final InjectorRunner injectorRunner = new InjectorRunner(bundleContext, INJECTOR_NAME,
				BUNDLE_NAME_FILTER, BASE_PACKAGE);

		final List<Module> sliceModules = SliceModulesFactory.createModules(bundleContext);
		// CQModulesFactory is a class coming from Slice Addons https://cognifide.atlassian.net/wiki/display/SLICE/Slice+CQ+Addons+-+4.1
		final List<Module> cqModules = CQModulesFactory.createModules();
		final List<Module> customModules = createCustomModules();

		injectorRunner.installModules(sliceModules);
		injectorRunner.installModules(cqModules);
		injectorRunner.installModules(customModules);

		injectorRunner.start();
	}
    private List<Module> createCustomModules() {
        List<Module> applicationModules = new ArrayList<Module>();
        //populate the list with your modules
        return applicationModules;
    }
}

 

You have to change the following things to adjust to your application:

  • INJECTOR_NAME value
  • BUNDLE_NAME_FILTER value
  • BASE_PACKAGE value
  • populate a list of your application modules

What's going on here?

Here's what's happening in start method:

  1. InjectorRunner is created. It's a helper which allows you to add modules, creates injector and register it in injector repository. It needs INJECTOR_NAME to register injector under this String. Please read more about injectors repository to get to know how does it work and what name to choose. Other arguments:
    • BUNDLE_NAME_FILTER - the pattern that defines which bundles to scan in order to find classes annotated by @SliceResource annotation. Only bundles which symbolic names matches the pattern are scanned.
    • BASE_PACKAGE - the base package that defines which packages inside bundles specified above to scan in order to find classes annotated by @SliceResource annotation.List of Slice modules is created.
  2. Slice and AEM/CQ modules are created. If you don't use AEM add-on you don't need to install these modules.
  3. List of your modules is created. You should instantiate all the custom modules of your application in the createCustomModules method.
  4. All the modules are installed
  5. InjectorRunner is started which means that it creates the Guice injector, install all the provided modules and registered the injector in the injector repository under the specified name.

Register your activator

Don't forget about registering your activator by putting it in the maven-bundle-plugin configuration:

<plugin>
	<groupId>org.apache.felix</groupId>
	<artifactId>maven-bundle-plugin</artifactId>
	<extensions>true</extensions>
	<configuration>
		<instructions>
			<Export-Package>com.cognifide.app.core*;version="${project.version}"</Export-Package>
			<Bundle-Activator>com.cognifide.app.core.Activator</Bundle-Activator>
			<Bundle-SymbolicName>app-core</Bundle-SymbolicName>
		</instructions>
	</configuration>
</plugin>