Packaging and Deploying a Plug-in
To make your plug-in available to
Content Studio
users, you must package it correctly in a JAR file, deploy it to the
correct folder in your
Content Engine
installation, reassemble the
Content Engine
and redeploy the studio
application that serves
Content Studio
to users.
You must package your plug-in in accordance with the standard for Java
service provider interfaces. To do this you must create a file called
com.escenic.studio.plugins.spi.StudioPluginSpi
and
add a line to the file that contains the fully-qualified name of your
new SPI class. For example:
com.mycompany.contentstudio.plugin.CustomStudioPluginSpi
You must then make sure that this file is included in the
META-INF/services
folder of the JAR file you build,
as specified in the standard for Java service provider interfaces. For
further information about this, see:
http://docs.oracle.com/javase/8/docs/technotes/guides/jar/jar.html#Service_Provider
Once you have created a correctly structured JAR file, you deploy it as follows:
-
Create a folder called
plugins
on the server in your engine-home folder (if it doe not already exist). -
Create a subfolder for your plug-in (any name you choose) under engine-home
/plugins
. -
Upload the JAR file to engine-home
/plugins/
your-plugin/studio/lib
. -
Use the assembly tool to assemble the Content Engine
-
Redeploy the
studio
application.
If you now start Content Studio, you should be able to see that your plug-in is running.