This chapter provides you information on how to access the Java Interface.

Use Java 11 version to run the API client.

To access the Java interface, download/get the J2EE folder from the server. This folder is located at the following location:

[ProductDirectory]/ncmcore/webapps/ncm-webapp/samples/J2EE in the deploy folder of your NCM installation.

The following table lists the jar files that must be in your client’s CLASSPATH for your Java client application to work properly. As a convenience, all the required jar files, and a sample build file in the samples directory have been included.

Filename

Location

activation-1.1.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

activemq-client-5.16.4.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

activemq-broker-5.16.4.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

activemq-kahadb-store-5.16.4.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

activemq-protobuf-1.1.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

activemq-openwire-legacy-5.16.4.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

ant-1.5.1.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

antlr-2.7.6.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

aopalliance-1.0.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

axis-1.3.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

axis-ant-1.3.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

axis-jaxrpc-1.3.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

axis-saaj-1.3.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

axis-wsdl4j-1.5.1.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

backport-util-concurrent-3.1.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

bc-fips-1.0.2.2.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

castor-1.1.2.1.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

cglib-nodep-2.2.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

common-10.1.13.0.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

commons-beanutils-1.9.4.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

commons-codec-1.6.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

commons-collections-3.2.2.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

commons-digester-1.3.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

commons-discovery-0.5.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

commons-lang-2.4.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

commons-logging-1.0.4.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

core-10.1.13.0.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

cryptix32-1.0.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

cryptoj-6.0.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

dnsjava-1.5.0.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

dom4j-2.1.3.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

ehcache-3.8.0.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

hibernate-core-5.3.10-Final.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

hibernate-ehcache-5.3.10-Final.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

hsqldb-1.6.1.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

httpclient-4.2.3.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

httpcore-4.2.3.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

icu4j-2.6.1.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

jasperreports-6.20.6.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

javassist-3.15.0-GA.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

jaxen-1.1.1.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

jaxrpc-api-1.1.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

jdom-1.0.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

jradius-client-1.0.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

jsr107cache-1.0.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

jta-1.1.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

log4j-2.17.1.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

javax.mail-1.6.2.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

org-netbeans-bootstrap-RELEASE701.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

org-openide-modules-RELEASE701.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

org-openide-util-lookup-RELEASE111.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

org-openide-util-RELEASE111.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

oro-2.0.8.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

OvLic-1.0.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

poi-2.0-final-20040126.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

postgresql-42.2.8.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

publicApi-10.1.13.0.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

security-10.1.13.0.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

services-10.1.13.0.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

slf4j-api-1.7.32.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

spring-aop-5.3.28.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

spring-beans-5.3.28.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

spring-context-5.3.28.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

spring-context-support-5.3.28.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

spring-core-5.3.28.jar

<VOYENCE_HOME>/ncmcore/webapps/ncm-webapp/WEB-INF/lib

Note: This document has been written from the perspective of using the Web Services Interface. As this section indicates, there is also a J2EE interface that can be used.

The examples in this guide are using Java derived from the Web Services Interface. The VMware Smart Assurance Network Configuration Manager Application Program Interface (API) Javadoc Reference Guide, however, has been generated from the J2EE interface. The functions in the J2EE interface and Web Services Interface are the same.

Occasionally, some parameters have been changed. Usually, it is a collection being expressed as an array. The most notable example is that of the parameter order of the ResourceIdentityInfo.