Java SDK Changelog

From OpenKM Documentation
Revision as of 14:16, 26 November 2014 by Pavila (talk | contribs)

Jump to: navigation, search

SDK for Java 2.2

  • Added methods in Auth
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;
  • Modified method in Document

Added newName variable to copyDocument method. If variable newName is not empty, then the document will used as new document name. 

public void copyDocument(String docId, String dstId, String newName) throws ItemExistsException, PathNotFoundException, AccessDeniedException,
		RepositoryException, IOException, DatabaseException, UserQuotaExceededException, ExtensionException, AutomationException,
		UnknowException, WebserviceException;
  • Added methods in Document
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;
  • Modified method in Folder

Added newName variable to copyFolder method. If variable newName is not empty, then will used as new folder name. 

public void copyFolder(String fldId, String dstId, String newName) throws PathNotFoundException, ItemExistsException, AccessDeniedException,
		RepositoryException, IOException, AutomationException, DatabaseException, UserQuotaExceededException,
		UnknowException, WebserviceException;
  • Added method in PropertyGroup
public Map<String, String> getPropertyGroupPropertiesSimple(String nodeId, String grpName) throws IOException,
		ParseException, NoSuchPropertyException, NoSuchGroupException, LockException, PathNotFoundException,
		AccessDeniedException, RepositoryException, DatabaseException, ExtensionException, AutomationException,
		UnknowException, WebserviceException;


  • Modified method in Mail

Added newName variable to copyMail method. If variable newName is not empty, then will used as new mail name. 

public void copyMail(String mailId, String dstId, String newName) throws PathNotFoundException, ItemExistsException, AccessDeniedException,
		RepositoryException, IOException, AutomationException, DatabaseException, UserQuotaExceededException, UnknowException,
		WebserviceException;
  • Added support for Records
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;
  • Added support for Relations
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;
  • Added support for Workflows
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;

SDK for Java 2.1

  • Has been removed library dependences presents into jar file.

Removed methods

  • Removed method in setDocumentNodeClass
  • Removed method in setRecordNodeClass
  • Added method in Document
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;
  • Added method in Folder
public void copyFolder(String fldId, String dstId) 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;
  • Added method in PropertyGroup
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;
  • Added method in Mail
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) 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;
  • Added method in 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) 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 recId) throws AccessDeniedException, RepositoryException, DatabaseException, UnknowException,
		WebserviceException;
  • Added method in Repository
public Folder getTrashFolderBase() throws PathNotFoundException, RepositoryException, DatabaseException, UnknowException,
		WebserviceException;
public Folder getPersonalFolderBase() throws PathNotFoundException, RepositoryException, DatabaseException, UnknowException,
		WebserviceException;
public Folder getMailFolderBase() throws PathNotFoundException, 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;

SDK for Java 2.0 ( Deprecated )

  • Added method in PropertyGroup
public List<FormElement> getPropertyGroupForm(String grpName) throws IOException, ParseException, NoSuchGroupException, PathNotFoundException, RepositoryException, DatabaseException, UnknowException, WebserviceException;
  • Added methods in Auth
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;
  • Added methods in Document
public void setTitle(String docId, String title) throws VersionException, LockException, PathNotFoundException, AccessDeniedException,
		RepositoryException, DatabaseException, UnknowException, WebserviceException;
public void setLanguage(String docId, String lang) 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 List<String> getDetectedLanguages() throws RepositoryException, DatabaseException, UnknowException, WebserviceException;
  • Changes in class Document
added instance variable String title
added instance variable String language
  • Changes in class QueryParams

Intance variable folder replaces removed instance variable path to indicate folder from where starting searching.

Intance variable folderRecursive indicates if search must be done in folder path and subfolders. 

added instance variable String folder
added instance variable boolean folderRecursive
added instance variable String title
added instance variable String language
removed instance variable String path
  • Changes in class Node
added instance variable long nodeClass

SDK for Java 1.1

  • Has been removed library dependences presents into jar file.

SDK for Java 1.0 ( Deprecated version )

  • Added support for SSL.
  • Removed OKMWebservicesFactory static version variables, now webservice creation is:
OKMWebservices ws= OKMWebservicesFactory.newInstance(host, user, password);

SDK for Java ( Deprecated version )

Supported versions

  • OpenKM Professional 6.4.9+
  • OpenKM Professional 6.4.5+
  • OpenKM Professional 6.2.27+
  • OpenKM Professional 6.2.23+
  • OpenKM Community 6.3
Retrieved from "https://www.openkm.com/wiki/index.php?title=Java_SDK_Changelog&oldid=12067"