Using the Web Service in Java

Using the Web Service with Java (NetBeans 6.x)

The web service client application we will write will cover all the operations of EDIXMLOnline you need to generate and translate an EDI file. This tutorial used a daily build of Sun Netbeans 6 and Java SDK 6 update 3, for Windows.

After installing the Java SDK and Netbeans be sure to copy the jar files under C:\Program Files\NetBeans 6.0 XXX\java1\modules\ext\jaxws21\api to an "Endorsed" folder under the "Lib" folder in both the JRE and SDK folders.

Let's begin.

Save a local copy of the generated WSDL file.

Create a new Java Application project. Call it JavaClientDemo.

Add the JAX-WS 2.1 library.
Add the Swing Application Framework library

Add a web service client using the saved WSDL.

This step of adding a web reference is to generate and include the .NET class that represents the 850 SEF file which is defined by an Xml schema, that is embedded in the WSDL. The proxy functions defined in the WSDL are not to be called as they do nothing.

Add another web service client to the EDIXMLOnline web service.

This step of adding a web reference is to generate and include the proxy class of the actual web service that will generate and translate EDI files.

Your projects pane should be similar to

Add a JFrame form, call it MainForm. Layout controls on the form to make it look like. The SEF ID should be the id created for the SEF file you uploaded and wish to use in your application. And for this example it was one that was created under the "demo" user and happens to be b5c0771a-ace2-436c-bb9e-e8ff98b2b042 .

Add the code to the application main constructor to create and display an instance of the form.

        
        public static void main(String[] args) 
        {
            // Instantiate and display form
            MainForm mainForm = new MainForm();
            mainForm.setVisible(true);
        }

Add a class, call it "DefaultNamespacePrefixMapper". The source file should look like


    package javaclientdemo;

    import javax.xml.bind.*;
    import java.io.*;
    import com.sun.xml.bind.marshaller.*;

    public class DefaultNamespacePrefixMapper extends com.sun.xml.bind.marshaller.NamespacePrefixMapper {   

        public final String getPreferredPrefix(String namespaceUri, String suggestion, boolean requirePrefix)
            {

	        String result = suggestion;

	        if (namespaceUri.equalsIgnoreCase("http://www.edixmlonline.com")) 
                    {
		        result = "edvt";
	        }

                    else if (namespaceUri.equalsIgnoreCase("http://tempuri.org/")) 
                    {
		        result = "org";
	        }
                    
                    else if (namespaceUri.equalsIgnoreCase("http://www.w3.org/2001/XMLSchema-instance"))
                    {
                        result = "xsi";
                    }
                    else
                    {
                        result = null;
                    }
            

            return result;
            }
    }

Let's start adding code to the MainForm. First, add the necessary imports at the top of the class file.

    import javax.xml.bind.*;
    import javax.swing.*;
    import java.io.*;
    import java.io.ByteArrayInputStream;
    import java.lang.*;
    import java.awt.*;
    import SEF850.*;

We will add a few private instance variables to the form and initialize a few in the constructor of the form.

    public class MainForm extends javax.swing.JFrame {

        private String sessionID = null;
        private EDIXMLOnline.EDIXMLOnlineService service = null;
        private EDIXMLOnline.EDIXMLOnlineServiceSoap port = null;
        private JAXBContext jaxbContext = null;

        /** Creates new form MainForm */
        public MainForm() {

            initComponents();
            try {

                service = new EDIXMLOnline.EDIXMLOnlineService();
                port = service.getEDIXMLOnlineServiceSoap12();
                jaxbContext = JAXBContext.newInstance("SEF850");
            } catch (Exception ex) {
                System.out.print(ex);
            }
        }    
        
        ...

The ActionPerformed event for the "Login" button looks like

    private void btnLoginActionPerformed(java.awt.event.ActionEvent evt) {                                         

        java.lang.String userID = txtUserName.getText();
        java.lang.String password = txtPassword.getText();
        java.lang.String siteID = "";

        txtSessionId.setText("");
        // Authenticate user and retrieve sessionID for subsequent calls to the 
        // web service
        sessionID = port.authenticateUser(userID, password, siteID);
        txtSessionId.setText(sessionID);
    }

The ActionPerformed event for the "Generate EDI in code" button looks like

    private void btnGenerateFromCodeActionPerformed(java.awt.event.ActionEvent evt) {                                                    

        // Instantiate proxy class object
        EdiDocument ediDoc = new EdiDocument();

        // Define Interchange Header
        ediDoc.setInterchangeControlHeader(new InterchangeControlHeaderISA());
        ediDoc.getInterchangeControlHeader().setAuthorizationInformationQualifier("00");
        ediDoc.getInterchangeControlHeader().setAuthorizationInformation("          ");
        ediDoc.getInterchangeControlHeader().setSecurityInformationQualifier("00");
        ediDoc.getInterchangeControlHeader().setSecurityInformation("          ");
        ediDoc.getInterchangeControlHeader().setInterchangeIDQualifier("ZZ");
        ediDoc.getInterchangeControlHeader().setInterchangeSenderID("SENDERISA      ");
        ediDoc.getInterchangeControlHeader().setInterchangeIDQualifier2("ZZ");
        ediDoc.getInterchangeControlHeader().setInterchangeReceiverID("123456789012345");
        ediDoc.getInterchangeControlHeader().setInterchangeDate("070930");
        ediDoc.getInterchangeControlHeader().setInterchangeTime("2218");
        ediDoc.getInterchangeControlHeader().setInterchangeControlStandardsIdentifier("U");
        ediDoc.getInterchangeControlHeader().setInterchangeControlVersionNumber("00401");
        ediDoc.getInterchangeControlHeader().setInterchangeControlNumber(new BigInteger("000000020"));
        ediDoc.getInterchangeControlHeader().setAcknowledgmentRequested("0");
        ediDoc.getInterchangeControlHeader().setUsageIndicator("T");
        ediDoc.getInterchangeControlHeader().setComponentElementSeparator(">");

        // Define Functional Group
        ediDoc.setFunctionalGroupHeader(new FunctionalGroupHeaderGS());
        ediDoc.getFunctionalGroupHeader().setFunctionalIdentifierCode("PO");
        ediDoc.getFunctionalGroupHeader().setApplicationSendersCode("SENDERGS");
        ediDoc.getFunctionalGroupHeader().setApplicationReceiversCode("007326879");
        ediDoc.getFunctionalGroupHeader().setDate("20070930");
        ediDoc.getFunctionalGroupHeader().setTime("2227");
        ediDoc.getFunctionalGroupHeader().setGroupControlNumber(new BigInteger("000001"));
        ediDoc.getFunctionalGroupHeader().setResponsibleAgencyCode("X");
        ediDoc.getFunctionalGroupHeader().setVersionOrReleaseOrIndustryIdentifierCode("004010");

        // Define "Purchase Order" transactionset
        ItemForTransactionSets sets = new ItemForTransactionSets();
        ediDoc.setTransactionSets(sets);
        
        PurchaseOrder po = new PurchaseOrder();

        sets.getTransactionSet().add(po);
        
        
        po.setTransactionSetHeader(new TransactionSetHeaderST());
        po.getTransactionSetHeader().setTransactionSetIdentifierCode("850");
        po.getTransactionSetHeader().setTransactionSetControlNumber("000000001");

        // Define BEG segment
        po.setBeginningSegmentforPurchaseOrder(new BeginningSegmentforPurchaseOrderBEG());
        po.getBeginningSegmentforPurchaseOrder().setPurchaseOrderTypeCode("SA");
        po.getBeginningSegmentforPurchaseOrder().setPurchaseOrderNumber("PO123");
        po.getBeginningSegmentforPurchaseOrder().setTransactionSetPurposeCode("00");
        po.getBeginningSegmentforPurchaseOrder().setReleaseNumber("1");
        po.getBeginningSegmentforPurchaseOrder().setDate("20070930");
        po.getBeginningSegmentforPurchaseOrder().setContractNumber("  ");


        // Define PO1 "loop section" which is a collection of segments ...
        // ...declare 2 line items (segments)...
        ItemForBaselineItemData lineItems = new ItemForBaselineItemData();
        po.setArrayOfBaselineItemData(lineItems);

        // ... create 1st item ...
        BaselineItemData item = new BaselineItemData();

        // ... and define dataelements ...
        item.setBaselineItemData(new BaselineItemDataPO1());

        item.getBaselineItemData().setProductOrServiceIDQualifier("CB");
        item.getBaselineItemData().setProductOrServiceID("000111111");
        item.getBaselineItemData().setProductOrServiceIDQualifier2("UA");
        item.getBaselineItemData().setProductOrServiceID2("002480022222");
        item.getBaselineItemData().setAssignedIdentification(" ");
        item.getBaselineItemData().setQuantityOrdered((float) 16);
        item.getBaselineItemData().setUnitorBasisforMeasurementCode("CA");
        item.getBaselineItemData().setUnitPrice((float) 12);
        item.getBaselineItemData().setBasisofUnitPriceCode("  ");

        // ... NOTE: We add a nested loop segment of Pricing information for this (1st) item.
        ItemForPricingInformation2 priceItems = new ItemForPricingInformation2();
        item.setArrayOfPricingInformation(priceItems);

        PricingInformation pricing = new PricingInformation();

        pricing.setPricingInformation(new PricingInformationCTP());
        pricing.getPricingInformation().setClassofTradeCode("AA");

        pricing.setCurrency(new CurrencyCUR());
        pricing.getCurrency().setEntityIdentifierCode("01");

        /// BUG!!! We need to have this otherwise the serializer will leave this element off for whatever reason.
        /// .NET handles this properly without having to specify this.
        pricing.getCurrency().setCurrencyCode("");

        item.getArrayOfPricingInformation().getItemForPricingInformation2().add(pricing);

        // ... add item to collection ...
        lineItems.getItemForBaselineItemData().add(item);
       

        // ... create 2nd item ...
        BaselineItemData item2 = new BaselineItemData();
        item2.setBaselineItemData(new BaselineItemDataPO1());

        // ... and define it's dataelements ...
        item.getBaselineItemData().setProductOrServiceIDQualifier("CX");
        item.getBaselineItemData().setProductOrServiceID("000111112");
        item.getBaselineItemData().setProductOrServiceIDQualifier2("UA");
        item.getBaselineItemData().setProductOrServiceID2("002480022223");
        item.getBaselineItemData().setAssignedIdentification(" ");
        item.getBaselineItemData().setQuantityOrdered((float) 17);
        item.getBaselineItemData().setUnitorBasisforMeasurementCode("CA");
        item.getBaselineItemData().setUnitPrice((float) 12.00);
        item.getBaselineItemData().setBasisofUnitPriceCode("  ");

        // ... add item to collection ...
        lineItems.getItemForBaselineItemData().add(item);        
        

        // Define CTT segment
        TransactionTotalsCTT tt = new TransactionTotalsCTT();
        tt.setNumberofLineItems(new BigInteger("7"));

        // Define TransactionSet trailer (SE) information
        po.setTransactionSetTrailer(new TransactionSetTrailerSE());
        po.getTransactionSetTrailer().setNumberofIncludedSegments(new BigInteger("0"));
        po.getTransactionSetTrailer().setTransactionSetControlNumber("000000001");

        // Define FunctionalGroup trailer (GE) information
        ediDoc.setFunctionalGroupTrailer(new FunctionalGroupTrailerGE());
        ediDoc.getFunctionalGroupTrailer().setNumberofTransactionSetsIncluded(new BigInteger("1"));
        ediDoc.getFunctionalGroupTrailer().setGroupControlNumber(new BigInteger("000001"));

        // Define Interchange trailer (IEA) information
        ediDoc.setInterchangeControlTrailer(new InterchangeControlTrailerIEA());
        ediDoc.getInterchangeControlTrailer().setNumberofIncludedFunctionalGroups(new BigInteger("1"));
        ediDoc.getInterchangeControlTrailer().setInterchangeControlNumber(new BigInteger("000000020"));

        try {
            // Serialize the EDIDocument object to an xml file
            String filename = "c://javaeditest.xml";
            Marshaller marshaller = jaxbContext.createMarshaller();

            marshaller.setProperty("com.sun.xml.bind.namespacePrefixMapper", new DefaultNamespacePrefixMapper());
            marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, new Boolean(true));

            FileOutputStream fs = new FileOutputStream(filename);
            marshaller.marshal(ediDoc, fs);
            fs.close();


            // Read In fileinformation as a bytearray
            byte[] xmlInfo = null;
            // get the file information form the selected file
            File fInfo = new File(filename);
            int numBytes = (int) fInfo.length();
            xmlInfo = new byte[numBytes];

            // set up a file stream and binary reader for the selected file
            FileInputStream fStream = new FileInputStream(filename);
            DataInputStream inStream = new DataInputStream(fStream);
            try {
                // convert the file to a byte array
                inStream.read(xmlInfo, 0, numBytes);
            } finally {
                inStream.close();
                // pass the byte array (file) and file name to the web service
                fStream.close();
            }


            EDIXMLOnline.ReturnPacket result = port.generate(xmlInfo, txtSefId.getText(), sessionID);
            byte[] ediData = result.getPayload();
            txtEDI.setText(new String(ediData, "ASCII"));
            
            JOptionPane.showMessageDialog(this, "Done");
            
        } catch (Exception ex) {
            System.out.print(ex);
        }
    }

The ActionPerformed event for the "Translate EDI Text (Serialized Xml)" button looks like

    private void btnTranslateFromEDITextActionPerformed(java.awt.event.ActionEvent evt) {                                                        

        EdiDocument ediDoc = new EdiDocument();
        try {
            byte[] ediInfo = txtEDI.getText().getBytes("ASCII");

            // Call Translate service operation to translate the EDI file
            EDIXMLOnline.ReturnPacket result = port.translate(ediInfo, txtSefId.getText(), sessionID);
            // Get a reference to the Xml response
            byte[] xmlData = result.getPayload();

            txtXML.setText(new String(xmlData, "UTF-8"));

            // Deserialize Xml response to proxy object
            ByteArrayInputStream bis = new ByteArrayInputStream(xmlData);
            try {
                Unmarshaller marshaller = jaxbContext.createUnmarshaller();
                ediDoc = (EdiDocument) marshaller.unmarshal(bis);
            } finally {
                bis.close();
            }

            // Display XML from deserialized object
            Marshaller marshaller2 = jaxbContext.createMarshaller();
            marshaller2.setProperty("com.sun.xml.bind.namespacePrefixMapper", new DefaultNamespacePrefixMapper());
            marshaller2.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, new Boolean(true));
            ByteArrayOutputStream bos = new ByteArrayOutputStream();
            try {
                marshaller2.marshal(ediDoc, bos);
            } finally {
                bos.close();
            }
            byte[] data = bos.toByteArray();
            txtXML.setText(new String(data, "UTF-8"));
            
            JOptionPane.showMessageDialog(this, "Done");
            
        } catch (Exception ex) {
            // TODO handle custom exceptions here
            System.out.print(ex);
        }
    }

The ActionPerformed event for the "Translate EDI File To XML" button looks like

    private void btnTranslateEDIToXMLActionPerformed(java.awt.event.ActionEvent evt) {                                                     

        try {

            String filename = txtEDIFileName.getText();

            // Read In fileinformation as a bytearray
            byte[] ediInfo = null;
            // get the file information form the selected file
            File fInfo = new File(filename);
            int numBytes = (int) fInfo.length();
            ediInfo = new byte[numBytes];

            // set up a file stream and binary reader for the selected file
            FileInputStream fStream = new FileInputStream(filename);
            DataInputStream inStream = new DataInputStream(fStream);
            try {
                // convert the file to a byte array
                inStream.read(ediInfo, 0, numBytes);
            } finally {
                inStream.close();
                // pass the byte array (file) and file name to the web service
                fStream.close();
            }

            // Call translate service
            EDIXMLOnline.ReturnPacket result = port.translate(ediInfo, txtSefId.getText(), sessionID);
            byte[] xmlData = result.getPayload();

            txtXML.setText(new String(xmlData, "UTF-8"));

            JOptionPane.showMessageDialog(this, "Done");
            
        } catch (Exception ex) {
            // TODO handle custom exceptions here
            System.out.print(ex);
        }
    }

The ActionPerformed event for the "Generate From XML To EDI" button looks like

    private void btnGenerateFromXMLToEDIActionPerformed(java.awt.event.ActionEvent evt) {                                                        

        try {
            txtEDI.setText("");

            // Fill (Deserialize) proxy object with what may be only "basic" XML contents
            EdiDocument ediDoc = new EdiDocument();
            Unmarshaller umarshaller = jaxbContext.createUnmarshaller();
            ByteArrayInputStream bis = new ByteArrayInputStream(txtXML.getText().getBytes("UTF-8"));
            try {
                ediDoc = (EdiDocument) umarshaller.unmarshal(bis);
            } finally {
                bis.close();
            }

            // Serialize object back to Xml. 
            // ** NOTE** The Xml created is more informative for the service and is less prone to syntactical errors
            Marshaller marshaller = jaxbContext.createMarshaller();
            marshaller.setProperty("com.sun.xml.bind.namespacePrefixMapper", new DefaultNamespacePrefixMapper());
            marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, new Boolean(true));

            byte[] xmlInfo = null;
            ByteArrayOutputStream bos = new ByteArrayOutputStream();
            try {
                marshaller.marshal(ediDoc, bos);
                xmlInfo = bos.toByteArray();
            } finally {
                bos.close();
            }

            // Call generate service
            EDIXMLOnline.ReturnPacket result = port.generate(xmlInfo, txtSefId.getText(), sessionID);
            byte[] ediData = result.getPayload();
            // display results
            txtEDI.setText(new String(ediData, "ASCII"));
            
            JOptionPane.showMessageDialog(this, "Done");
            
        } catch (Exception ex) {
            System.out.print(ex);
        }
    }

The ActionPerformed event for the "Validate EDI Text" button looks like

    private void btnValidateEDITextActionPerformed(java.awt.event.ActionEvent evt) {                                                   

        txtValidation.setText("");
        try {
            byte[] ediInfo = txtEDI.getText().getBytes("ASCII");

            // Call Validation operation
            EDIXMLOnline.ReturnPacket result = port.validateEDI(ediInfo, txtSefId.getText(), sessionID);
            if (result.isHasWarnings())
            {
                for(int i = 0; i < result.getWarnings().getWarning().size(); i++)
                {
                    EDIXMLOnline.Warning warning = result.getWarnings().getWarning().get(i);
                    txtValidation.append(warning.getDescription() + "\n");
                }
            }
            
            JOptionPane.showMessageDialog(this, "Done");
            
        } catch (Exception ex) {
            // TODO handle custom exceptions here
            System.out.print(ex);
        }
        
    }

The ActionPerformed event for the "Validate XML Text" button looks like the one for the EDI except that it calls the "ValidateXml" service operation.

Run the application.

Note

You will find that the raw Xml from the Translation service will not validate as well as the Xml created from a serialized proxy object. This is because the serialized xml is more complete and is dictated by the proxy class that was created based on the rules defined in the schema information found in the WSDL. Whereas, the translation service forumlates its xml reply based on the EDI payload and the rules defined by the SEF file.

So, the raw xml file from the translation service is not an accurate representation of EDI payload, you must deserialize it into a proxy object and interrogate the properties of the object.

EDIXMLOnline

Using the Web Service with Java (NetBeans 6.x)

Note

Register for an account and start programming with the EDIXMLOnline web service. We provide you with a few SEF files in your account for you to use.