Microsoft Sharepoint Web Services integration with Java

[seshu Palamanti]

Hi Ranch,
I am trying to use MS Sharepoint via Web Services using Java code, I have successfuly been able to use Lists WSDL to generate code using WSIMPORT and connect to sharepoint using basic authenication, call get lists method which returns the list of file objects on the document library in XML. Now I am trying to do file check in (File upload) and check out ( File download) using the same approach, I would really appreciate any suggestion or help in this Endeavour. Thanks in advance.

[Napa Sreedhar]

I think you have to look into share point documentation on what java interfaces can be used for integration.

Google for Java interfaces to Sharepoint. I have found some.

[Samrat Paul]

seshu Palamanti wrote:Hi Ranch,
I am trying to use MS Sharepoint via Web Services using Java code, I have successfuly been able to use Lists WSDL to generate code using WSIMPORT and connect to sharepoint using basic authenication, call get lists method which returns the list of file objects on the document library in XML. Now I am trying to do file check in (File upload) and check out ( File download) using the same approach, I would really appreciate any suggestion or help in this Endeavour. Thanks in advance.

Hi Seshu,

I am struggling to connect to sharepoint using Lists webservice.I have generated the stub but still getting issues. Can you please gve me a detailed description on how actually to achieve it. A quick response will be highly appreciated.

Thanks,

[seshu Palamanti]

Samrat,
Can you please tell which problems you are getting into while doing call on Lists

[seshu Palamanti]

Samrat,
Here are the steps that I followed

1) run wsimport http://wsdl file location
2) Copy the generated .java files into your project source.
3) Write your own class to connect to Lists and print it out on console.
4) Set username and password to connect to webservice.

Here is the complete code. Hope this helps

package mypackage


import java.io.StringWriter;
import java.util.ArrayList;
import java.util.logging.Level;
import java.util.logging.Logger;

import com.microsoft.schemas.sharepoint.soap.GetListItems;
import com.microsoft.schemas.sharepoint.soap.GetListItemsResponse;
import com.microsoft.schemas.sharepoint.soap.GetListResponse.GetListResult;
import com.microsoft.schemas.sharepoint.soap.Lists;
import com.microsoft.schemas.sharepoint.soap.ListsSoap;
import com.sun.org.apache.xerces.internal.dom.events.*;

import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamResult;
import javax.xml.ws.BindingProvider;
import org.w3c.dom.Element;
import org.w3c.dom.Document;
import org.w3c.dom.NamedNodeMap;
import org.w3c.dom.NodeList;
import com.sun.org.apache.xerces.internal.*;

public class SharePointJavaClient {
    public static void main(final String[] args) throws Exception {
        final ListsSoap listsSoapProxy = sharePointListsAuth("username", "password");
        String listName = "TEST";
        String rowLimit = "150";
        ArrayList<String> listColumnNames = new ArrayList<String>();
        listColumnNames.add("FileRef");
        listColumnNames.add("Last_x0020_Modified");
        SharePointJavaClient.displaySharePointList(listsSoapProxy, listName, listColumnNames, rowLimit);
        
    }

    public static ListsSoap sharePointListsAuth(String userName, String password) throws Exception {
        ListsSoap port = null;
        if (userName != null && password != null) {
            try {
                Lists service = new Lists();
                port = service.getListsSoap();
                System.out.println("Web Service Auth Username: " + userName);
               ((BindingProvider) port).getRequestContext().put(BindingProvider.USERNAME_PROPERTY, userName);
               ((BindingProvider) port).getRequestContext().put(BindingProvider.PASSWORD_PROPERTY, password);
            } catch (Exception e) {
                throw new Exception("Error: " + e.toString());
            }
        } else {
            throw new Exception("Couldn't authenticate: Invalid connection details given.");
        }
        return port;
    }
    

    public static void displaySharePointList(ListsSoap port, String listName, ArrayList<String> listColumnNames, String rowLimit) throws Exception {
        if (port != null && listName != null && listColumnNames != null && rowLimit != null) {
            try {

                //Here are additional parameters that may be set
                String viewName = "";
                GetListItems.ViewFields viewFields = null;
               // GetListItems.Query query = null;
                GetListItems.Query query = null;
                GetListItems.QueryOptions queryOptions = null;
                String webID = "";

                //Calling the List Web Service
                GetListItemsResponse.GetListItemsResult result = port.getListItems(listName, viewName, query, viewFields, rowLimit, queryOptions, webID);
                Object listResult = result.getContent().get(0);
                if ((listResult != null) && (listResult instanceof Element)) {
                    Element node = (Element) listResult;

                    //Dumps the retrieved info in the console
                    Document document = node.getOwnerDocument();
                    System.out.println("SharePoint Online Lists Web Service Response:" + 
                   SharePointJavaClient.xmlToString(document));

                    //selects a list of nodes which have z:row elements
                    NodeList list = node.getElementsByTagName("z:row");
                    System.out.println("=> " + list.getLength() + " results from SharePoint Online");

                    //Displaying every result received from SharePoint, with its ID
                    for (int i = 0; i < list.getLength(); i++) {

                        //Gets the attributes of the current row/element
                        NamedNodeMap attributes = list.item(i).getAttributes();
                       System.out.println("******** Item ID: " + attributes.getNamedItem("ows_ID").getNodeValue()+" ********");

                        //Displays all the attributes of the list item that correspond to the column names given
                        for (String columnName : listColumnNames) {
                            String internalColumnName = "ows_" + columnName;
                            if (attributes.getNamedItem(internalColumnName) != null) {
                               System.out.println(columnName + ": " + attributes.getNamedItem(internalColumnName).getNodeValue());
                            } else {
                                throw new Exception("Couldn't find the '" + columnName + "' column in the '" + listName + "' list in SharePoint.\n");
                            }
                        }
                    }
                } else {
                    throw new Exception(listName + " list response from SharePoint is either null or corrupt\n");
                }
            } catch (Exception ex) {
                throw new Exception("Exception. See stacktrace." + ex.toString() + "\n");
            }
        }
    }

    
    public static String xmlToString(Document docToString) {
        String returnString = "\n-------------- XML START --------------\n";
        try { // create string from xml tree //Output the XML //set up a transformer
            TransformerFactory transfac = TransformerFactory.newInstance();
            Transformer trans;
            trans = transfac.newTransformer();
            trans.setOutputProperty(OutputKeys.OMIT_XML_DECLARATION, "yes");
            trans.setOutputProperty(OutputKeys.INDENT, "yes");
            StringWriter sw = new StringWriter();
            StreamResult streamResult = new StreamResult(sw);
            DOMSource source = new DOMSource(docToString);
            trans.transform(source, streamResult);
            String xmlString = sw.toString();
             returnString = returnString + xmlString;
        } catch (TransformerException ex) {
            Logger.getLogger(SharePointJavaClient.class.getName()).log(Level.SEVERE, null, ex);
        }
        returnString = returnString + "-------------- XML END --------------";
        return returnString;
    }
 
    public static String getListItems(ListsSoap port, String listName) throws Exception {
        String xmlToStrinResult = "";
        
        if (port != null && listName != null ) {
            try {
                //Here are additional parameters that may be set
                String viewName = "";
                GetListItems.ViewFields viewFields = null;
                GetListItems.Query query = null;
                GetListItems.QueryOptions queryOptions = null;
                String webID = "";
                String rowLimit = "";

                //Calling the List Web Service
                GetListItemsResponse.GetListItemsResult result = port.getListItems(listName, viewName, query, viewFields, rowLimit, queryOptions, webID);
                Object listResult = result.getContent().get(0);
                if ((listResult != null) && (listResult instanceof Element)) {
                    Element node = (Element) listResult;

                    //Dumps the retrieved info in the console
                    Document document = node.getOwnerDocument();
                    xmlToStrinResult = SharePointJavaClient.xmlToString(document);
                  //  System.out.println("SharePoint Online Lists Web Service Response:" + xmlToStrinResult);
                } else {
                    xmlToStrinResult = listName + " list response from SharePoint is either null or corrupt";
                }
            } catch (Exception ex) {
                xmlToStrinResult = "Exception occurred.\nPosible cause: invalid 'listName' parameter.\nStacktrace: " + ex.toString();
            }
        }
        return xmlToStrinResult;
    }



       
}

[Pavan Kumar Nvr]

Hi Seshu,

Can you please tell me the environment setup you have used to make the above code work. I have tried the same approach using the below mentioned environment but was not able to connect to the Share Point Server (Authentication issues fall on)

Web Sphere 7
JAX-WS Web Service

Thanks,
Pavan Kumar.

[Warra Guy]

Hi all,

I am new to java and im trying to read a sharepoint list via a java program.
I followed the steps above and it complies, however when it comes to run the following an com.sun.xml.internal.ws.fault.ServerSOAPFaultException exception is thrown:

GetListItemsResponse.GetListItemsResult result = port.getListItems(listName, viewName, query, viewFields, rowLimit, queryOptions, webID);


I am sure the list name i am passing exists and is correct.

Can any one guide me please?