com.openkm.api

Class OKMScripting

java.lang.Object

com.openkm.api.OKMScripting

All Implemented Interfaces:

ScriptingModule

public class OKMScripting
extends Object
implements ScriptingModule

Author:

pavila

Method Summary

Methods

Modifier and Type	Method and Description
static OKMScripting	getInstance()
String	getScript(String token, String nodePath) Get node script (document or folder).
void	removeScript(String token, String nodePath) Remove script from node.
void	setScript(String token, String nodePath, String code) Add script to node.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstance

public static OKMScripting getInstance()

setScript

public void setScript(String token,
             String nodePath,
             String code)
               throws PathNotFoundException,
                      AccessDeniedException,
                      RepositoryException,
                      DatabaseException

Description copied from interface: ScriptingModule

Add script to node.

Specified by:

setScript in interface ScriptingModule

nodePath - The complete path to the node.

code - Script BeanShell code.

Throws:

PathNotFoundException - If the node defined by nodePath do not exists.

AccessDeniedException - If the token authorization information is not valid.

RepositoryException - If there is any error accessing to the repository.

DatabaseException

removeScript

public void removeScript(String token,
                String nodePath)
                  throws PathNotFoundException,
                         AccessDeniedException,
                         RepositoryException,
                         DatabaseException

Description copied from interface: ScriptingModule

Remove script from node.

Specified by:

removeScript in interface ScriptingModule

nodePath - The complete path to the node.

Throws:

PathNotFoundException - If the node defined by nodePath do not exists.

AccessDeniedException - If the token authorization information is not valid.

RepositoryException - If there is any error accessing to the repository.

DatabaseException

getScript

public String getScript(String token,
               String nodePath)
                 throws PathNotFoundException,
                        AccessDeniedException,
                        RepositoryException,
                        DatabaseException

Description copied from interface: ScriptingModule

Get node script (document or folder).

Specified by:

getScript in interface ScriptingModule

nodePath - The complete path to the node.

Returns:

A hashmap with pairs of user / permissions.

Throws:

PathNotFoundException - If the node defined by nodePath do not exists.

AccessDeniedException - If the token authorization information is not valid.

RepositoryException - If there is any error accessing to the repository.

DatabaseException