Plugin samples

Aspectos básicos

Ejemplo de código sugerido

Primero debe crear el objeto webservice:

OKMWebservices ws = OKMWebservicesFactory.newInstance(host);

A continuación, debe iniciar sesión mediante el método “login”. Puede acceder al método “login” desde el objeto del servicio web “ws”, tal y como se muestra a continuación:

ws.login(user, password);

Precaución

Una vez que ha iniciado sesión en los servicios web, la sesión se mantiene en el objeto del servicio web. A partir de ahí puede usar el resto de métodos de la API.

Llegados a este punto, puede usar todos los métodos de plugin desde la clase “plugin”, tal y como se muestra a continuación:

ws.plugin.executePluginPostReturnFile("com.openkm.plugin.rest.TestGetDocumentRestPlugin", parameters, null);

Métodos

executePluginPost

Descripción:

Método	Valores de retorno	Descripción
executePluginPost(String className, Dictionary<String, String> parameters, Type clazz, FileStream fs)	Object	Devuelve el valor del objeto resultante de ejecutar una clase que implementa RestPlugin.

Consejo

• El valor “className” debe ser el nombre canónico de una clase que implemente la interfaz RestPlugin.
• El mapa “parameters” contiene los valores que usará la clase indicada en className.
• El valor “clazz” debe ser la clase del objeto devuelto. REST lo usa para deserializar (unmarshal) el resultado de la consulta.
• El flujo de fichero “fs” permite subir un documento.

Nota

Este método ejecuta una llamada REST mediante POST.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

            try
            {
                ws.login(user, password);
                FileStream fs = new FileStream(@"D:\Testing\pluging.docx", FileMode.Open, FileAccess.Read);
                Dictionary<String, String> parameters = new Dictionary<String, String>();
                parameters.Add("param1", "value1");
                parameters.Add("param2", "value2");
                String res = (String) ws.plugin.executePluginPost("com.openkm.plugin.rest.TestRestPlugin", parameters, typeof(string), fs);
                fs.Close();
                System.Console.WriteLine(res);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

executePluginPostReturnFile

Descripción:

Método	Valores de retorno	Descripción
executePluginPostReturnFile(String className, Dictionary<String, String> parameters, FileStream fs)	Stream	Devuelve un InputStream resultante de ejecutar una clase que implementa RestPlugin.

Consejo

• El valor “className” debe ser el nombre canónico de una clase que implemente la interfaz RestPlugin.
• El mapa “parameters” contiene los valores que usará la clase indicada en className.
• El flujo “is” permite subir un documento.

Nota

Este método ejecuta una llamada REST mediante POST.

El RestPlugin debe devolver un objeto Response. Consulte el siguiente ejemplo de implementación de RestPlugin:

package com.openkm.plugin.rest;

import net.xeoh.plugins.base.annotations.PluginImplementation;

import java.io.InputStream;
import java.util.Map;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.io.InputStreamResource;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;

import com.openkm.bean.Document;
import com.openkm.module.db.DbDocumentModule;
import com.openkm.plugin.BasePlugin;
import com.openkm.util.PathUtils;

/**
* Sample rest plugin
*
* @author jllort
*/
@PluginImplementation
public class TestGetDocumentRestPlugin extends BasePlugin implements RestPlugin {

    private static Logger log = LoggerFactory.getLogger(TestGetDocumentRestPlugin.class);

    @Autowired
    private DbDocumentModule dbDocumentModule;

    @Autowired
    private PathUtils pathUtils;

    @Override
    public Object executePlugin(Map<String, String> parameters, InputStream is) throws Exception {
        log.debug("executePlugin({})", parameters);
        String docId = parameters.get("docId");
        boolean inline = parameters.containsKey("inline");
        Document doc = dbDocumentModule.getProperties(null, docId);
        String mimeType = doc.getMimeType();
        String fileName = pathUtils.getName(doc.getPath());
        InputStream isContent = dbDocumentModule.getContent(null, docId, false);

        HttpHeaders responseHeaders = new HttpHeaders();
        responseHeaders.add("Content-Type", mimeType);

        // inline true when you want to embedded the content into
        if (inline) {
            responseHeaders.add("Content-disposition", "inline; filename=\"" + fileName + "\"");
        } else {
            responseHeaders.add("Content-Disposition", "attachment; filename=\"" + fileName + "\"");
        }

        responseHeaders.setContentLength(doc.getActualVersion().getSize());
        InputStreamResource inputStreamResource = new InputStreamResource(isContent);
        log.debug("TestGetDocumentRestPlugin: [BINARY]");
        return new ResponseEntity<>(inputStreamResource, responseHeaders, HttpStatus.OK);
    }
}

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

            try
            {
                ws.login(user, password);
                FileStream fs = new FileStream(@"D:\Testing\pluging.docx", FileMode.Open, FileAccess.Read);
                Dictionary<String, String> parameters = new Dictionary<String, String>();
                parameters.Add("docId", "/okm:root/test.pdf");
                Stream tmpFIle = ws.plugin.executePluginPostReturnFile("com.openkm.plugin.rest.TestGetDocumentRestPlugin", parameters, null);
                FileStream destFile = new FileStream(@"D:\Testing\pluging.pdf", FileMode.OpenOrCreate);
                tmpFIle.CopyTo(destFile);
                destFile.Close();
                tmpFIle.Close();
                fs.Close();
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

executePluginGet

Descripción:

Método	Valores de retorno	Descripción
executePluginGet(String className, Dictionary<String, String> parameters, Type clazz)	Object	Devuelve un InputStream resultante de ejecutar una clase que implementa RestPlugin.

Consejo

• El valor “className” debe ser el nombre canónico de una clase que implemente la interfaz RestPlugin.
• El mapa “parameters” contiene los valores que usará la clase indicada en className.
• El valor “clazz” debe ser la clase del objeto devuelto. REST lo usa para deserializar (unmarshal) el resultado de la consulta.

Nota

Este método ejecuta una llamada REST mediante GET.

También puede ejecutarlo directamente desde el navegador; tome la siguiente URL como ejemplo:

http://localhost:8080/OpenKM/services/rest/plugin/executeGetPlugin?className=com.openkm.plugin.rest.TestGetDocumentRestPlugin&param={"key":"docId","value":"/okm:root/invoices/00000001_001_of_001.pdf"}

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

            try
            {
                ws.login(user, password);
                Dictionary<String, String> parameters = new Dictionary<String, String>();
                parameters.Add("docId", "/okm:root/invoices/00000001_001_of_001.pdf");
                String res = (String) ws.plugin.executePluginGet("com.openkm.plugin.rest.TestRestPlugin", parameters, typeof(string));
                System.Console.WriteLine(res);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

executePluginGetReturnFile

Descripción:

Método	Valores de retorno	Descripción
executePluginGetReturnFile(String className, Dictionary<String, String> parameters)	InputStream	Devuelve el valor del objeto resultante de ejecutar una clase que implementa RestPlugin.

Consejo

• El valor “className” debe ser el nombre canónico de una clase que implemente la interfaz RestPlugin.
• El mapa “parameters” contiene los valores que usará la clase indicada en className.

Nota

Este método ejecuta una llamada REST mediante GET.

El RestPlugin debe devolver un objeto Response. Consulte el siguiente ejemplo de implementación de RestPlugin:

package com.openkm.plugin.rest;

import net.xeoh.plugins.base.annotations.PluginImplementation;

import java.io.InputStream;
import java.util.Map;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.io.InputStreamResource;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;

import com.openkm.bean.Document;
import com.openkm.module.db.DbDocumentModule;
import com.openkm.plugin.BasePlugin;
import com.openkm.util.PathUtils;

/**
* Sample rest plugin
*
* @author jllort
*/
@PluginImplementation
public class TestGetDocumentRestPlugin extends BasePlugin implements RestPlugin {

    private static Logger log = LoggerFactory.getLogger(TestGetDocumentRestPlugin.class);

    @Autowired
    private DbDocumentModule dbDocumentModule;

    @Autowired
    private PathUtils pathUtils;

    @Override
    public Object executePlugin(Map<String, String> parameters, InputStream is) throws Exception {
        log.debug("executePlugin({})", parameters);
        String docId = parameters.get("docId");
        boolean inline = parameters.containsKey("inline");
        Document doc = dbDocumentModule.getProperties(null, docId);
        String mimeType = doc.getMimeType();
        String fileName = pathUtils.getName(doc.getPath());
        InputStream isContent = dbDocumentModule.getContent(null, docId, false);

        HttpHeaders responseHeaders = new HttpHeaders();
        responseHeaders.add("Content-Type", mimeType);

        // inline true when you want to embedded the content into
        if (inline) {
            responseHeaders.add("Content-disposition", "inline; filename=\"" + fileName + "\"");
        } else {
            responseHeaders.add("Content-Disposition", "attachment; filename=\"" + fileName + "\"");
        }

        responseHeaders.setContentLength(doc.getActualVersion().getSize());
        InputStreamResource inputStreamResource = new InputStreamResource(isContent);
        log.debug("TestGetDocumentRestPlugin: [BINARY]");
        return new ResponseEntity<>(inputStreamResource, responseHeaders, HttpStatus.OK);
    }
}

También puede ejecutarlo directamente desde el navegador; use la siguiente URL como ejemplo:

http://localhost:8080/openkm/services/rest/plugin/executeGetPluginReturnFile?className=com.openkm.plugin.rest.TestGetDocumentRestPlugin&param={"key":"docId","value":"/okm:root/invoices/00000001_001_of_001.pdf"}

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

            try
            {
                ws.login(user, password);
                Dictionary<String, String> parameters = new Dictionary<String, String>();
                parameters.Add("docId", "/okm:root/test.pdf");
                Stream tmpFIle = ws.plugin.executePluginGetReturnFile("com.openkm.plugin.rest.TestGetDocumentRestPlugin", parameters);
                FileStream destFile = new FileStream(@"D:\Testing\pluging.pdf", FileMode.OpenOrCreate);
                tmpFIle.CopyTo(destFile);
                destFile.Close();
                tmpFIle.Close();
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}