Creating a DTK Plugin
To create and commit a DTK plugin:
- Create the different Java files required for the type of plugin you want to create. See the chapters describing each plugin for further information.
Compile all the Java files for your plugin into classes:
> javac -classpath $CLASSPATH com/mycompany/myagent/*.java
Note!
Do not use the default package context in the Java code. All classes in
must have unique names.- Create a user defined *.jar file containing the classes, see the section below, Creating a User Defined Jar File.
- Create a user defined *.mzp package containing the *.jar file, see the section below, Creating a User Defined Package.
- Commit your user defined package, see the section below, Committing a User Defined Package.
Creating a User Defined Jar
To create a *.jar file containing the classes, use the following command syntax:
> jar cvf my_agent.jar com/mycompany/myagent/*.class
It is also possible to add resources to a jar file, just append any resource name to your "jar create" command. This allows you to, for instance, add images that your class depends on to the jar:
> jar cvf my_agent.jar com/mycompany/myagent/*.class com/mycompany/myagent/myagent_icon.svg
Creating a User Defined Package
In order to insert the *.jar file into , a package containing the jar file must first be created. A package gives the *.jar file a name and a version. The mzsh pcreate command creates a code package used for composing packages (.mzp) in order to create additional functionality and updates. The name and version will be visible in the About window once the new package has been committed into the system.
A package is created using the pcreate command in the mzsh Command Line Tool:
usage: pcreate <name> <version> <package-file> [-level <default level>] [-revision <revision> ] [-repository <repository> ] [-hidden] [[-level <level name>] file=<file-to-include> ... ] [-osgi <true/false>] [-exported <export-version> file=<jar file>] For Private Cloud, AWS or when you do not have a local installation, do: java -jar $DEVKIT_JAR pcreate ...
| Argument | Description |
|---|---|
| The name of the package |
| The version string of the package |
| The resulting package file name |
| Specifies if this software should support update to a running system. The default level can either be Note! Not all kinds of software using the development toolkit can be updated and also that a third party library being used by the software may or may not support the execution level. |
| Used to show the revision number from which the |
| Used to show the repository from which the |
| Used if the |
| The level name can either be platform or execution. Each filename to be included can optionally be preceded by a level. |
[ -osgi <true/false> ] | Used to indicate if the Exporting 3PP Packages It is advisable to use a Java wrapper as a proxy for exporting the packages used by your custom mzp. Example - Using osgi and exportpackages > mzsh username/password pcreate \ "My Agent" 1.0 my_agent.mzp -level execution \ file=my_agent.jar -level execution file=my_agent_javahelp.jar -osgi true \ -exportpackages com.digitalroute.devkit.mylib.javawrapper |
[ -exportpackages <Java wrapper>] | A mandatory option when osgi is set to true. This option is used to export the Java wrapper for use by the DTK plugin. Library Package Naming Conventions To ensure that the library files not come into conflict with other library packages, our recommended suggestion is to apply a prefix to the filename of your package. Example - Usage of exportpackages A Java wrapper is used to call the actual third party library packages used by the mzp. The example below shows how a Java wrapper can be used. package com.digitalroute.devkit.examples.logger;
import org.apache.logging.log4j.Level;
import org.apache.logging.log4j.LogManager;
import org.apache.log4j.Logger;
import org.apache.logging.log4j.core.LoggerContext;
public class LoggerWrapper{
final static Logger logger = Logger.getLogger(LoggerWrapper.class);
public void logMessageFatal(String message){
LoggerContext context = (LoggerContext) LogManager.getContext(false);
logger.fatal(message);
}
}
|
[ -exported <export-version> file=<jar file>] | This option is used to export all Java packages that comes bundled in a third party library package. This option is especially useful when there are multiple large third party library packages that contains large quantities of packages embedded within them. Example - Usage of exported Here is an example on how the option can be used. The example shows how multiple hadoop libraries can be exported. FILES="-exported 3.1.0 file=hadoop-auth-3.1.0.jar -exported 3.1.0 file=hadoop-common-3.1.0.jar -exported 3.1.0 file=hadoop-hdfs-3.1.0.jar -exported 3.1.0 file=hadoop-aws-3.1.0.jar -exported 3.1.0 file=hadoop-annotations-3.1.0.jar" mzsh pcreate "Apache Hadoop" "8.1.2.0" apache_hadoop_cdh4.mzp -level platform -osgi true $FILES |
Committing a User Defined Package
For Bare Metal installations: 1. sftp mzp to test server 2. Login on the test server 3. $ mzsh user/pw pcommit my_agent.mzp
Note!
The name (My Agent from the example above, Creating a User Defined Package) is the package key. Thus, if a new package with the same name is inserted, then the old code for that package name is replaced.