A DTK plugin is created and committed by following these steps:

1. For agent plugins, create a Configuration Contract, see 15. Configuration Contract for further information about the contents of the configuration contract. For other types of plugins, skip this step.
    

2. For agent plugins, generate a Java file from your configuration contract:

   > java -classpath $CLASSPATH com.digitalroute.devkit.tools.ContractGen \
   -d . -f MyAgentConfigContract.xml

   For other types of plugins, skip this step.
    

3. Create the different Java files required for the type of plugin you want to create. See the chapters describing each plugin for further information.
    

4. Compile all the Java files for your plugin into classes:

   > javac -classpath $CLASSPATH com/mycompany/myagent/*.java

   Note!

   It is strongly recommended that the Java code does not use the default package context. All classes in  must have unique names.

5. Create a user defined *.jar file containing the classes, see the section below, Creating a User Defined Jar File.
    
6. Create a user defined *.mzp package containing the *.jar file, see the section below, Creating a User Defined Package.
    
7. Commit your user defined package, see the section below, Committing a User Defined Package.
    
8. If you want to have user documentation for your agent plugin, create the documentation, wrap it into a user defined package and commit the package. See 16. Documentation for Agent Plugins for information about how to create and implement the help content.

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>]

[ -osgi <true/false> ]

> 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>]

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>]

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 On-Premise, Non-Containerized environment:

New or updated code is inserted into the system using the mzsh Command Line Tool:

> mzsh username/password pcommit my_agent.mzp

For Containerized Environment (AWS or private container):

Before committing any user defined packages, your containerized environment needs to have been configured so that the /opt/mz/codeserver-dtk folder is mounted to a persistent storage.

An example configuration for this is provided. Look for the lines "# uncomment in order to load development toolkits from persistent storage" in the following config files:

• mzhome-pvc.yaml
• platform-statefulset.yaml

Example of configs can be download from /wiki/spaces/BUG/pages/4001988.

This is a one time configuration. Once done, any user defined package can be committed as per the instructions below.

Transfer the file to the kubernetes container and restart the pod.

> kubectl cp my_agent.mzp delivery/platform-0:/opt/mz/codeserver-dtk/packages/active
> kubectl delete pod platform-0