Directory API Development - Part 3 of 3

[Former Member]

1. Introduction:

   This is the 3rd part of Directory API development. The 1st part gave a high-level overview of directory API development and the pre-requisites of using the Directory API.

   In part 2, we explored the details involving the development preparation required in NWDS before actual coding can begin.

   In this blog, part 3, we will dive into the actual coding using the Directory API.

   To use as an example for this blog, I will use the Directory API to create SOAP receiver communication channels. The steps of creating other types of communication channels are similar. Primarily, the adapter type and the parameter names will need to be changed. To get the parameter names to use with the Directory API, it is recommended that a listing of an existing communication channel be done first using the "/wsnavigator".

2. Pre-Requisite of using the Directory API:

   As mentioned in part 1, to use the Directory API, the userid must be assigned specific roles. These roles must be assigned in the java server. The roles are not available using the ABAP transaction code SU01. It is critically important that step III in part 1 is carried out before proceeding with using the Directory API.

3. Development Process:

   Please note, for this blog, NWDS 7.1 is used with PI 7.1.

   Since a Communication Channel will have to be created in a Business Component or Business System, for this blog, I created two business components in the Integration Directory: BusComponent1 and BusComponent2

   Overview:

   The code development process consists of the following steps:
   1. Create new package and classes to contain our custom code. In this blog, I created the following:
      Package: com.test.commchan
      Classes: CreateSoapChannel, ChangeList and Parameters
      (The ChangeList class is used to create and activate a changelist. The Parameters class is used to store commonly used values, e.g. userid and password. I created these 2 classes, instead of including them in the CreateSoapChannel class, is for re-usability purposes, in case you decide to develop other directory API functions. You can also split these 2 classes into separate packages.)

      

   2. The Parameters class is quite simple. It containts the following code:

      The userid must be authorized with the right roles to use the Directory API.

      package com.test.commchan;<br /> public class Parameters {<br />      private static String USERID = "testuser";<br />      private static String PASSWORD = "abc123";<br /> <br />      public static String getUserid() {<br />           return USERID;<br />      }<br /> <br />      public static String getPassword() {<br />           return PASSWORD;<br />      }<br /> }<br /> <br />           

   3. The ChangeList class contains 3 methods:

      
      createChangeList: This method creates a new change list and returns its changelist id.
      activate: This method activates the changelist, using the changelist id.
      setURL: This method sets the URL on where the webservice is to be executed. By default, the webservice will executed on the server as set in the binding and endpoint of the WSDL configuration in part 2. We can change this configuration by using this method. Consequently, this code can be used to execute the webservice on any server.

      It containts the following code:
      <span>package com.test.commchan;<br /> import ChangeListServiceWsd.*;<br /> import types.api.server.ibdir.aii.sap.com.*;<br /> import types.api.server.ib.aii.sap.com.*;<br /> import java.util.Vector;<br /> import java.net.*;<br /> <br /> public class ChangeList {<br />      private static String apiURL = "/ChangeListService/HTTPBasicAuth?wsdl&style=document&mode=standard";<br />      private String url = new String();<br /> <br />      public String[] activate(String chgList) {<br />           Vector<String> vMsg = new Vector<String>();<br />           vMsg.add(new String(chgList).concat(" - Activate"));<br />           try {<br />                ChangeListService service = new ChangeListServiceLocator();<br />                ChangeListServiceVi document = null;<br />                // check for server to execute the webservice<br />                if (this.url.length() == 0)<br />                     document = service.getHTTPBasicAuthPort();<br />                else {<br />                     URL docUrl = new URL(this.url);<br />                     document = service.getHTTPBasicAuthPort(docUrl);<br />                }<br />                HTTPBasicAuthBindingStub stub = (HTTPBasicAuthBindingStub)document;<br />                stub.setUsername(Parameters.getUserid());<br />                stub.setPassword(Parameters.getPassword());<br />                LogMessageCollection cLogMsg = document.activate(chgList);<br />                LogMessageCommunicationChannel[] logMsg = cLogMsg.getLogMessageCommunicationChannel();<br />                if (logMsg != null && logMsg.length > 0) {<br />                     for (int i=0; i<logMsg.length; i++) {<br />                          LogMessageItem msgItem = logMsg[i].getLogMessageItem();<br />                          Text msgTxt = msgItem.getMessage();<br />                          vMsg.add(msgTxt.getValue());<br />                          System.out.println(" msg: " + msgTxt.getValue());<br />                     }<br />                }<br />                cLogMsg = document.revert(chgList);<br />           }<br />           catch (Exception e) {<br />                vMsg.add(e.getMessage());<br />                e.printStackTrace();<br />           }<br />           return (String[])vMsg.toArray((String[])new String[1]);<br />      }<br /> <br />      public void setURL(String serverPort) {<br />           if (serverPort == null) return;<br />           this.url = this.url.concat("</span><a class="jive-link-external-small" href="http://">http://</a><span>").concat(serverPort).concat(apiURL);<br />      }<br /> <br />      public String createChangeList(String name) {<br />           Vector<String> vMsg = new Vector<String>();<br />           String changeListID = "";<br />           String changeListName = "";<br />           try {<br />                ChangeListService service = new ChangeListServiceLocator();<br />                ChangeListServiceVi document = null;<br />                if (this.url.length() == 0)<br />                     document = service.getHTTPBasicAuthPort();<br />                else {<br />                     URL docUrl = new URL(this.url);<br />                     document = service.getHTTPBasicAuthPort(docUrl);<br />                }<br />                HTTPBasicAuthBindingStub stub = (HTTPBasicAuthBindingStub)document;<br />                stub.setUsername(Parameters.getUserid());<br />                stub.setPassword(Parameters.getPassword());<br />                ChangeListIDRestricted changeListCreateRequest = new ChangeListIDRestricted();<br />                LONG_Description description = new LONG_Description();<br />                description.setLanguageCode("EN");<br />                description.setValue(name);<br />                changeListCreateRequest.setDescription(description);<br />                changeListCreateRequest.setName(name);<br />                ChangeListCreateOut changeListCreateOut = document.create(changeListCreateRequest);<br />                ChangeListID changeList = changeListCreateOut.getChangeListID();<br />                changeListID = changeList.getChangeListID();<br />                changeListName = changeList.getName();<br />                vMsg.add(new String(changeListID).concat("(").concat(changeListName).concat(")").concat(" - Create ChangeList"));<br />           }<br />           catch (Exception e) {<br />                vMsg.add(e.getMessage());<br />                e.printStackTrace();<br />           }<br />           return changeListID;<br />      }<br /> <br />      public static void main(String[] args) {<br />           ChangeList changeList = new ChangeList();<br />           changeList.setURL("nspah227:52700");<br />           String name = "ChangeList Demo";<br />           String changeID = changeList.createChangeList(name);<br />                System.out.println(changeID);<br />           System.out.println("Done");<br />      }<br /> }<br /> <br />                          </span>

   4. The CreateSoapChannel contains the following methods:

      createSoapChannelActivate: This method is the main method to create and actiate the SOAP communication channel configurations.
      createChangeList: This method creates a changelist containing the SOAP communication channel configurations.
      createSoapChan: This method creates all the SOAP communication channel configurations. build1SoapChan: This method creates one SOAP communication channel configuration.
      setURL: This method sets the URL on where the webservice is to be executed. It serves the same purpose as in the ChangeList class.
      setActivate: This method sets the flag on whether the configuration is to be activated. I included this option on whether to activate the changelist. If this is set to "false", then we can see the changelist list in the "Change List" tab of the Integration Directory. At that point, we can manually activate it or reject it. If set to "true", then the configuration will be activated by the program.

      The class containts the following code:
      <span>package com.test.commchan;<br /> import types.api.server.ibdir.aii.sap.com.*;<br /> import CommunicationChannelServiceWsd.*;<br /> import types.api.server.ib.aii.sap.com.*;<br /> <br /> import java.net.URL;<br /> import java.util.Vector;<br /> <br /> public class CreateSoapChannel {<br />      private static String apiURL = "/CommunicationChannelService/HTTPBasicAuth?wsdl&style=document&mode=standard";<br />      private String url = new String();<br />      private String serverPort = null;<br />      private boolean bActivate = true;<br />      private String docChangeID = null;<br /> <br />      public CreateSoapChannel() {}<br /> <br />      public CreateSoapChannel(String changeID) {<br />           this.docChangeID = changeID;<br />           this.setActivate(false);<br />      }<br /> <br />      public String[] createSoapChannelActivate(String[] party, String[] component, String[] channel, String[] url, String[] action) {<br />           Vector<String> vMsg = new Vector<String>();<br />           CommunicationChannelRestricted[] chans = this.createSoapChan(party, component, channel, url, action);<br />           String[] msg = this.createChangeList(chans);<br />           for (int i=0; i<msg.length; i++) vMsg.add(msg[i]);<br />           if (bActivate) {<br />                ChangeList act = new ChangeList();<br />                act.setURL(serverPort);<br />                String changeID = (String)vMsg.get(0).substring(0, 36);<br />                String[] msgs = act.activate(changeID);<br />                for (int i=0; i<msgs.length; i++) vMsg.add(msgs[i]);<br />           }<br />           return (String[])vMsg.toArray((String[])new String[1]);<br />      }<br /> <br />      public String[] createChangeList (CommunicationChannelRestricted[] chans) {<br />           String changeID = null;<br />           Vector<String> vMsg = new Vector<String>();<br />           try {<br />                CommunicationChannelCreateChangeIn crtChan = new CommunicationChannelCreateChangeIn();<br />                crtChan.setCommunicationChannel(chans);<br /> <br />                // Changelist<br />                if (this.docChangeID != null) crtChan.setChangeListID(this.docChangeID);<br /> <br />                HTTPService service = new HTTPServiceLocator();<br />                CommunicationChannelServiceVi_Document document = null;<br />                if (url.length() == 0)<br />                     document = service.getHTTPPort();<br />                else {<br />                     URL docUrl = new URL(url);<br />                     document = service.getHTTPPort(docUrl);<br /> <br />                }<br /> <br />                // Provide authorized userid<br />                HTTPBindingStub stub = (HTTPBindingStub)document;<br />                stub.setUsername(Parameters.getUserid());<br />                stub.setPassword(Parameters.getPassword());<br /> <br />                // Execute request<br />                ConfigurationObjectModifyOut resp = document.create(crtChan);<br />                ChangeListID chgID = resp.getChangeListID();<br />                changeID = chgID.getChangeListID();<br />                vMsg.add(new String(changeID).concat(" - Create Comm Chan"));<br />                LogMessageCollection cLogMsg = resp.getLogMessageCollection();<br />                LogMessageCommunicationChannel[] logMsg = cLogMsg.getLogMessageCommunicationChannel();<br />                if (logMsg != null && logMsg.length > 0) {<br />                     for (int i=0; i<logMsg.length; i++) {<br />                          LogMessageItem msgItem = logMsg[i].getLogMessageItem();<br />                          Text msgTxt = msgItem.getMessage();<br />                          vMsg.add(msgTxt.getValue());<br />                     }<br />                }<br />           }<br />           catch (Exception ex){<br />                vMsg.add(ex.getMessage());<br />                ex.printStackTrace();<br />           }<br />           return (String[])vMsg.toArray((String[])new String[1]);<br />      }<br /> <br />      public CommunicationChannelRestricted[] createSoapChan(String[] party, String[] component, String[] channel, String[] url, String[] action) {<br />           Vector<CommunicationChannelRestricted> vChan = new Vector<CommunicationChannelRestricted>();<br />           for (int i=0; i<channel.length; i++) {<br />                CommunicationChannelRestricted commChan = this.build1SoapChan(party[i], component[i], channel[i], url[i], action[i]);<br />                vChan.add(commChan);<br />           }<br />           CommunicationChannelRestricted[] chans = (CommunicationChannelRestricted[])vChan.toArray(new CommunicationChannelRestricted[1]);<br />           return chans;<br />      }<br /> <br />      private CommunicationChannelRestricted build1SoapChan(String party, String component, String channel, String url, String action) {<br />           CommunicationChannelRestricted commChan = new CommunicationChannelRestricted();<br />           try {<br /> <br />                commChan.setMasterLanguage("EN");<br /> <br />                // Communication Channel ID info<br />                CommunicationChannelID commID = new CommunicationChannelID();<br />                commID.setChannelID(channel);<br />                commID.setComponentID(component);<br />                commID.setPartyID(party);<br />                commChan.setCommunicationChannelID(commID);<br /> <br />                // Adapter Type<br />                DesignObjectID adapter = new DesignObjectID();<br />                adapter.setName("SOAP");<br />                adapter.setNamespace("</span><a class="jive-link-external-small" href="http://sap.com/xi/XI/System">http://sap.com/xi/XI/System</a><span>");<br />                adapter.setSoftwareComponentVersionID("1879eed0-7b4e-11d9-87c6-c81c0a114c15");<br />                commChan.setAdapterMetadata(adapter);<br /> <br />                // Adapter Configuration<br />                commChan.setDirection("Receiver");<br />                commChan.setTransportProtocol("HTTP");<br />                commChan.setTransportProtocolVersion("");<br />                commChan.setMessageProtocol("SOAP");<br />                commChan.setMessageProtocolVersion("");<br /> <br />                // Adapter Properties<br />                Vector<GenericProperty> vProp = new Vector<GenericProperty>();<br />                GenericProperty prop = new GenericProperty("XMBWS.TargetURL", url);<br />                vProp.add(prop);<br />                prop = new GenericProperty("XMBWS.DefaultSOAPAction", action);<br />                vProp.add(prop);<br />                prop = new GenericProperty("useAuth", "1");<br />                vProp.add(prop);<br />                prop = new GenericProperty("XMBWS.User", Parameters.getUserid());<br />                vProp.add(prop);<br />                prop = new GenericProperty("XMBWS.Password", Parameters.getPassword());<br />                vProp.add(prop);<br />                GenericProperty[] props = (GenericProperty[])vProp.toArray(new GenericProperty[1]);<br />                commChan.setAdapterSpecificAttribute(props);<br />           }<br />           catch (Exception ex){<br />                ex.printStackTrace();<br />           }<br />           return commChan;<br />      }<br /> <br />      public void setURL(String serverPort) {<br />           if (serverPort == null) return;<br />           this.serverPort = serverPort;<br />           this.url = this.url.concat("</span><a class="jive-link-external-small" href="http://">http://</a><span>").concat(serverPort).concat(apiURL);<br />      }<br /> <br />      public void setActivate(boolean yesno) {<br />           this.bActivate = yesno;<br />      }<br /> <br />      public static void main(String[] args) {<br />           String[] recParty = new String[]{"*", "*"};<br />           String[] recComponent = new String[]{"BusComponent1","BusComponent2"};<br />           String[] url = new String[]{"</span><a class="jive-link-external-small" href="http://webservice1">http://webservice1</a><span>","</span><a class="jive-link-external-small" href="http://webservice2">http://webservice2</a><span>"};<br />           String[] action = new String[]{"</span><a class="jive-link-external-small" href="http://action1">http://action1</a><span>","</span><a class="jive-link-external-small" href="http://action2">http://action2</a><span>"};<br />           String[] recChannel = new String[]{"SOAP_1_receiver","SOAP_2_receiver"};<br /> <br />           String serverPort = "nspah227:52700";<br /> <br />           ChangeList chg = new ChangeList();<br />           chg.setURL(serverPort);<br />           String chgID = chg.createChangeList("My Test Blog ChangeList");<br /> <br />           CreateSoapChannel test = new CreateSoapChannel(chgID);<br />           test.setActivate(false);<br />           test.setURL(serverPort);<br />           String[] msg = test.createSoapChannelActivate(recParty, recComponent, recChannel, url, action);<br />           for (int i=0; i<msg.length; i++) {<br />                System.out.println(msg[i]);<br />           }<br /> <br />           System.out.println("Done");<br />      }<br /> <br /> }<br />                          </span>

   5. Please note in the "main" method, the data used to create the communication channel are set into arrays. This should be self-explanatory.
   6. When we execute the CreateSoapChannel, with "setActivate(false)": <span>     public static void main(String[] args) {<br />           String[] recParty = new String[]{"*", "*"};<br />           String[] recComponent = new String[]{"BusComponent1","BusComponent2"};<br />           String[] url = new String[]{"</span><a class="jive-link-external-small" href="http://webservice1">http://webservice1</a><span>","</span><a class="jive-link-external-small" href="http://webservice2">http://webservice2</a><span>"};<br />           String[] action = new String[]{"</span><a class="jive-link-external-small" href="http://action1">http://action1</a><span>","</span><a class="jive-link-external-small" href="http://action2">http://action2</a><span>"};<br />           String[] recChannel = new String[]{"SOAP_1_receiver","SOAP_2_receiver"};<br /> <br />           String serverPort = "nspah227:52700";<br /> <br />           ChangeList chg = new ChangeList();<br />           chg.setURL(serverPort);<br />           String chgID = chg.createChangeList("My Test Blog ChangeList");<br /> <br />           CreateSoapChannel test = new CreateSoapChannel(chgID);<br />           test.setActivate(false);<br />           test.setURL(serverPort);<br />           String[] msg = test.createSoapChannelActivate(recParty, recComponent, recChannel, url, action);<br />           for (int i=0; i<msg.length; i++) {<br />                System.out.println(msg[i]);<br />           }<br /> <br />           System.out.println("Done");<br />      }<br />           </span>

      We will see in the Integration Directory the changelist: (make sure you log on using the same userid as the one used in the Directory API program...you may also need to refresh the screen)
      
      and
      

      If we used "setActivate(true)", then there will be no changelist shown and the configuration would have been activated automatically.