Difference between revisions of "SDK for Java"

From OpenKM Documentation
Jump to: navigation, search
m
 
(21 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Note|If '''you want to collaborate''' extending features or add newer '''contact with us at''' [http://www.openkm.com/en/contact.html contact website form] indicating this URL.}}
+
{{Note|If '''you want to collaborate''' extending features or add newer, please '''contact with us at''' [http://www.openkm.com/en/contact.html contact website form] indicating this URL.}}
  
OpenKM SDK for Java are a set of software developement tools that allows for the creation of application for OpenKM. The OpenKM SDK for Java include A webservice library. Webservices library is a complete API layer to access OpenKM with webservices what provide complete compatibility between webservices versions without change code.  
+
Take a look at [[Java SDK Changelog]] to see release notes.
  
'''Available jar file'''
+
=== Available versions ===
* [[Java SDK| Openkm-sdk4j.jar]]
+
{| border="1" cellpadding="2" cellspacing="0"
 +
|'''Version'''
 +
|'''Compatibility'''
 +
|-
 +
|[[SDK for Java 2.3]]
 +
|6.4.20+ Professional
 +
|-
 +
|[[SDK for Java 2.2]]
 +
|6.4.18+ Professional
 +
|-
 +
|[[SDK for Java 2.1]]
 +
|6.4.x Professional
 +
|-
 +
|[[SDK for Java 2.0|SDK for Java 2.0 (Deprecated)]]
 +
|6.4.x Professional
 +
|-
 +
|[[SDK for Java 1.1]]
 +
|6.2.x Professional & 6.3.x Community
 +
|-
 +
|[[SDK for Java 1.0|SDK for Java 1.0 (Deprecated)]]
 +
|6.2.x Professional & 6.3.x Community
 +
|-
 +
|[[Java SDK|Java SDK (Deprecated)]]
 +
|Older profesional 6.2.x & professional 6.4.x
 +
|}
  
== Sample client using this JDK ==
 
You can make use of the OpenKM Maven Repository and will be using the right JDK version. This is a sample pom.xml configuration:
 
 
<source lang="xml">
 
<?xml version="1.0" encoding="UTF-8"?>
 
<project xmlns="http://maven.apache.org/POM/4.0.0"
 
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 
        xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 
  <modelVersion>4.0.0</modelVersion>
 
 
  <groupId>com.openkm.sample</groupId>
 
  <artifactId>prueba</artifactId>
 
  <version>1.0-SNAPSHOT</version>
 
 
  <repositories>
 
    <repository>
 
      <id>openkm.com</id>
 
      <name>OpenKM Maven Repository</name>
 
      <url>http://maven.openkm.com/maven2</url>
 
    </repository>
 
  </repositories>
 
 
  <dependencies>
 
    <dependency>
 
      <groupId>com.openkm</groupId>
 
      <artifactId>sdk4j</artifactId>
 
      <version>1.0</version>
 
    </dependency>
 
  </dependencies>
 
</project>
 
</source>
 
 
In this class you can see how to call an API method to request all folder children from "/okm:root":
 
 
<source lang="java">
 
import com.openkm.sdk4j.OKMWebservices;
 
import com.openkm.sdk4j.OKMWebservicesFactory;
 
import com.openkm.sdk4j.bean.Folder;
 
import com.openkm.sdk4j.exception.*;
 
 
/**
 
* Sample OpenKM JDK client
 
*/
 
public class Main {
 
    public static void main(String var[]) throws Exception {
 
        String url = "http://demo.openkm.com/OpenKM";
 
        String user = "user5";
 
        String pass = "pass5";
 
        OKMWebservices okm = OKMWebservicesFactory.newInstance(OKMWebservicesFactory.PROFESSIONAL_6_2, url, user, pass);
 
 
        for (Folder fld : okm.getFolderChildren("/okm:root")) {
 
            System.out.println("Fodler -> " + fld.getPath());
 
        }
 
    }
 
</source>
 
 
Ans this is the pom.xml used in this project:
 
  
 +
{{Warning|We've decided create SDK version based on its own SDK number version not based on SDK OpenKM supported version. For this reason we consider first version JAVA_SDK as deprecated.}}
  
 
[[Category: Extension Guide]]
 
[[Category: Extension Guide]]

Latest revision as of 13:40, 24 April 2015


Nota clasica.png If you want to collaborate extending features or add newer, please contact with us at contact website form indicating this URL.

Take a look at Java SDK Changelog to see release notes.

Available versions

Version Compatibility
SDK for Java 2.3 6.4.20+ Professional
SDK for Java 2.2 6.4.18+ Professional
SDK for Java 2.1 6.4.x Professional
SDK for Java 2.0 (Deprecated) 6.4.x Professional
SDK for Java 1.1 6.2.x Professional & 6.3.x Community
SDK for Java 1.0 (Deprecated) 6.2.x Professional & 6.3.x Community
Java SDK (Deprecated) Older profesional 6.2.x & professional 6.4.x



Nota advertencia.png We've decided create SDK version based on its own SDK number version not based on SDK OpenKM supported version. For this reason we consider first version JAVA_SDK as deprecated.