{"type":"doc","content":[{"type":"paragraph","content":[{"text":"To ","type":"text"},{"text":"package, present,","type":"text","marks":[{"type":"strong"}]},{"text":" and ","type":"text"},{"text":"deploy","type":"text","marks":[{"type":"strong"}]},{"text":" your plugin, see these instructions:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Plugin Packaging:","type":"text","marks":[{"type":"link","attrs":{"__confluenceMetadata":{"isRenamedTitle":true,"linkType":"self"},"href":"/wiki/spaces/DOCS/pages/480346680"}}]},{"text":" packaging in a JAR","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Plugin Presentation:","type":"text","marks":[{"type":"link","attrs":{"__confluenceMetadata":{"isRenamedTitle":true,"linkType":"page","contentTitle":"Plugin Presentation","versionAtSave":"15"},"href":"/wiki/spaces/DOCS/pages/480379311"}}]},{"text":" controlling how your plugin appears in the Pipeline Studio","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"If you are installing a ","type":"text"},{"text":"third-party JAR","type":"text","marks":[{"type":"strong"}]},{"text":" (such as a ","type":"text"},{"text":"JDBC driver","type":"text","marks":[{"type":"strong"}]},{"text":") to make it accessible to other plugins or applications, see ","type":"text"},{"text":"these instructions","type":"text","marks":[{"type":"link","attrs":{"__confluenceMetadata":{"isRenamedTitle":true,"linkType":"page","contentTitle":"Plugin Management","versionAtSave":"16"},"href":"/wiki/spaces/DOCS/pages/477561299"}}]},{"text":".","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Plugin Dependencies","type":"text"}]},{"type":"paragraph","content":[{"text":"Plugins need to be packaged together with any dependencies that are not provided by the system. The system provides CDAP dependencies, some core Hadoop dependencies, and some core Spark dependencies.","type":"text"}]},{"type":"paragraph","content":[{"text":"Any CDAP dependency with ","type":"text"},{"text":"api","type":"text","marks":[{"type":"code"}]},{"text":" in the name does not need to be packaged and should be set to the ","type":"text"},{"text":"provided","type":"text","marks":[{"type":"em"}]},{"text":" scope in your pom. For example, the ","type":"text"},{"text":"cdap-api","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"cdap-api-spark2_2.11","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"cdap-etl-api","type":"text","marks":[{"type":"code"}]},{"text":", and ","type":"text"},{"text":"cdap-etl-api-spark","type":"text","marks":[{"type":"code"}]},{"text":" dependencies should be set to the ","type":"text"},{"text":"provided","type":"text","marks":[{"type":"em"}]},{"text":" scope.","type":"text"}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"hadoop-common","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"hadoop-mapreduce-client-core","type":"text","marks":[{"type":"code"}]},{"text":" dependencies should be set to the ","type":"text"},{"text":"provided ","type":"text","marks":[{"type":"em"}]},{"text":"scope.","type":"text"}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"spark-core","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"spark-streaming","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"spark-repl","type":"text","marks":[{"type":"code"}]},{"text":", and ","type":"text"},{"text":"spark-mllib","type":"text","marks":[{"type":"code"}]},{"text":" dependencies should be set to the ","type":"text"},{"text":"provided ","type":"text","marks":[{"type":"em"}]},{"text":"scope.","type":"text"}]},{"type":"paragraph","content":[{"text":"Any other dependencies in your project should be a compile dependency, meaning they will get packaged in the plugin jar.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Plugin ","type":"text"},{"text":"Packaging","type":"text","marks":[{"type":"annotation","attrs":{"annotationType":"inlineComment","id":"ce884f2f-d6f2-4249-a564-ebb287b124f1"}}]}]},{"type":"paragraph","content":[{"text":"A ","type":"text"},{"text":"Plugin","type":"text","marks":[{"type":"em"}]},{"text":" is packaged as a JAR file, which contains the plugin classes and their dependencies. CDAP uses the \"Export-Package\" attribute in the JAR file manifest to determine which classes are ","type":"text"},{"text":"visible","type":"text","marks":[{"type":"em"}]},{"text":". A ","type":"text"},{"text":"visible","type":"text","marks":[{"type":"em"}]},{"text":" class is one that can be used by another class that is not from the plugin JAR itself. This means the Java package which the plugin class is in must be listed in \"Export-Package\", otherwise the plugin class will not be visible, and hence no one will be able to use it. This can be done in Maven by editing your pom.xml. For example, if your plugins are in the ","type":"text"},{"text":"com.example.runnable","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"com.example.callable","type":"text","marks":[{"type":"code"}]},{"text":" packages, you would edit the bundler plugin in your pom.xml:","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n org.apache.felix\n maven-bundle-plugin\n 2.3.7\n true\n \n \n *;inline=false;scope=compile\n true\n lib\n com.example.runnable;com.example.callable\n \n \n ...\n\n","type":"text"}]},{"type":"paragraph","content":[{"text":"If you are developing plugins for the ","type":"text"},{"text":"cdap-data-pipeline","type":"text","marks":[{"type":"code"}]},{"text":" artifact, be aware that for classes inside the plugin JAR that you have added to the Hadoop Job configuration directly (for example, your custom ","type":"text"},{"text":"InputFormat","type":"text","marks":[{"type":"code"}]},{"text":" class), you will need to add the Java packages of those classes to the \"Export-Package\" as well. This is to ensure those classes are visible to the Hadoop MapReduce framework during the plugin execution. Otherwise, the execution will typically fail with a ","type":"text"},{"text":"ClassNotFoundException","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}],"version":1}

Browser not supported