Difference between revisions of "SDK for Java 2.2"
From OpenKM Documentation
(→Sample client using this JDK) |
(→Repository) |
||
(11 intermediate revisions by the same user not shown) | |||
Line 6: | Line 6: | ||
'''Available jar file''' | '''Available jar file''' | ||
− | * [http://maven.openkm.com/maven2/com/openkm/sdk4j/2. | + | * [http://maven.openkm.com/maven2/com/openkm/sdk4j/2.2/sdk4j-2.2.jar sdk4j-2.2.jar] |
'''Library dependences [[File:Sdk-lib-dependences.zip]]''' | '''Library dependences [[File:Sdk-lib-dependences.zip]]''' | ||
Line 122: | Line 122: | ||
* AppVersion | * AppVersion | ||
* CheckBox | * CheckBox | ||
+ | * ContentInfo | ||
* Document | * Document | ||
* DocumentList | * DocumentList | ||
Line 138: | Line 139: | ||
* LanguageList | * LanguageList | ||
* LockInfo | * LockInfo | ||
+ | * Mail | ||
+ | * MailList | ||
* Node | * Node | ||
* Note | * Note | ||
* NoteList | * NoteList | ||
* Option | * Option | ||
+ | * ProfileList.java | ||
+ | * ProfileSimple.java | ||
* PropertyGroup | * PropertyGroup | ||
* PropertyGroupList | * PropertyGroupList | ||
Line 152: | Line 157: | ||
* ResultSet | * ResultSet | ||
* RoleList | * RoleList | ||
+ | * SuggestionList | ||
* Select | * Select | ||
* Separator | * Separator | ||
Line 217: | Line 223: | ||
public void removeRole(String user, String role) throws PrincipalAdapterException, UnknowException, WebserviceException; | public void removeRole(String user, String role) throws PrincipalAdapterException, UnknowException, WebserviceException; | ||
+ | |||
+ | public List<ProfileSimple> getProfiles(boolean filterByActive) throws PrincipalAdapterException, WebserviceException, UnknowException; | ||
+ | |||
+ | public ProfileSimple getUserProfile(String userId) throws PrincipalAdapterException, WebserviceException, UnknowException; | ||
+ | |||
+ | public void setUserProfile(String userId, long profileId) throws PrincipalAdapterException, WebserviceException, UnknowException; | ||
</source> | </source> | ||
Line 301: | Line 313: | ||
RepositoryException, DatabaseException, ExtensionException, AutomationException, UnknowException, WebserviceException; | RepositoryException, DatabaseException, ExtensionException, AutomationException, UnknowException, WebserviceException; | ||
− | public void copyDocument(String docId, String dstId) throws ItemExistsException, PathNotFoundException, AccessDeniedException, | + | public void copyDocument(String docId, String dstId, String newName) throws ItemExistsException, PathNotFoundException, AccessDeniedException, |
RepositoryException, IOException, DatabaseException, UserQuotaExceededException, ExtensionException, AutomationException, | RepositoryException, IOException, DatabaseException, UserQuotaExceededException, ExtensionException, AutomationException, | ||
UnknowException, WebserviceException; | UnknowException, WebserviceException; | ||
Line 321: | Line 333: | ||
public List<String> getDetectedLanguages() throws RepositoryException, DatabaseException, UnknowException, WebserviceException; | public List<String> getDetectedLanguages() throws RepositoryException, DatabaseException, UnknowException, WebserviceException; | ||
+ | |||
+ | public void extendedDocumentCopy(String docId, String dstId, String name, boolean categories, boolean keywords, boolean propertyGroups, | ||
+ | boolean notes, boolean wiki) throws ItemExistsException, PathNotFoundException, AccessDeniedException, RepositoryException, | ||
+ | IOException, DatabaseException, UserQuotaExceededException, AutomationException, UnknowException, WebserviceException; | ||
+ | |||
+ | public String getExtractedText(String docId) throws RepositoryException, PathNotFoundException, IOException, DatabaseException, | ||
+ | UnknowException, WebserviceException; | ||
+ | |||
+ | public InputStream getThumbnail(String docId, ThumbnailType type) throws PathNotFoundException, AccessDeniedException, | ||
+ | ConversionException, AutomationException, RepositoryException, DatabaseException, IOException, UnknowException, | ||
+ | WebserviceException; | ||
+ | |||
+ | public void setLanguage(String docId, String lang) throws VersionException, LockException, PathNotFoundException, | ||
+ | AccessDeniedException, RepositoryException, DatabaseException, UnknowException, WebserviceException; | ||
+ | |||
+ | public void setTitle(String docId, String title) throws VersionException, LockException, PathNotFoundException, AccessDeniedException, | ||
+ | RepositoryException, DatabaseException, UnknowException, WebserviceException; | ||
+ | |||
+ | public Document createFromTemplate(String docId, String dstId, String language, boolean categories, boolean keywords, | ||
+ | boolean propertyGroups, boolean notes, boolean wiki, Map<String, String> properties) throws PathNotFoundException, | ||
+ | AccessDeniedException, RepositoryException, IOException, DatabaseException, DocumentException, TemplateException, | ||
+ | DocumentTemplateException, ConversionException, UnsupportedMimeTypeException, FileSizeExceededException, | ||
+ | UserQuotaExceededException, VirusDetectedException, ItemExistsException, AutomationException, ParseException, | ||
+ | NoSuchGroupException, NoSuchPropertyException, LockException, UnknowException, WebserviceException; | ||
+ | |||
+ | public Document updateFromTemplate(String docId, String dstId, Map<String, String> properties) throws DocumentException, | ||
+ | TemplateException, DocumentTemplateException, ConversionException, FileSizeExceededException, UserQuotaExceededException, | ||
+ | VirusDetectedException, LockException, VersionException, PathNotFoundException, ParseException, AccessDeniedException, | ||
+ | RepositoryException, IOException, DatabaseException, AutomationException, NoSuchGroupException, NoSuchPropertyException, | ||
+ | UnknowException, WebserviceException; | ||
</source> | </source> | ||
Line 343: | Line 385: | ||
RepositoryException, DatabaseException, UnknowException, WebserviceException; | RepositoryException, DatabaseException, UnknowException, WebserviceException; | ||
− | public List<Folder> getFolderChildren(String fldId) throws PathNotFoundException, RepositoryException, DatabaseException, UnknowException, | + | public List<Folder> getFolderChildren(String fldId) throws PathNotFoundException, RepositoryException, DatabaseException, |
− | + | UnknowException, WebserviceException; | |
public boolean isValidFolder(String fldId) throws PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, | public boolean isValidFolder(String fldId) throws PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, | ||
Line 351: | Line 393: | ||
public String getFolderPath(String uuid) throws AccessDeniedException, RepositoryException, DatabaseException, UnknowException, | public String getFolderPath(String uuid) throws AccessDeniedException, RepositoryException, DatabaseException, UnknowException, | ||
WebserviceException; | WebserviceException; | ||
+ | |||
+ | public void copyFolder(String fldId, String dstId, String newName) throws PathNotFoundException, ItemExistsException, AccessDeniedException, | ||
+ | RepositoryException, IOException, AutomationException, DatabaseException, UserQuotaExceededException, | ||
+ | UnknowException, WebserviceException; | ||
+ | |||
+ | public void extendedFolderCopy(String fldId, String dstId, boolean categories, boolean keywords, boolean propertyGroups, boolean notes, | ||
+ | boolean wiki) throws ItemExistsException, PathNotFoundException, AccessDeniedException, RepositoryException, IOException, | ||
+ | DatabaseException, UserQuotaExceededException, AutomationException, UnknowException, | ||
+ | WebserviceException; | ||
+ | |||
+ | public ContentInfo getContentInfo(String fldId) throws AccessDeniedException, RepositoryException, PathNotFoundException, | ||
+ | DatabaseException, UnknowException, WebserviceException; | ||
+ | |||
+ | public void purgeFolder(String fldId) throws LockException, PathNotFoundException, AccessDeniedException, RepositoryException, | ||
+ | DatabaseException, UnknowException, WebserviceException; | ||
+ | |||
+ | public void setStyle(String fldId, long styleId) throws VersionException, PathNotFoundException, AccessDeniedException, | ||
+ | RepositoryException, DatabaseException, UnknowException, WebserviceException; | ||
+ | |||
+ | public void extendedFolderCopy(String fldId, String dstId, boolean categories, boolean keywords, boolean propertyGroups, boolean notes, | ||
+ | boolean wiki) throws ItemExistsException, PathNotFoundException, AccessDeniedException, RepositoryException, IOException, | ||
+ | DatabaseException, UserQuotaExceededException, AutomationException, UnknowException, | ||
+ | WebserviceException; | ||
+ | |||
+ | public ContentInfo getContentInfo(String fldId) throws AccessDeniedException, RepositoryException, PathNotFoundException, | ||
+ | DatabaseException, UnknowException, WebserviceException; | ||
+ | |||
+ | public void purgeFolder(String fldId) throws LockException, PathNotFoundException, AccessDeniedException, RepositoryException, | ||
+ | DatabaseException, UnknowException, WebserviceException; | ||
</source> | </source> | ||
Line 412: | Line 483: | ||
public void registerDefinition(String pgDef) throws ParseException, DatabaseException, IOException, UnknowException, | public void registerDefinition(String pgDef) throws ParseException, DatabaseException, IOException, UnknowException, | ||
WebserviceException; | WebserviceException; | ||
+ | |||
+ | public Map<String, String> getPropertyGroupPropertiesSimple(String nodeId, String grpName) throws IOException, | ||
+ | ParseException, NoSuchPropertyException, NoSuchGroupException, LockException, PathNotFoundException, | ||
+ | AccessDeniedException, RepositoryException, DatabaseException, ExtensionException, AutomationException, | ||
+ | UnknowException, WebserviceException; | ||
</source> | </source> | ||
Line 453: | Line 529: | ||
public AppVersion getAppVersion() throws RepositoryException, DatabaseException, UnknowException, WebserviceException; | public AppVersion getAppVersion() throws RepositoryException, DatabaseException, UnknowException, WebserviceException; | ||
+ | |||
+ | public void copyAttributes(String nodeId, String dstId, boolean categories, boolean keywords, boolean propertyGroups, boolean notes, | ||
+ | boolean wiki) throws ItemExistsException, PathNotFoundException, AccessDeniedException, RepositoryException, IOException, | ||
+ | DatabaseException, UserQuotaExceededException, AutomationException, UnknowException, | ||
+ | WebserviceException; | ||
</source> | </source> | ||
Line 521: | Line 602: | ||
public void setSigned(String nodeId, boolean signed) throws VersionException, LockException, PathNotFoundException, | public void setSigned(String nodeId, boolean signed) throws VersionException, LockException, PathNotFoundException, | ||
AccessDeniedException, RepositoryException, DatabaseException, UnknowException, WebserviceException; | AccessDeniedException, RepositoryException, DatabaseException, UnknowException, WebserviceException; | ||
+ | </source> | ||
+ | |||
+ | === Mail === | ||
+ | <source lang="java"> | ||
+ | public Mail createMail(Mail mail) throws PathNotFoundException, ItemExistsException, VirusDetectedException, AccessDeniedException, | ||
+ | RepositoryException, DatabaseException, UserQuotaExceededException, AutomationException, UnknowException, WebserviceException; | ||
+ | |||
+ | public Mail getMailProperties(String mailId) throws AccessDeniedException, RepositoryException, PathNotFoundException, | ||
+ | DatabaseException, UnknowException, WebserviceException; | ||
+ | |||
+ | public void deleteMail(String mailId) throws LockException, PathNotFoundException, AccessDeniedException, RepositoryException, | ||
+ | DatabaseException, UnknowException, WebserviceException; | ||
+ | |||
+ | public void purgeMail(String mailId) throws LockException, PathNotFoundException, AccessDeniedException, RepositoryException, | ||
+ | DatabaseException, UnknowException, WebserviceException; | ||
+ | |||
+ | public void renameMail(String mailId, String newName) throws PathNotFoundException, ItemExistsException, AccessDeniedException, | ||
+ | RepositoryException, DatabaseException, UnknowException, WebserviceException; | ||
+ | |||
+ | public void moveMail(String mailId, String dstId) throws PathNotFoundException, ItemExistsException, AccessDeniedException, | ||
+ | RepositoryException, DatabaseException, UnknowException, WebserviceException; | ||
+ | |||
+ | public void copyMail(String mailId, String dstId, String newName) throws PathNotFoundException, ItemExistsException, AccessDeniedException, | ||
+ | RepositoryException, IOException, AutomationException, DatabaseException, UserQuotaExceededException, UnknowException, | ||
+ | WebserviceException; | ||
+ | |||
+ | public void extendedMailCopy(String mailId, String dstId, boolean categories, boolean keywords, boolean propertyGroups, boolean notes, | ||
+ | boolean wiki) throws ItemExistsException, PathNotFoundException, AccessDeniedException, RepositoryException, IOException, | ||
+ | DatabaseException, UserQuotaExceededException, AutomationException, UnknowException, WebserviceException; | ||
+ | |||
+ | public List<Mail> getMailChildren(String fldId) throws PathNotFoundException, RepositoryException, DatabaseException, UnknowException, | ||
+ | WebserviceException; | ||
+ | |||
+ | public boolean isValidMail(String mailId) throws PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, | ||
+ | UnknowException, WebserviceException; | ||
+ | |||
+ | public String getMailPath(String uuid) throws AccessDeniedException, RepositoryException, DatabaseException, UnknowException, | ||
+ | WebserviceException; | ||
+ | |||
+ | public Document createAttachment(String mailId, String docName, InputStream is) throws IOException, UnsupportedMimeTypeException, | ||
+ | FileSizeExceededException, UserQuotaExceededException, VirusDetectedException, ItemExistsException, PathNotFoundException, | ||
+ | AccessDeniedException, RepositoryException, DatabaseException, ExtensionException, AutomationException, UnknowException, | ||
+ | WebserviceException; | ||
+ | |||
+ | public void deleteAttachment(String mailId, String docId) throws LockException, PathNotFoundException, AccessDeniedException, | ||
+ | RepositoryException, DatabaseException, UnknowException, WebserviceException; | ||
+ | |||
+ | public List<Document> getAttachments(String mailId) throws RepositoryException, PathNotFoundException, DatabaseException, | ||
+ | UnknowException, WebserviceException; | ||
+ | |||
+ | public void sendMailWithAttachments(List<String> recipients, String subject, String body, List<String> docsId, String dstId) | ||
+ | throws AccessDeniedException, PathNotFoundException, ItemExistsException, AutomationException, VirusDetectedException, | ||
+ | UserQuotaExceededException, UnsupportedMimeTypeException, FileSizeExceededException, RepositoryException, DatabaseException, | ||
+ | IOException, UnknowException, WebserviceException; | ||
+ | </source> | ||
+ | |||
+ | === Record === | ||
+ | <source lang="java"> | ||
+ | public Record createRecord(Record record) throws AccessDeniedException, RepositoryException, PathNotFoundException, | ||
+ | ItemExistsException, DatabaseException, ExtensionException, AutomationException, UnknowException, WebserviceException; | ||
+ | |||
+ | public Record getRecordProperties(String recId) throws AccessDeniedException, RepositoryException, PathNotFoundException, | ||
+ | DatabaseException, UnknowException, WebserviceException; | ||
+ | |||
+ | public void deleteRecord(String recId) throws LockException, PathNotFoundException, AccessDeniedException, RepositoryException, | ||
+ | DatabaseException, UnknowException, WebserviceException; | ||
+ | |||
+ | public void purgeRecord(String recId) throws LockException, AccessDeniedException, RepositoryException, PathNotFoundException, | ||
+ | DatabaseException, ExtensionException, UnknowException, WebserviceException; | ||
+ | |||
+ | public void renameRecord(String recId, String newName) throws AccessDeniedException, RepositoryException, PathNotFoundException, | ||
+ | ItemExistsException, LockException, DatabaseException, ExtensionException, LockException, UnknowException, WebserviceException; | ||
+ | |||
+ | public void moveRecord(String recId, String dstId) throws LockException, PathNotFoundException, ItemExistsException, | ||
+ | AccessDeniedException, RepositoryException, DatabaseException, ExtensionException, AutomationException, LockException, | ||
+ | UnknowException, WebserviceException; | ||
+ | |||
+ | public void copyRecord(String recId, String dstId, String newName) throws ItemExistsException, PathNotFoundException, AccessDeniedException, | ||
+ | RepositoryException, IOException, DatabaseException, UserQuotaExceededException, ExtensionException, AutomationException, | ||
+ | UnknowException, WebserviceException; | ||
+ | |||
+ | public boolean isValidRecord(String recId) throws PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, | ||
+ | UnknowException, WebserviceException; | ||
+ | |||
+ | public List<Record> getRecordChildren(String recId) throws RepositoryException, PathNotFoundException, DatabaseException, | ||
+ | UnknowException, WebserviceException; | ||
+ | |||
+ | public LockInfo lockRecord(String recId) throws LockException, PathNotFoundException, AccessDeniedException, RepositoryException, | ||
+ | DatabaseException, UnknowException, WebserviceException; | ||
+ | |||
+ | public void unlockRecord(String recId) throws LockException, PathNotFoundException, AccessDeniedException, RepositoryException, | ||
+ | DatabaseException, UnknowException, WebserviceException; | ||
+ | |||
+ | public void forceUnlockRecord(String recId) throws LockException, PathNotFoundException, AccessDeniedException, RepositoryException, | ||
+ | DatabaseException, PrincipalAdapterException, UnknowException, WebserviceException; | ||
+ | |||
+ | public void setRecordTitle(String recId, String title) throws VersionException, LockException, PathNotFoundException, | ||
+ | AccessDeniedException, RepositoryException, DatabaseException, UnknowException, | ||
+ | WebserviceException; | ||
+ | |||
+ | public String getRecordPath(String uuid) throws AccessDeniedException, RepositoryException, DatabaseException, UnknowException, | ||
+ | WebserviceException; | ||
+ | </source> | ||
+ | |||
+ | === Relation === | ||
+ | <source lang="java"> | ||
+ | public RelationTypeList getRelationTypes(String type) throws AccessDeniedException, DatabaseException, UnknowException, | ||
+ | WebserviceException; | ||
+ | |||
+ | public void addRelation(String nodeAId, String nodeBId, long relTypeId) throws LockException, PathNotFoundException, | ||
+ | AccessDeniedException, RepositoryException, DatabaseException, UnknowException, WebserviceException; | ||
+ | |||
+ | public void deleteRelation(long relationId) throws LockException, PathNotFoundException, AccessDeniedException, | ||
+ | RepositoryException, DatabaseException, UnknowException, WebserviceException; | ||
+ | |||
+ | public RelationList getRelations(String nodeId) throws PathNotFoundException, RepositoryException, DatabaseException, | ||
+ | UnknowException, WebserviceException; | ||
+ | |||
+ | public RelationGroupList getRelationGroups(String nodeId) throws AccessDeniedException, DatabaseException, UnknowException, | ||
+ | WebserviceException; | ||
+ | |||
+ | public void addRelationGroup(String nodeId, String groupName, long type) throws AccessDeniedException, PathNotFoundException, | ||
+ | DatabaseException, UnknowException, WebserviceException; | ||
+ | |||
+ | public void addNodeToGroup(String nodeId, long groupId) throws AccessDeniedException, PathNotFoundException, | ||
+ | DatabaseException, RepositoryException, UnknowException, WebserviceException; | ||
+ | |||
+ | public void deleteRelationGroup(String nodeId, long groupId) throws AccessDeniedException, DatabaseException, | ||
+ | PathNotFoundException, RepositoryException, UnknowException, WebserviceException; | ||
+ | |||
+ | public RelationGroup findRelationGroup(long groupId) throws AccessDeniedException, PathNotFoundException, DatabaseException, | ||
+ | RepositoryException, UnknowException, WebserviceException; | ||
+ | |||
+ | public void setRelationGroupName(long groupId, String groupName) throws AccessDeniedException, DatabaseException, UnknowException, | ||
+ | WebserviceException; | ||
+ | </source> | ||
+ | |||
+ | === Workflow === | ||
+ | <source lang="java"> | ||
+ | public void registerProcessDefinition(InputStream is) throws ParseException, RepositoryException, DatabaseException, | ||
+ | WorkflowException, IOException, UnknowException, WebserviceException; | ||
+ | |||
+ | public void deleteProcessDefinition(long pdId) throws RepositoryException, DatabaseException, WorkflowException, | ||
+ | UnknowException, WebserviceException; | ||
+ | |||
+ | public ProcessDefinition getProcessDefinition(long pdId) throws RepositoryException, DatabaseException, WorkflowException, | ||
+ | UnknowException, WebserviceException; | ||
+ | |||
+ | public ProcessInstance runProcessDefinition(long pdId, String uuid, FormElementComplexList values) | ||
+ | throws WorkflowException, AccessDeniedException, RepositoryException, DatabaseException, UnknowException, | ||
+ | WebserviceException; | ||
+ | |||
+ | public List<ProcessInstance> findProcessInstances(long pdId) throws RepositoryException, DatabaseException, | ||
+ | WorkflowException, UnknowException, WebserviceException; | ||
+ | |||
+ | public List<ProcessDefinition> findAllProcessDefinitions() throws RepositoryException, DatabaseException, WorkflowException, | ||
+ | UnknowException, WebserviceException; | ||
+ | |||
+ | public List<ProcessDefinition> findLatestProcessDefinitions() throws RepositoryException, DatabaseException, | ||
+ | WorkflowException, UnknowException, WebserviceException; | ||
+ | |||
+ | public ProcessDefinition findLastProcessDefinition(String name) throws RepositoryException, DatabaseException, | ||
+ | WorkflowException, UnknowException, WebserviceException; | ||
+ | |||
+ | public ProcessInstance getProcessInstance(long piId) throws RepositoryException, DatabaseException, WorkflowException, | ||
+ | UnknowException, WebserviceException; | ||
+ | |||
+ | public List<TaskInstance> findUserTaskInstances() throws RepositoryException, DatabaseException, WorkflowException, | ||
+ | UnknowException, WebserviceException; | ||
+ | |||
+ | public List<TaskInstance> findTaskInstances(long piId) throws RepositoryException, DatabaseException, WorkflowException, | ||
+ | UnknowException, WebserviceException; | ||
+ | |||
+ | public void setTaskInstanceValues(long tiId, String transName, FormElementComplexList values) throws RepositoryException, | ||
+ | DatabaseException, WorkflowException, UnknowException, WebserviceException; | ||
+ | |||
+ | public TaskInstance getTaskInstance(long tiId) throws RepositoryException, DatabaseException, WorkflowException, | ||
+ | UnknowException, WebserviceException; | ||
+ | |||
+ | public void startTaskInstance(long tiId) throws RepositoryException, DatabaseException, WorkflowException, UnknowException, | ||
+ | WebserviceException; | ||
+ | |||
+ | public void setTaskInstanceActorId(long tiId, String actorId) throws RepositoryException, DatabaseException, | ||
+ | WorkflowException, UnknowException, WebserviceException; | ||
+ | |||
+ | public void endTaskInstance(long tiId, String transName) throws RepositoryException, DatabaseException, WorkflowException, | ||
+ | UnknowException, WebserviceException; | ||
</source> | </source> | ||
[[Category: Extension Guide]] | [[Category: Extension Guide]] |
Latest revision as of 13:20, 26 November 2014
If you want to collaborate extending features or add newer contact with us at contact website form indicating this URL. |
OpenKM SDK for Java is a set of software developement tools that allows for the creation of applications for OpenKM. The OpenKM SDK for Java include a webservices library. This webservices library is a complete API layer to access OpenKM through webservices and provides complete compatibility between OpenKM webservices versions without change code.
Available jar file
Library dependences File:Sdk-lib-dependences.zip
catch-exception-1.2.0.jar commons-beanutils-1.8.3.jar commons-io-1.3.2.jar commons-lang-2.5.jar commons-logging-1.1.1.jar dozer-5.3.2.jar hamcrest-core-1.3.jar jersey-client-1.17.1.jar jersey-core-1.17.1.jar jersey-multipart-1.17.1.jar mimepull-1.6.jar mockito-core-1.9.5.jar objenesis-1.0.jar slf4j-api-1.7.2.jar
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:
<?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>sample</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>2.2</version>
</dependency>
</dependencies>
</project>
In this class you can see how to call an API method to request all folder children from "/okm:root":
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(url, user, pass);
for (Folder fld : okm.getFolderChildren("/okm:root")) {
System.out.println("Fodler -> " + fld.getPath());
}
}
Example
String host = "http://localhost:8080/OpenKM";
String user = "okmAdmin";
String password = "admin";
OKMWebservices ws= OKMWebservicesFactory.newInstance(host, user, password);
try {
System.out.println(ws.getName("okmAdmin"));
System.out.println(ws.getRoles());
System.out.println(ws.getRolesByUser("okmAdmin"));
System.out.println(ws.getGrantedRoles("/okm:root"));
System.out.println(ws.getGrantedUsers("/okm:root"));
System.out.println(ws.getMail("okmAdmin"));
System.out.println(ws.getName("okmAdmin"));
System.out.println(ws.getUsers());
System.out.println(ws.getUsersByRole("ROLE_ADMIN"));
ws.revokeRole("/okm:root", "ROLE_ADMIN", Permission.ALL_GRANTS, false);
ws.revokeUser("/okm:root", "okmAdmin", Permission.ALL_GRANTS, false);
ws.grantRole("/okm:root", "ROLE_ADMIN", Permission.ALL_GRANTS, false);
ws.grantUser("/okm:root", "okmAdmin", Permission.ALL_GRANTS, false);
} catch (DatabaseException e) {
e.printStackTrace();
} catch (RepositoryException e) {
e.printStackTrace();
} catch (PrincipalAdapterException e) {
e.printStackTrace();
} catch (AccessDeniedException e) {
e.printStackTrace();
} catch (WebserviceException e) {
e.printStackTrace();
} catch (PathNotFoundException e) {
e.printStackTrace();
} catch (UnknowException e) {
e.printStackTrace();
}
Description
Classes
- AppVersion
- CheckBox
- ContentInfo
- Document
- DocumentList
- Folder
- FolderList
- FormElement
- FormElementComplex
- FormElementComplexList
- GrantedRole
- GrantedRoleList
- GrantedUser
- GrantedUserList
- Input
- KeywordMap
- KeywordMapList
- LanguageList
- LockInfo
- MailList
- Node
- Note
- NoteList
- Option
- ProfileList.java
- ProfileSimple.java
- PropertyGroup
- PropertyGroupList
- ProposedQueryReceived
- ProposedQuerySent
- QueryParamsList
- QueryResult
- QueryResultList
- QueryParams
- ResultSet
- RoleList
- SuggestionList
- Select
- Separator
- SimplePropertyGroup
- SuggestBox
- TextArea
- UserList
- Validator
- Version
- VersionList
Auth
public Map<String, Integer> getGrantedRoles(String nodeId) throws AccessDeniedException, RepositoryException, DatabaseException,
PathNotFoundException, UnknowException, WebserviceException;
public Map<String, Integer> getGrantedUsers(String nodeId) throws AccessDeniedException, RepositoryException, DatabaseException,
PathNotFoundException, UnknowException, WebserviceException;
public String getMail(String user) throws PrincipalAdapterException, AccessDeniedException, RepositoryException, DatabaseException,
UnknowException, WebserviceException;
public String getName(String user) throws DatabaseException, RepositoryException, PrincipalAdapterException, AccessDeniedException,
UnknowException, WebserviceException;
public List<String> getRoles() throws AccessDeniedException, RepositoryException, DatabaseException, PrincipalAdapterException,
UnknowException, WebserviceException;
public List<String> getRolesByUser(String user) throws AccessDeniedException, RepositoryException, DatabaseException,
PrincipalAdapterException, UnknowException, WebserviceException;
public List<String> getUsers() throws AccessDeniedException, RepositoryException, DatabaseException, PrincipalAdapterException,
UnknowException, WebserviceException;
public List<String> getUsersByRole(String role) throws AccessDeniedException, RepositoryException, DatabaseException,
PrincipalAdapterException, UnknowException, WebserviceException;
public void revokeRole(String nodeId, String role, int permissions, boolean recursive) throws AccessDeniedException,
RepositoryException, DatabaseException, PathNotFoundException, UnknowException, WebserviceException;
public void revokeUser(String nodeId, String user, int permissions, boolean recursive) throws AccessDeniedException,
RepositoryException, DatabaseException, PathNotFoundException, UnknowException, WebserviceException;
public void grantRole(String nodeId, String role, int permissions, boolean recursive) throws AccessDeniedException,
RepositoryException, DatabaseException, PathNotFoundException, UnknowException, WebserviceException;
public void grantUser(String nodeId, String role, int permissions, boolean recursive) throws AccessDeniedException,
RepositoryException, DatabaseException, PathNotFoundException, UnknowException, WebserviceException;
public void createUser(String user, String password, String email, String name, boolean active) throws PrincipalAdapterException,
UnknowException, WebserviceException;
public void deleteUser(String user) throws PrincipalAdapterException, UnknowException, WebserviceException;
public void updateUser(String user, String password, String email, String name, boolean active) throws PrincipalAdapterException,
UnknowException, WebserviceException;
public void createRole(String role, boolean active) throws PrincipalAdapterException, UnknowException, WebserviceException;
public void deleteRole(String role) throws PrincipalAdapterException, UnknowException, WebserviceException;
public void updateRole(String role, boolean active) throws PrincipalAdapterException, UnknowException, WebserviceException;
public void assignRole(String user, String role) throws PrincipalAdapterException, UnknowException, WebserviceException;
public void removeRole(String user, String role) throws PrincipalAdapterException, UnknowException, WebserviceException;
public List<ProfileSimple> getProfiles(boolean filterByActive) throws PrincipalAdapterException, WebserviceException, UnknowException;
public ProfileSimple getUserProfile(String userId) throws PrincipalAdapterException, WebserviceException, UnknowException;
public void setUserProfile(String userId, long profileId) throws PrincipalAdapterException, WebserviceException, UnknowException;
Document
public Document createDocument(Document okmDocument, InputStream is) throws IOException, UnsupportedMimeTypeException,
FileSizeExceededException, UserQuotaExceededException, VirusDetectedException, ItemExistsException, PathNotFoundException,
AccessDeniedException, RepositoryException, DatabaseException, ExtensionException, AutomationException, UnknowException,
WebserviceException;
public Document createDocumentSimple(String docPath, InputStream is) throws IOException, UnsupportedMimeTypeException,
FileSizeExceededException, UserQuotaExceededException, VirusDetectedException, ItemExistsException, PathNotFoundException,
AccessDeniedException, RepositoryException, DatabaseException, ExtensionException, AutomationException, UnknowException,
WebserviceException;
public void deleteDocument(String docId) throws AccessDeniedException, RepositoryException, PathNotFoundException, LockException,
DatabaseException, ExtensionException, UnknowException, WebserviceException;
public Document getDocumentProperties(String docId) throws RepositoryException, PathNotFoundException, DatabaseException, UnknowException,
WebserviceException;
public InputStream getContent(String docId) throws RepositoryException, IOException, PathNotFoundException, AccessDeniedException,
DatabaseException, UnknowException, WebserviceException;
public InputStream getContentByVersion(String docId, String versionId) throws RepositoryException, IOException, PathNotFoundException,
AccessDeniedException, DatabaseException, UnknowException, WebserviceException;
public List<Document> getDocumentChildren(String fldId) throws RepositoryException, PathNotFoundException, DatabaseException,
UnknowException, WebserviceException;
public void renameDocument(String docId, String newName) throws AccessDeniedException, RepositoryException, PathNotFoundException,
ItemExistsException, LockException, DatabaseException, ExtensionException, UnknowException, WebserviceException;
public void setProperties(Document okmDocument) throws AccessDeniedException, RepositoryException, PathNotFoundException,
VersionException, LockException, DatabaseException, UnknowException, WebserviceException;
public void setLanguage(String docId, String lang) throws VersionException, LockException, PathNotFoundException,
AccessDeniedException, RepositoryException, DatabaseException, UnknowException, WebserviceException;
public void setTitle(String docId, String title) throws VersionException, LockException, PathNotFoundException, AccessDeniedException,
RepositoryException, DatabaseException, UnknowException, WebserviceException;
public void setDocumentNodeClass(String docId, long ncId) throws VersionException, LockException, PathNotFoundException, AccessDeniedException,
RepositoryException, DatabaseException, UnknowException, WebserviceException;
public void checkout(String docId) throws AccessDeniedException, RepositoryException, PathNotFoundException, LockException,
DatabaseException, UnknowException, WebserviceException;
public void cancelCheckout(String docId) throws AccessDeniedException, RepositoryException, PathNotFoundException, LockException,
DatabaseException, UnknowException, WebserviceException;
public void forceCancelCheckout(String docId) throws AccessDeniedException, RepositoryException, PathNotFoundException, LockException,
DatabaseException, PrincipalAdapterException, UnknowException, WebserviceException;
public boolean isCheckedOut(String docId) throws PathNotFoundException, RepositoryException, DatabaseException, UnknowException,
WebserviceException;
public Version checkin(String docId, InputStream is, String comment) throws FileSizeExceededException, UserQuotaExceededException,
VirusDetectedException, LockException, VersionException, PathNotFoundException, AccessDeniedException, RepositoryException,
IOException, DatabaseException, ExtensionException, UnknowException, WebserviceException;
public List<Version> getVersionHistory(String docId) throws PathNotFoundException, RepositoryException, DatabaseException,
UnknowException, WebserviceException;
public LockInfo lock(String docId) throws LockException, PathNotFoundException, AccessDeniedException, RepositoryException,
DatabaseException, UnknowException, WebserviceException;
public void unlock(String docId) throws LockException, PathNotFoundException, AccessDeniedException, RepositoryException,
DatabaseException, UnknowException, WebserviceException;
public void forceUnlock(String docId) throws LockException, PathNotFoundException, AccessDeniedException, RepositoryException,
DatabaseException, PrincipalAdapterException, UnknowException, WebserviceException;
public boolean isLocked(String docId) throws RepositoryException, PathNotFoundException, DatabaseException, UnknowException,
WebserviceException;
public LockInfo getLockInfo(String docId) throws RepositoryException, PathNotFoundException, LockException, DatabaseException,
UnknowException, WebserviceException;
public void purgeDocument(String docId) throws LockException, AccessDeniedException, RepositoryException, PathNotFoundException,
DatabaseException, ExtensionException, UnknowException, WebserviceException;
public void moveDocument(String docId, String dstId) throws LockException, PathNotFoundException, ItemExistsException, AccessDeniedException,
RepositoryException, DatabaseException, ExtensionException, AutomationException, UnknowException, WebserviceException;
public void copyDocument(String docId, String dstId, String newName) throws ItemExistsException, PathNotFoundException, AccessDeniedException,
RepositoryException, IOException, DatabaseException, UserQuotaExceededException, ExtensionException, AutomationException,
UnknowException, WebserviceException;
public void restoreVersion(String docId, String versionId) throws AccessDeniedException, PathNotFoundException, LockException,
RepositoryException, DatabaseException, ExtensionException, UnknowException, WebserviceException;
public void purgeVersionHistory(String docId) throws AccessDeniedException, PathNotFoundException, LockException, RepositoryException,
DatabaseException, UnknowException, WebserviceException;
public long getVersionHistorySize(String docId) throws RepositoryException, PathNotFoundException, DatabaseException, UnknowException,
WebserviceException;
public boolean isValidDocument(String docId) throws PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException,
UnknowException, WebserviceException;
public String getDocumentPath(String uuid) throws AccessDeniedException, RepositoryException, DatabaseException, UnknowException,
WebserviceException;
public List<String> getDetectedLanguages() throws RepositoryException, DatabaseException, UnknowException, WebserviceException;
public void extendedDocumentCopy(String docId, String dstId, String name, boolean categories, boolean keywords, boolean propertyGroups,
boolean notes, boolean wiki) throws ItemExistsException, PathNotFoundException, AccessDeniedException, RepositoryException,
IOException, DatabaseException, UserQuotaExceededException, AutomationException, UnknowException, WebserviceException;
public String getExtractedText(String docId) throws RepositoryException, PathNotFoundException, IOException, DatabaseException,
UnknowException, WebserviceException;
public InputStream getThumbnail(String docId, ThumbnailType type) throws PathNotFoundException, AccessDeniedException,
ConversionException, AutomationException, RepositoryException, DatabaseException, IOException, UnknowException,
WebserviceException;
public void setLanguage(String docId, String lang) throws VersionException, LockException, PathNotFoundException,
AccessDeniedException, RepositoryException, DatabaseException, UnknowException, WebserviceException;
public void setTitle(String docId, String title) throws VersionException, LockException, PathNotFoundException, AccessDeniedException,
RepositoryException, DatabaseException, UnknowException, WebserviceException;
public Document createFromTemplate(String docId, String dstId, String language, boolean categories, boolean keywords,
boolean propertyGroups, boolean notes, boolean wiki, Map<String, String> properties) throws PathNotFoundException,
AccessDeniedException, RepositoryException, IOException, DatabaseException, DocumentException, TemplateException,
DocumentTemplateException, ConversionException, UnsupportedMimeTypeException, FileSizeExceededException,
UserQuotaExceededException, VirusDetectedException, ItemExistsException, AutomationException, ParseException,
NoSuchGroupException, NoSuchPropertyException, LockException, UnknowException, WebserviceException;
public Document updateFromTemplate(String docId, String dstId, Map<String, String> properties) throws DocumentException,
TemplateException, DocumentTemplateException, ConversionException, FileSizeExceededException, UserQuotaExceededException,
VirusDetectedException, LockException, VersionException, PathNotFoundException, ParseException, AccessDeniedException,
RepositoryException, IOException, DatabaseException, AutomationException, NoSuchGroupException, NoSuchPropertyException,
UnknowException, WebserviceException;
Folder
public Folder createFolder(Folder okmFolder) throws AccessDeniedException, RepositoryException, PathNotFoundException,
ItemExistsException, DatabaseException, ExtensionException, AutomationException, UnknowException, WebserviceException;
public Folder createFolderSimple(String fldPath) throws AccessDeniedException, RepositoryException, PathNotFoundException,
ItemExistsException, DatabaseException, ExtensionException, AutomationException, UnknowException, WebserviceException;
public Folder getFolderProperties(String fldId) throws AccessDeniedException, RepositoryException, PathNotFoundException,
DatabaseException, UnknowException, WebserviceException;
public void deleteFolder(String fldId) throws LockException, PathNotFoundException, AccessDeniedException, RepositoryException,
DatabaseException, UnknowException, WebserviceException;
public void renameFolder(String fldId, String newName) throws PathNotFoundException, ItemExistsException, AccessDeniedException,
RepositoryException, DatabaseException, UnknowException, WebserviceException;
public void moveFolder(String fldId, String dstId) throws PathNotFoundException, ItemExistsException, AccessDeniedException,
RepositoryException, DatabaseException, UnknowException, WebserviceException;
public List<Folder> getFolderChildren(String fldId) throws PathNotFoundException, RepositoryException, DatabaseException,
UnknowException, WebserviceException;
public boolean isValidFolder(String fldId) throws PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException,
UnknowException, WebserviceException;
public String getFolderPath(String uuid) throws AccessDeniedException, RepositoryException, DatabaseException, UnknowException,
WebserviceException;
public void copyFolder(String fldId, String dstId, String newName) throws PathNotFoundException, ItemExistsException, AccessDeniedException,
RepositoryException, IOException, AutomationException, DatabaseException, UserQuotaExceededException,
UnknowException, WebserviceException;
public void extendedFolderCopy(String fldId, String dstId, boolean categories, boolean keywords, boolean propertyGroups, boolean notes,
boolean wiki) throws ItemExistsException, PathNotFoundException, AccessDeniedException, RepositoryException, IOException,
DatabaseException, UserQuotaExceededException, AutomationException, UnknowException,
WebserviceException;
public ContentInfo getContentInfo(String fldId) throws AccessDeniedException, RepositoryException, PathNotFoundException,
DatabaseException, UnknowException, WebserviceException;
public void purgeFolder(String fldId) throws LockException, PathNotFoundException, AccessDeniedException, RepositoryException,
DatabaseException, UnknowException, WebserviceException;
public void setStyle(String fldId, long styleId) throws VersionException, PathNotFoundException, AccessDeniedException,
RepositoryException, DatabaseException, UnknowException, WebserviceException;
public void extendedFolderCopy(String fldId, String dstId, boolean categories, boolean keywords, boolean propertyGroups, boolean notes,
boolean wiki) throws ItemExistsException, PathNotFoundException, AccessDeniedException, RepositoryException, IOException,
DatabaseException, UserQuotaExceededException, AutomationException, UnknowException,
WebserviceException;
public ContentInfo getContentInfo(String fldId) throws AccessDeniedException, RepositoryException, PathNotFoundException,
DatabaseException, UnknowException, WebserviceException;
public void purgeFolder(String fldId) throws LockException, PathNotFoundException, AccessDeniedException, RepositoryException,
DatabaseException, UnknowException, WebserviceException;
Note
public Note addNote(String nodeId, String text) throws LockException, PathNotFoundException, AccessDeniedException, RepositoryException,
DatabaseException, UnknowException, WebserviceException;
public Note getNote(String noteId) throws LockException, PathNotFoundException, AccessDeniedException, RepositoryException,
DatabaseException, UnknowException, WebserviceException;
public void deleteNote(String noteId) throws LockException, PathNotFoundException, AccessDeniedException, RepositoryException,
DatabaseException, UnknowException, WebserviceException;
public void setNote(String noteId, String text) throws LockException, PathNotFoundException, AccessDeniedException, RepositoryException,
DatabaseException, UnknowException, WebserviceException;
public List<Note> listNotes(String nodeId) throws LockException, PathNotFoundException, AccessDeniedException, RepositoryException,
DatabaseException, UnknowException, WebserviceException;
PropertyGroup
public void addGroup(String nodeId, String grpName) throws NoSuchGroupException, LockException, PathNotFoundException,
AccessDeniedException, RepositoryException, DatabaseException, ExtensionException, AutomationException, UnknowException,
WebserviceException;
public void removeGroup(String nodeId, String grpName) throws AccessDeniedException, NoSuchGroupException, LockException,
PathNotFoundException, RepositoryException, DatabaseException, ExtensionException, UnknowException, WebserviceException;
public List<PropertyGroup> getGroups(String nodeId) throws IOException, ParseException, PathNotFoundException, RepositoryException,
DatabaseException, UnknowException, WebserviceException;
public List<PropertyGroup> getAllGroups() throws IOException, ParseException, RepositoryException, DatabaseException, UnknowException,
WebserviceException;
public List<FormElement> getPropertyGroupProperties(String nodeId, String grpName) throws IOException, ParseException,
NoSuchGroupException, PathNotFoundException, RepositoryException, DatabaseException, UnknowException, WebserviceException;
public List<FormElement> getPropertyGroupForm(String grpName) throws IOException, ParseException, NoSuchGroupException,
PathNotFoundException, RepositoryException, DatabaseException, UnknowException, WebserviceException;
public void setPropertyGroupProperties(String nodeId, String grpName, List<FormElement> ofeList) throws IOException, ParseException,
NoSuchPropertyException, NoSuchGroupException, LockException, PathNotFoundException, AccessDeniedException,
RepositoryException, DatabaseException, ExtensionException, AutomationException, UnknowException, WebserviceException;
public void setPropertyGroupPropertiesSimple(String nodeId, String grpName, Map<String, String> properties) throws IOException,
ParseException, NoSuchPropertyException, NoSuchGroupException, LockException, PathNotFoundException, AccessDeniedException,
RepositoryException, DatabaseException, ExtensionException, AutomationException, UnknowException, WebserviceException;
public boolean hasGroup(String nodeId, String grpName) throws IOException, ParseException, PathNotFoundException, RepositoryException,
DatabaseException, UnknowException, WebserviceException;
public String getRegisteredDefinition() throws ParseException, DatabaseException, IOException, UnknowException, WebserviceException;
public List<String> getSuggestions(String nodeId, String grpName, String propName) throws PathNotFoundException, IOException,
ParseException, NoSuchGroupException, SuggestionException, DatabaseException, UnknowException, WebserviceException;
public void registerDefinition(String pgDef) throws ParseException, DatabaseException, IOException, UnknowException,
WebserviceException;
public Map<String, String> getPropertyGroupPropertiesSimple(String nodeId, String grpName) throws IOException,
ParseException, NoSuchPropertyException, NoSuchGroupException, LockException, PathNotFoundException,
AccessDeniedException, RepositoryException, DatabaseException, ExtensionException, AutomationException,
UnknowException, WebserviceException;
Repository
public Folder getRootFolder() throws PathNotFoundException, RepositoryException, DatabaseException, UnknowException,
WebserviceException;
public Folder getTrashFolder() throws PathNotFoundException, RepositoryException, DatabaseException, UnknowException,
WebserviceException;
public Folder getTemplatesFolder() throws PathNotFoundException, RepositoryException, DatabaseException, UnknowException,
WebserviceException;
public Folder getPersonalFolder() throws PathNotFoundException, RepositoryException, DatabaseException, UnknowException,
WebserviceException;
public Folder getMailFolder() throws PathNotFoundException, RepositoryException, DatabaseException, UnknowException,
WebserviceException;
public Folder getThesaurusFolder() throws PathNotFoundException, RepositoryException, DatabaseException, UnknowException,
WebserviceException;
public Folder getCategoriesFolder() throws PathNotFoundException, RepositoryException, DatabaseException, UnknowException,
WebserviceException;
public void purgeTrash() throws PathNotFoundException, AccessDeniedException, LockException, RepositoryException, DatabaseException,
UnknowException, WebserviceException;
public String getUpdateMessage() throws RepositoryException, DatabaseException, UnknowException, WebserviceException;
public String getRepositoryUuid() throws RepositoryException, DatabaseException, UnknowException, WebserviceException;
public boolean hasNode(String nodeId) throws RepositoryException, DatabaseException, UnknowException, WebserviceException;
public String getNodePath(String uuid) throws PathNotFoundException, RepositoryException, DatabaseException, UnknowException,
WebserviceException;
public String getNodeUuid(String nodePath) throws PathNotFoundException, RepositoryException, DatabaseException, UnknowException,
WebserviceException;
public AppVersion getAppVersion() throws RepositoryException, DatabaseException, UnknowException, WebserviceException;
public void copyAttributes(String nodeId, String dstId, boolean categories, boolean keywords, boolean propertyGroups, boolean notes,
boolean wiki) throws ItemExistsException, PathNotFoundException, AccessDeniedException, RepositoryException, IOException,
DatabaseException, UserQuotaExceededException, AutomationException, UnknowException,
WebserviceException;
Search
public List<QueryResult> findByContent(String content) throws IOException, ParseException, RepositoryException, DatabaseException,
UnknowException, WebserviceException;
public List<QueryResult> findByName(String name) throws IOException, ParseException, RepositoryException, DatabaseException,
UnknowException, WebserviceException;
public List<QueryResult> findByKeywords(List<String> keywords) throws IOException, ParseException, RepositoryException,
DatabaseException, UnknowException, WebserviceException;
public List<QueryResult> find(QueryParams queryParams) throws IOException, ParseException, RepositoryException,
DatabaseException, UnknowException, WebserviceException;
public ResultSet findPaginated(QueryParams queryParams, int offset, int limit) throws IOException, ParseException,
RepositoryException, DatabaseException, UnknowException, WebserviceException;
public ResultSet findSimpleQueryPaginated(String statement, int offset, int limit) throws IOException, ParseException,
RepositoryException, DatabaseException, UnknowException, WebserviceException;
public ResultSet findMoreLikeThis(String uuid, int max) throws IOException, ParseException, RepositoryException, DatabaseException,
UnknowException, WebserviceException;
public Map<String, Integer> getKeywordMap(List<String> filter) throws RepositoryException, DatabaseException, UnknowException,
WebserviceException;
public List<Document> getCategorizedDocuments(String categoryId) throws RepositoryException, DatabaseException, UnknowException,
WebserviceException;
public long saveSearch(QueryParams params) throws AccessDeniedException, RepositoryException, DatabaseException, UnknowException,
WebserviceException;
public void updateSearch(QueryParams params) throws AccessDeniedException, RepositoryException, DatabaseException, UnknowException,
WebserviceException;
public QueryParams getSearch(int qpId) throws PathNotFoundException, RepositoryException, DatabaseException, UnknowException,
WebserviceException;
public List<QueryParams> getAllSearchs() throws RepositoryException, DatabaseException, UnknowException, WebserviceException;
public void deleteSearch(int qpId) throws AccessDeniedException, RepositoryException, DatabaseException, UnknowException,
WebserviceException;
Property
public void addCategory(String nodeId, String catId) throws VersionException, LockException, PathNotFoundException,
AccessDeniedException, RepositoryException, DatabaseException, UnknowException, WebserviceException;
public void removeCategory(String nodeId, String catId) throws VersionException, LockException, PathNotFoundException,
AccessDeniedException, RepositoryException, DatabaseException, UnknowException, WebserviceException;
public void addKeyword(String nodeId, String keyword) throws VersionException, LockException, PathNotFoundException,
AccessDeniedException, RepositoryException, DatabaseException, UnknowException, WebserviceException;
public void removeKeyword(String nodeId, String keyword) throws VersionException, LockException, PathNotFoundException,
AccessDeniedException, RepositoryException, DatabaseException, UnknowException, WebserviceException;
public void setEncryption(String nodeId, String cipherName) throws VersionException, LockException, PathNotFoundException,
AccessDeniedException, RepositoryException, DatabaseException, UnknowException, WebserviceException;
public void unsetEncryption(String nodeId) throws VersionException, LockException, PathNotFoundException, AccessDeniedException,
RepositoryException, DatabaseException, UnknowException, WebserviceException;
public void setSigned(String nodeId, boolean signed) throws VersionException, LockException, PathNotFoundException,
AccessDeniedException, RepositoryException, DatabaseException, UnknowException, WebserviceException;
public Mail createMail(Mail mail) throws PathNotFoundException, ItemExistsException, VirusDetectedException, AccessDeniedException,
RepositoryException, DatabaseException, UserQuotaExceededException, AutomationException, UnknowException, WebserviceException;
public Mail getMailProperties(String mailId) throws AccessDeniedException, RepositoryException, PathNotFoundException,
DatabaseException, UnknowException, WebserviceException;
public void deleteMail(String mailId) throws LockException, PathNotFoundException, AccessDeniedException, RepositoryException,
DatabaseException, UnknowException, WebserviceException;
public void purgeMail(String mailId) throws LockException, PathNotFoundException, AccessDeniedException, RepositoryException,
DatabaseException, UnknowException, WebserviceException;
public void renameMail(String mailId, String newName) throws PathNotFoundException, ItemExistsException, AccessDeniedException,
RepositoryException, DatabaseException, UnknowException, WebserviceException;
public void moveMail(String mailId, String dstId) throws PathNotFoundException, ItemExistsException, AccessDeniedException,
RepositoryException, DatabaseException, UnknowException, WebserviceException;
public void copyMail(String mailId, String dstId, String newName) throws PathNotFoundException, ItemExistsException, AccessDeniedException,
RepositoryException, IOException, AutomationException, DatabaseException, UserQuotaExceededException, UnknowException,
WebserviceException;
public void extendedMailCopy(String mailId, String dstId, boolean categories, boolean keywords, boolean propertyGroups, boolean notes,
boolean wiki) throws ItemExistsException, PathNotFoundException, AccessDeniedException, RepositoryException, IOException,
DatabaseException, UserQuotaExceededException, AutomationException, UnknowException, WebserviceException;
public List<Mail> getMailChildren(String fldId) throws PathNotFoundException, RepositoryException, DatabaseException, UnknowException,
WebserviceException;
public boolean isValidMail(String mailId) throws PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException,
UnknowException, WebserviceException;
public String getMailPath(String uuid) throws AccessDeniedException, RepositoryException, DatabaseException, UnknowException,
WebserviceException;
public Document createAttachment(String mailId, String docName, InputStream is) throws IOException, UnsupportedMimeTypeException,
FileSizeExceededException, UserQuotaExceededException, VirusDetectedException, ItemExistsException, PathNotFoundException,
AccessDeniedException, RepositoryException, DatabaseException, ExtensionException, AutomationException, UnknowException,
WebserviceException;
public void deleteAttachment(String mailId, String docId) throws LockException, PathNotFoundException, AccessDeniedException,
RepositoryException, DatabaseException, UnknowException, WebserviceException;
public List<Document> getAttachments(String mailId) throws RepositoryException, PathNotFoundException, DatabaseException,
UnknowException, WebserviceException;
public void sendMailWithAttachments(List<String> recipients, String subject, String body, List<String> docsId, String dstId)
throws AccessDeniedException, PathNotFoundException, ItemExistsException, AutomationException, VirusDetectedException,
UserQuotaExceededException, UnsupportedMimeTypeException, FileSizeExceededException, RepositoryException, DatabaseException,
IOException, UnknowException, WebserviceException;
Record
public Record createRecord(Record record) throws AccessDeniedException, RepositoryException, PathNotFoundException,
ItemExistsException, DatabaseException, ExtensionException, AutomationException, UnknowException, WebserviceException;
public Record getRecordProperties(String recId) throws AccessDeniedException, RepositoryException, PathNotFoundException,
DatabaseException, UnknowException, WebserviceException;
public void deleteRecord(String recId) throws LockException, PathNotFoundException, AccessDeniedException, RepositoryException,
DatabaseException, UnknowException, WebserviceException;
public void purgeRecord(String recId) throws LockException, AccessDeniedException, RepositoryException, PathNotFoundException,
DatabaseException, ExtensionException, UnknowException, WebserviceException;
public void renameRecord(String recId, String newName) throws AccessDeniedException, RepositoryException, PathNotFoundException,
ItemExistsException, LockException, DatabaseException, ExtensionException, LockException, UnknowException, WebserviceException;
public void moveRecord(String recId, String dstId) throws LockException, PathNotFoundException, ItemExistsException,
AccessDeniedException, RepositoryException, DatabaseException, ExtensionException, AutomationException, LockException,
UnknowException, WebserviceException;
public void copyRecord(String recId, String dstId, String newName) throws ItemExistsException, PathNotFoundException, AccessDeniedException,
RepositoryException, IOException, DatabaseException, UserQuotaExceededException, ExtensionException, AutomationException,
UnknowException, WebserviceException;
public boolean isValidRecord(String recId) throws PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException,
UnknowException, WebserviceException;
public List<Record> getRecordChildren(String recId) throws RepositoryException, PathNotFoundException, DatabaseException,
UnknowException, WebserviceException;
public LockInfo lockRecord(String recId) throws LockException, PathNotFoundException, AccessDeniedException, RepositoryException,
DatabaseException, UnknowException, WebserviceException;
public void unlockRecord(String recId) throws LockException, PathNotFoundException, AccessDeniedException, RepositoryException,
DatabaseException, UnknowException, WebserviceException;
public void forceUnlockRecord(String recId) throws LockException, PathNotFoundException, AccessDeniedException, RepositoryException,
DatabaseException, PrincipalAdapterException, UnknowException, WebserviceException;
public void setRecordTitle(String recId, String title) throws VersionException, LockException, PathNotFoundException,
AccessDeniedException, RepositoryException, DatabaseException, UnknowException,
WebserviceException;
public String getRecordPath(String uuid) throws AccessDeniedException, RepositoryException, DatabaseException, UnknowException,
WebserviceException;
Relation
public RelationTypeList getRelationTypes(String type) throws AccessDeniedException, DatabaseException, UnknowException,
WebserviceException;
public void addRelation(String nodeAId, String nodeBId, long relTypeId) throws LockException, PathNotFoundException,
AccessDeniedException, RepositoryException, DatabaseException, UnknowException, WebserviceException;
public void deleteRelation(long relationId) throws LockException, PathNotFoundException, AccessDeniedException,
RepositoryException, DatabaseException, UnknowException, WebserviceException;
public RelationList getRelations(String nodeId) throws PathNotFoundException, RepositoryException, DatabaseException,
UnknowException, WebserviceException;
public RelationGroupList getRelationGroups(String nodeId) throws AccessDeniedException, DatabaseException, UnknowException,
WebserviceException;
public void addRelationGroup(String nodeId, String groupName, long type) throws AccessDeniedException, PathNotFoundException,
DatabaseException, UnknowException, WebserviceException;
public void addNodeToGroup(String nodeId, long groupId) throws AccessDeniedException, PathNotFoundException,
DatabaseException, RepositoryException, UnknowException, WebserviceException;
public void deleteRelationGroup(String nodeId, long groupId) throws AccessDeniedException, DatabaseException,
PathNotFoundException, RepositoryException, UnknowException, WebserviceException;
public RelationGroup findRelationGroup(long groupId) throws AccessDeniedException, PathNotFoundException, DatabaseException,
RepositoryException, UnknowException, WebserviceException;
public void setRelationGroupName(long groupId, String groupName) throws AccessDeniedException, DatabaseException, UnknowException,
WebserviceException;
Workflow
public void registerProcessDefinition(InputStream is) throws ParseException, RepositoryException, DatabaseException,
WorkflowException, IOException, UnknowException, WebserviceException;
public void deleteProcessDefinition(long pdId) throws RepositoryException, DatabaseException, WorkflowException,
UnknowException, WebserviceException;
public ProcessDefinition getProcessDefinition(long pdId) throws RepositoryException, DatabaseException, WorkflowException,
UnknowException, WebserviceException;
public ProcessInstance runProcessDefinition(long pdId, String uuid, FormElementComplexList values)
throws WorkflowException, AccessDeniedException, RepositoryException, DatabaseException, UnknowException,
WebserviceException;
public List<ProcessInstance> findProcessInstances(long pdId) throws RepositoryException, DatabaseException,
WorkflowException, UnknowException, WebserviceException;
public List<ProcessDefinition> findAllProcessDefinitions() throws RepositoryException, DatabaseException, WorkflowException,
UnknowException, WebserviceException;
public List<ProcessDefinition> findLatestProcessDefinitions() throws RepositoryException, DatabaseException,
WorkflowException, UnknowException, WebserviceException;
public ProcessDefinition findLastProcessDefinition(String name) throws RepositoryException, DatabaseException,
WorkflowException, UnknowException, WebserviceException;
public ProcessInstance getProcessInstance(long piId) throws RepositoryException, DatabaseException, WorkflowException,
UnknowException, WebserviceException;
public List<TaskInstance> findUserTaskInstances() throws RepositoryException, DatabaseException, WorkflowException,
UnknowException, WebserviceException;
public List<TaskInstance> findTaskInstances(long piId) throws RepositoryException, DatabaseException, WorkflowException,
UnknowException, WebserviceException;
public void setTaskInstanceValues(long tiId, String transName, FormElementComplexList values) throws RepositoryException,
DatabaseException, WorkflowException, UnknowException, WebserviceException;
public TaskInstance getTaskInstance(long tiId) throws RepositoryException, DatabaseException, WorkflowException,
UnknowException, WebserviceException;
public void startTaskInstance(long tiId) throws RepositoryException, DatabaseException, WorkflowException, UnknowException,
WebserviceException;
public void setTaskInstanceActorId(long tiId, String actorId) throws RepositoryException, DatabaseException,
WorkflowException, UnknowException, WebserviceException;
public void endTaskInstance(long tiId, String transName) throws RepositoryException, DatabaseException, WorkflowException,
UnknowException, WebserviceException;