Difference between revisions of "Java client - OpenKM 6.2"

From OpenKM Documentation
Jump to: navigation, search
(Created page with '{{TOCright}} __TOC__ First, we need to generate the client stuff using this command. Keep on mind that you need JDK 1.6 to run it: $ wsimport -d client -s client http://localh…')
 
 
(23 intermediate revisions by 2 users not shown)
Line 3: Line 3:
 
First, we need to generate the client stuff using this command. Keep on mind that you need JDK 1.6 to run it:
 
First, we need to generate the client stuff using this command. Keep on mind that you need JDK 1.6 to run it:
  
−
  $ wsimport -d client -s client http://localhost:8080/OpenKM/services/Auth?wsdl
+
  $ wsimport -p com.openkm.ws.client -keep http://localhost:8080/OpenKM/services/OKMAuth?wsdl
  
 
You can use the following script to generate a complete OpenKM webservices client library:
 
You can use the following script to generate a complete OpenKM webservices client library:
Line 10: Line 10:
 
#/bin/bash
 
#/bin/bash
  
−
wsimport -p com.openkm.ws.client http://localhost:8080/OpenKM/services/Auth?wsdl
+
wsimport -p com.openkm.ws.client.auth -keep http://localhost:8080/OpenKM/services/OKMAuth?wsdl
−
wsimport -p com.openkm.ws.client http://localhost:8080/OpenKM/services/Document?wsdl
+
wsimport -p com.openkm.ws.client.bookmark -keep http://localhost:8080/OpenKM/services/OKMBookmark?wsdl
−
wsimport -p com.openkm.ws.client http://localhost:8080/OpenKM/services/Folder?wsdl
+
wsimport -p com.openkm.ws.client.document -keep http://localhost:8080/OpenKM/services/OKMDocument?wsdl
−
wsimport -p com.openkm.ws.client http://localhost:8080/OpenKM/services/Search?wsdl
+
wsimport -p com.openkm.ws.client.folder -keep http://localhost:8080/OpenKM/services/OKMFolder?wsdl
−
wsimport -p com.openkm.ws.client http://localhost:8080/OpenKM/services/Notification?wsdl
+
wsimport -p com.openkm.ws.client.mail -keep http://localhost:8080/OpenKM/services/OKMMail?wsdl
−
wsimport -p com.openkm.ws.client http://localhost:8080/OpenKM/services/Repository?wsdl
+
wsimport -p com.openkm.ws.client.note -keep http://localhost:8080/OpenKM/services/OKMNote?wsdl
−
wsimport -p com.openkm.ws.client http://localhost:8080/OpenKM/services/PropertyGroup?wsdl
+
wsimport -p com.openkm.ws.client.notification -keep http://localhost:8080/OpenKM/services/OKMNotification?wsdl
−
wsimport -p com.openkm.ws.client http://localhost:8080/OpenKM/services/Workflow?wsdl
+
wsimport -p com.openkm.ws.client.propertyGroup -keep http://localhost:8080/OpenKM/services/OKMPropertyGroup?wsdl
 +
wsimport -p com.openkm.ws.client.property -keep http://localhost:8080/OpenKM/services/OKMProperty?wsdl
 +
wsimport -p com.openkm.ws.client.repository -keep http://localhost:8080/OpenKM/services/OKMRepository?wsdl
 +
wsimport -p com.openkm.ws.client.search -keep http://localhost:8080/OpenKM/services/OKMSearch?wsdl
 +
wsimport -p com.openkm.ws.client.workflow -keep http://localhost:8080/OpenKM/services/OKMWorkflow?wsdl
  
−
jar cvf okm-ws-client-2.1.jar com
+
jar cvf okm-ws-client-6.2.jar com
  
 
rm -rf com
 
rm -rf com
 
</source>
 
</source>
 +
 +
'''How can I change the Web Service address dynamically for a request ?'''
 +
<source lang="java">
 +
OKMAuth okmAuth = new OKMAuth_Service(new URL(url + "/services/OKMAuth?wsdl"),
 +
    new QName("http://ws.openkm.com", "OKMAuth")).getOKMAuthPort();
 +
</source>
 +
 +
or
 +
 +
<source lang="java">
 +
((BindingProvider) port).getRequestContext().put(BindingProvider.ENDPOINT_ADDRESS_PROPERTY, "...");
 +
</source>
 +
 +
== Authentication ==
 +
 +
<source lang="java">
 +
package com.openkm.ws.test;
 +
 +
import com.openkm.ws.client.auth.OKMAuth;
 +
import com.openkm.ws.client.auth.OKMAuth_Service;
 +
 +
public class Authentication {
 +
    public static void main(String[] args) {
 +
        try {
 +
            OKMAuth okmAuth = new OKMAuth_Service().getOKMAuthPort();
 +
 +
            // Login
 +
            String token = okmAuth.login("okmAdmin", "admin");
 +
            System.out.println("Token: " + token);
 +
 +
            // Logout
 +
            okmAuth.logout(token);
 +
        } catch (Exception e) {
 +
            e.printStackTrace();
 +
        }
 +
    }
 +
}
 +
</source>
 +
 +
== PropertyGroups ==
 +
 +
<source lang="java">
 +
package com.openkm.ws.test;
 +
 +
import java.util.ArrayList;
 +
import java.util.List;
 +
 +
import com.openkm.ws.client.auth.OKMAuth;
 +
import com.openkm.ws.client.auth.OKMAuth_Service;
 +
import com.openkm.ws.client.PropertyGroup;
 +
import com.openkm.ws.client.PropertyGroup_Service;
 +
import com.openkm.ws.client.StringPair;
 +
 +
public class PropertyGroups {
 +
    public static void main(String[] args) throws Exception {
 +
        OKMAuth okmAuth = new OKMAuth_Service().getOKMAuthPort();
 +
        OKMPropertyGroup okmPg = new OKMPropertyGroup_Service().getOKMPropertyGroupPort();
 +
       
 +
        // login
 +
        String token = okmAuth.login("okmAdmin", "admin");
 +
       
 +
        // property groups
 +
        List<StringPair> spList = new ArrayList<StringPair>();
 +
        StringPair sp = new StringPair();
 +
        sp.setKey("okp:technology.comment");
 +
        sp.setValue("Other comment from PHP");
 +
        spList.add(sp);
 +
        okmPg.setPropertiesSimple(token, "/okm:root/test/hosts.txt", "okg:technology", spList);
 +
       
 +
        // logout
 +
        okmAuth.logout(token);
 +
    }
 +
}
 +
</source>
 +
 +
[[Category: Webservices Guide]]

Latest revision as of 10:12, 7 January 2013

First, we need to generate the client stuff using this command. Keep on mind that you need JDK 1.6 to run it: 

$ wsimport -p com.openkm.ws.client -keep http://localhost:8080/OpenKM/services/OKMAuth?wsdl

You can use the following script to generate a complete OpenKM webservices client library: 

#/bin/bash

wsimport -p com.openkm.ws.client.auth -keep http://localhost:8080/OpenKM/services/OKMAuth?wsdl
wsimport -p com.openkm.ws.client.bookmark -keep http://localhost:8080/OpenKM/services/OKMBookmark?wsdl
wsimport -p com.openkm.ws.client.document -keep http://localhost:8080/OpenKM/services/OKMDocument?wsdl
wsimport -p com.openkm.ws.client.folder -keep http://localhost:8080/OpenKM/services/OKMFolder?wsdl
wsimport -p com.openkm.ws.client.mail -keep http://localhost:8080/OpenKM/services/OKMMail?wsdl
wsimport -p com.openkm.ws.client.note -keep http://localhost:8080/OpenKM/services/OKMNote?wsdl
wsimport -p com.openkm.ws.client.notification -keep http://localhost:8080/OpenKM/services/OKMNotification?wsdl
wsimport -p com.openkm.ws.client.propertyGroup -keep http://localhost:8080/OpenKM/services/OKMPropertyGroup?wsdl
wsimport -p com.openkm.ws.client.property -keep http://localhost:8080/OpenKM/services/OKMProperty?wsdl
wsimport -p com.openkm.ws.client.repository -keep http://localhost:8080/OpenKM/services/OKMRepository?wsdl
wsimport -p com.openkm.ws.client.search -keep http://localhost:8080/OpenKM/services/OKMSearch?wsdl
wsimport -p com.openkm.ws.client.workflow -keep http://localhost:8080/OpenKM/services/OKMWorkflow?wsdl

jar cvf okm-ws-client-6.2.jar com

rm -rf com

How can I change the Web Service address dynamically for a request ? 

OKMAuth okmAuth = new OKMAuth_Service(new URL(url + "/services/OKMAuth?wsdl"),
    new QName("http://ws.openkm.com", "OKMAuth")).getOKMAuthPort();

or 

((BindingProvider) port).getRequestContext().put(BindingProvider.ENDPOINT_ADDRESS_PROPERTY, "...");

Authentication

package com.openkm.ws.test;

import com.openkm.ws.client.auth.OKMAuth;
import com.openkm.ws.client.auth.OKMAuth_Service;

public class Authentication {
    public static void main(String[] args) {
        try {
            OKMAuth okmAuth = new OKMAuth_Service().getOKMAuthPort();

            // Login
            String token = okmAuth.login("okmAdmin", "admin");
            System.out.println("Token: " + token);

            // Logout
            okmAuth.logout(token);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

PropertyGroups

package com.openkm.ws.test;

import java.util.ArrayList;
import java.util.List;

import com.openkm.ws.client.auth.OKMAuth;
import com.openkm.ws.client.auth.OKMAuth_Service;
import com.openkm.ws.client.PropertyGroup;
import com.openkm.ws.client.PropertyGroup_Service;
import com.openkm.ws.client.StringPair;

public class PropertyGroups {
    public static void main(String[] args) throws Exception {
        OKMAuth okmAuth = new OKMAuth_Service().getOKMAuthPort();
        OKMPropertyGroup okmPg = new OKMPropertyGroup_Service().getOKMPropertyGroupPort();
        
        // login
        String token = okmAuth.login("okmAdmin", "admin");
        
        // property groups
        List<StringPair> spList = new ArrayList<StringPair>();
        StringPair sp = new StringPair();
        sp.setKey("okp:technology.comment");
        sp.setValue("Other comment from PHP");
        spList.add(sp);
        okmPg.setPropertiesSimple(token, "/okm:root/test/hosts.txt", "okg:technology", spList);
        
        // logout
        okmAuth.logout(token);
    }
}
Retrieved from "https://www.openkm.com/wiki/index.php?title=Java_client_-_OpenKM_6.2&oldid=8466"