RepositoryImpl (OpenKM SDK for Java 3.34 API)

java.lang.Object
- com.openkm.sdk4j.impl.ClientImpl
- - com.openkm.sdk4j.impl.RepositoryImpl

All Implemented Interfaces:

BaseRepository, Serializable
```
public class RepositoryImpl
extends ClientImpl
implements BaseRepository, Serializable
```
RepositoryImpl

Author:

jllort

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

RepositoryImpl(String host)
RepositoryImpl

Constructors
Constructor and Description
`RepositoryImpl(String host)` RepositoryImpl

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`copyAttributes(String uuid, String dstId, boolean categories, boolean keywords, boolean propertyGroups, boolean notes)` Copy attributes.
`void`	`copyAttributes(String uuid, String dstId, boolean categories, boolean keywords, boolean propertyGroups, boolean notes, boolean wiki)` Deprecated. As of sdk4j 3.13, replaced by `copyAttributes(String, String, boolean, boolean, boolean, boolean)`
`HqlQueryResults`	`executeHqlQuery(InputStream is)` Execute hql query hql query results.
`HqlQueryResults`	`executeHqlQuery(String hql)` Execute hql query hql query results.
`ScriptExecutionResult`	`executeScript(InputStream is)` Execute script script execution result.
`ScriptExecutionResult`	`executeScript(String script)` Execute script script execution result.
`SqlQueryResults`	`executeSqlQuery(InputStream is)` Execute sql query sql query results.
`SqlQueryResults`	`executeSqlQuery(String sql)` Execute sql query sql query results.
`AppVersion`	`getAppVersion()` Gets app version.
`Map<String,String>`	`getAvailableLocales(String locale)` Gets available locales.
`Folder`	`getCategoriesFolder()` Gets categories folder.
`List<ChangeLogged>`	`getChangeLog(String nodePath, Calendar modificationsFrom)` Gets change log.
`String`	`getClusterUuid()` Gets cluster uuid.
`Configuration`	`getConfiguration(String key)` Gets configuration.
`boolean`	`getIsFilePlan()` Gets is file plan.
`LicenseInfo`	`getLicenseInfo()` Gets license info.
`Folder`	`getMailFolder()` Gets mail folder.
`Folder`	`getMailFolderBase()` Gets mail folder base.
`String`	`getNodePath(String uuid)` Gets node path.
`String`	`getNodeUuid(String nodePath)` Gets node uuid.
`Folder`	`getPersonalFolder()` Gets personal folder.
`Folder`	`getPersonalFolderBase()` Gets personal folder base.
`String`	`getRepositoryUuid()` Gets repository uuid.
`Folder`	`getRootFolder()` Gets root folder.
`String`	`getServerTime()` Gets server time.
`Folder`	`getTemplatesFolder()` Gets templates folder.
`Folder`	`getThesaurusFolder()` Gets thesaurus folder.
`Map<String,String>`	`getTranslations(String lang, String module)` Gets translations.
`Folder`	`getTrashFolder()` Gets trash folder.
`Folder`	`getTrashFolderBase()` Gets trash folder base.
`String`	`getUpdateMessage()` Gets update message.
`boolean`	`hasNode(String nodeId)` Has node boolean.
`void`	`purgeTrash()` Purge trash.
`void`	`setAuthorizationToken(String authorizationToken)` setAuthenticationToken

Methods inherited from class com.openkm.sdk4j.impl.ClientImpl
getClient, resource, resource, resource

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- RepositoryImpl
```
public RepositoryImpl(String host)
```
  RepositoryImpl

Method Detail

setAuthorizationToken

public void setAuthorizationToken(String authorizationToken)

setAuthenticationToken

getRootFolder

public Folder getRootFolder()
                     throws PathNotFoundException,
                            RepositoryException,
                            DatabaseException,
                            UnknownException,
                            WebserviceException,
                            AccessDeniedException

Description copied from interface: BaseRepository

Gets root folder.

Specified by:: getRootFolder in interface BaseRepository
Returns:: the root folder
Throws:: PathNotFoundException - the path not found exception; RepositoryException - the repository exception; DatabaseException - the database exception; UnknownException - the unknown exception; WebserviceException - the webservice exception; AccessDeniedException - the access denied exception

getTrashFolder

public Folder getTrashFolder()
                      throws PathNotFoundException,
                             RepositoryException,
                             DatabaseException,
                             UnknownException,
                             WebserviceException,
                             AccessDeniedException

Description copied from interface: BaseRepository

Gets trash folder.

Specified by:: getTrashFolder in interface BaseRepository
Returns:: the trash folder
Throws:: PathNotFoundException - the path not found exception; RepositoryException - the repository exception; DatabaseException - the database exception; UnknownException - the unknown exception; WebserviceException - the webservice exception; AccessDeniedException - the access denied exception

getTrashFolderBase

public Folder getTrashFolderBase()
                          throws PathNotFoundException,
                                 RepositoryException,
                                 DatabaseException,
                                 UnknownException,
                                 WebserviceException,
                                 AccessDeniedException

Description copied from interface: BaseRepository

Gets trash folder base.

Specified by:: getTrashFolderBase in interface BaseRepository
Returns:: the trash folder base
Throws:: PathNotFoundException - the path not found exception; RepositoryException - the repository exception; DatabaseException - the database exception; UnknownException - the unknown exception; WebserviceException - the webservice exception; AccessDeniedException - the access denied exception

getTemplatesFolder

public Folder getTemplatesFolder()
                          throws PathNotFoundException,
                                 RepositoryException,
                                 DatabaseException,
                                 UnknownException,
                                 WebserviceException,
                                 AccessDeniedException

Description copied from interface: BaseRepository

Gets templates folder.

Specified by:: getTemplatesFolder in interface BaseRepository
Returns:: the templates folder
Throws:: PathNotFoundException - the path not found exception; RepositoryException - the repository exception; DatabaseException - the database exception; UnknownException - the unknown exception; WebserviceException - the webservice exception; AccessDeniedException - the access denied exception

getPersonalFolder

public Folder getPersonalFolder()
                         throws PathNotFoundException,
                                RepositoryException,
                                DatabaseException,
                                UnknownException,
                                WebserviceException,
                                AccessDeniedException

Description copied from interface: BaseRepository

Gets personal folder.

Specified by:: getPersonalFolder in interface BaseRepository
Returns:: the personal folder
Throws:: PathNotFoundException - the path not found exception; RepositoryException - the repository exception; DatabaseException - the database exception; UnknownException - the unknown exception; WebserviceException - the webservice exception; AccessDeniedException - the access denied exception

getPersonalFolderBase

public Folder getPersonalFolderBase()
                             throws PathNotFoundException,
                                    RepositoryException,
                                    DatabaseException,
                                    UnknownException,
                                    WebserviceException,
                                    AccessDeniedException

Description copied from interface: BaseRepository

Gets personal folder base.

Specified by:: getPersonalFolderBase in interface BaseRepository
Returns:: the personal folder base
Throws:: PathNotFoundException - the path not found exception; RepositoryException - the repository exception; DatabaseException - the database exception; UnknownException - the unknown exception; WebserviceException - the webservice exception; AccessDeniedException - the access denied exception

getMailFolder

public Folder getMailFolder()
                     throws PathNotFoundException,
                            RepositoryException,
                            DatabaseException,
                            UnknownException,
                            WebserviceException,
                            AccessDeniedException

Description copied from interface: BaseRepository

Gets mail folder.

Specified by:: getMailFolder in interface BaseRepository
Returns:: the mail folder
Throws:: PathNotFoundException - the path not found exception; RepositoryException - the repository exception; DatabaseException - the database exception; UnknownException - the unknown exception; WebserviceException - the webservice exception; AccessDeniedException - the access denied exception

getMailFolderBase

public Folder getMailFolderBase()
                         throws PathNotFoundException,
                                RepositoryException,
                                DatabaseException,
                                UnknownException,
                                WebserviceException,
                                AccessDeniedException

Description copied from interface: BaseRepository

Gets mail folder base.

Specified by:: getMailFolderBase in interface BaseRepository
Returns:: the mail folder base
Throws:: PathNotFoundException - the path not found exception; RepositoryException - the repository exception; DatabaseException - the database exception; UnknownException - the unknown exception; WebserviceException - the webservice exception; AccessDeniedException - the access denied exception

getThesaurusFolder

public Folder getThesaurusFolder()
                          throws PathNotFoundException,
                                 RepositoryException,
                                 DatabaseException,
                                 UnknownException,
                                 WebserviceException,
                                 AccessDeniedException

Description copied from interface: BaseRepository

Gets thesaurus folder.

Specified by:: getThesaurusFolder in interface BaseRepository
Returns:: the thesaurus folder
Throws:: PathNotFoundException - the path not found exception; RepositoryException - the repository exception; DatabaseException - the database exception; UnknownException - the unknown exception; WebserviceException - the webservice exception; AccessDeniedException - the access denied exception

getCategoriesFolder

public Folder getCategoriesFolder()
                           throws PathNotFoundException,
                                  RepositoryException,
                                  DatabaseException,
                                  UnknownException,
                                  WebserviceException,
                                  AccessDeniedException

Description copied from interface: BaseRepository

Gets categories folder.

Specified by:: getCategoriesFolder in interface BaseRepository
Returns:: the categories folder
Throws:: PathNotFoundException - the path not found exception; RepositoryException - the repository exception; DatabaseException - the database exception; UnknownException - the unknown exception; WebserviceException - the webservice exception; AccessDeniedException - the access denied exception

purgeTrash

public void purgeTrash()
                throws PathNotFoundException,
                       AccessDeniedException,
                       LockException,
                       RepositoryException,
                       DatabaseException,
                       UnknownException,
                       WebserviceException

Description copied from interface: BaseRepository

Purge trash.

Specified by:: purgeTrash in interface BaseRepository
Throws:: PathNotFoundException - the path not found exception; AccessDeniedException - the access denied exception; LockException - the lock exception; RepositoryException - the repository exception; DatabaseException - the database exception; UnknownException - the unknown exception; WebserviceException - the webservice exception

getUpdateMessage

public String getUpdateMessage()
                        throws RepositoryException,
                               DatabaseException,
                               UnknownException,
                               WebserviceException,
                               AccessDeniedException

Description copied from interface: BaseRepository

Gets update message.

Specified by:: getUpdateMessage in interface BaseRepository
Returns:: the update message
Throws:: RepositoryException - the repository exception; DatabaseException - the database exception; UnknownException - the unknown exception; WebserviceException - the webservice exception; AccessDeniedException - the access denied exception

getRepositoryUuid

public String getRepositoryUuid()
                         throws RepositoryException,
                                DatabaseException,
                                UnknownException,
                                WebserviceException,
                                AccessDeniedException

Description copied from interface: BaseRepository

Gets repository uuid.

Specified by:: getRepositoryUuid in interface BaseRepository
Returns:: the repository uuid
Throws:: RepositoryException - the repository exception; DatabaseException - the database exception; UnknownException - the unknown exception; WebserviceException - the webservice exception; AccessDeniedException - the access denied exception

hasNode
```
public boolean hasNode(String nodeId)
                throws RepositoryException,
                       DatabaseException,
                       UnknownException,
                       WebserviceException,
                       AccessDeniedException
```
Description copied from interface: BaseRepository

Has node boolean.

Specified by:

hasNode in interface BaseRepository

Parameters:

nodeId - the node id

Returns:

the boolean

Throws:

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

AccessDeniedException - the access denied exception

getNodePath

public String getNodePath(String uuid)
                   throws PathNotFoundException,
                          RepositoryException,
                          DatabaseException,
                          UnknownException,
                          WebserviceException,
                          AccessDeniedException

Description copied from interface: BaseRepository

Gets node path.

Specified by:: getNodePath in interface BaseRepository
Parameters:: uuid - the uuid
Returns:: the node path
Throws:: PathNotFoundException - the path not found exception; RepositoryException - the repository exception; DatabaseException - the database exception; UnknownException - the unknown exception; WebserviceException - the webservice exception; AccessDeniedException - the access denied exception

getNodeUuid

public String getNodeUuid(String nodePath)
                   throws PathNotFoundException,
                          RepositoryException,
                          DatabaseException,
                          UnknownException,
                          WebserviceException,
                          AccessDeniedException

Description copied from interface: BaseRepository

Gets node uuid.

Specified by:: getNodeUuid in interface BaseRepository
Parameters:: nodePath - the node path
Returns:: the node uuid
Throws:: PathNotFoundException - the path not found exception; RepositoryException - the repository exception; DatabaseException - the database exception; UnknownException - the unknown exception; WebserviceException - the webservice exception; AccessDeniedException - the access denied exception

getAppVersion

public AppVersion getAppVersion()
                         throws RepositoryException,
                                DatabaseException,
                                UnknownException,
                                WebserviceException,
                                AccessDeniedException

Description copied from interface: BaseRepository

Gets app version.

Specified by:: getAppVersion in interface BaseRepository
Returns:: the app version
Throws:: RepositoryException - the repository exception; DatabaseException - the database exception; UnknownException - the unknown exception; WebserviceException - the webservice exception; AccessDeniedException - the access denied exception

copyAttributes

public void copyAttributes(String uuid,
                           String dstId,
                           boolean categories,
                           boolean keywords,
                           boolean propertyGroups,
                           boolean notes)
                    throws ItemExistsException,
                           PathNotFoundException,
                           AccessDeniedException,
                           RepositoryException,
                           DatabaseException,
                           UserQuotaExceededException,
                           AutomationException,
                           PromotedAsRecordLockException,
                           UnknownException,
                           WebserviceException

Description copied from interface: BaseRepository

Copy attributes.

Specified by:: copyAttributes in interface BaseRepository
Parameters:: uuid - the uuid; dstId - the dst id; categories - the categories; keywords - the keywords; propertyGroups - the property groups; notes - the notes
Throws:: ItemExistsException - the item exists exception; PathNotFoundException - the path not found exception; AccessDeniedException - the access denied exception; RepositoryException - the repository exception; DatabaseException - the database exception; UserQuotaExceededException - the user quota exceeded exception; AutomationException - the automation exception; PromotedAsRecordLockException - the promoted as record lock exception; UnknownException - the unknown exception; WebserviceException - the webservice exception

copyAttributes

@Deprecated
public void copyAttributes(String uuid,
                                       String dstId,
                                       boolean categories,
                                       boolean keywords,
                                       boolean propertyGroups,
                                       boolean notes,
                                       boolean wiki)
                                throws ItemExistsException,
                                       PathNotFoundException,
                                       AccessDeniedException,
                                       RepositoryException,
                                       DatabaseException,
                                       UserQuotaExceededException,
                                       AutomationException,
                                       PromotedAsRecordLockException,
                                       UnknownException,
                                       WebserviceException

Deprecated. As of sdk4j 3.13, replaced by copyAttributes(String, String, boolean, boolean, boolean, boolean)

copyAttributes

Specified by:: copyAttributes in interface BaseRepository
Parameters:: uuid - the uuid; dstId - the dst id; categories - the categories; keywords - the keywords; propertyGroups - the property groups; notes - the notes; wiki - the wiki
Throws:: ItemExistsException - the item exists exception; PathNotFoundException - the path not found exception; AccessDeniedException - the access denied exception; RepositoryException - the repository exception; DatabaseException - the database exception; UserQuotaExceededException - the user quota exceeded exception; AutomationException - the automation exception; PromotedAsRecordLockException - the promoted as record lock exception; UnknownException - the unknown exception; WebserviceException - the webservice exception
See Also:: copyAttributes(String, String, boolean, boolean, boolean, boolean)

executeScript
```
public ScriptExecutionResult executeScript(InputStream is)
                                    throws UnknownException,
                                           WebserviceException,
                                           AccessDeniedException
```
Description copied from interface: BaseRepository

Execute script script execution result.

Specified by:

executeScript in interface BaseRepository

Parameters:

is - the is

Returns:

the script execution result

Throws:

UnknownException - the unknown exception

WebserviceException - the webservice exception

AccessDeniedException - the access denied exception

executeScript

public ScriptExecutionResult executeScript(String script)
                                    throws AccessDeniedException,
                                           UnknownException,
                                           WebserviceException,
                                           IOException

Description copied from interface: BaseRepository

Execute script script execution result.

Specified by:: executeScript in interface BaseRepository
Parameters:: script - the script
Returns:: the script execution result
Throws:: AccessDeniedException - the access denied exception; UnknownException - the unknown exception; WebserviceException - the webservice exception; IOException - the io exception

executeSqlQuery

public SqlQueryResults executeSqlQuery(InputStream is)
                                throws DatabaseException,
                                       UnknownException,
                                       WebserviceException,
                                       AccessDeniedException

Description copied from interface: BaseRepository

Execute sql query sql query results.

Specified by:: executeSqlQuery in interface BaseRepository
Parameters:: is - the is
Returns:: the sql query results
Throws:: DatabaseException - the database exception; UnknownException - the unknown exception; WebserviceException - the webservice exception; AccessDeniedException - the access denied exception

executeSqlQuery

public SqlQueryResults executeSqlQuery(String sql)
                                throws DatabaseException,
                                       UnknownException,
                                       WebserviceException,
                                       AccessDeniedException,
                                       IOException

Description copied from interface: BaseRepository

Execute sql query sql query results.

Specified by:: executeSqlQuery in interface BaseRepository
Parameters:: sql - the sql
Returns:: the sql query results
Throws:: DatabaseException - the database exception; UnknownException - the unknown exception; WebserviceException - the webservice exception; AccessDeniedException - the access denied exception; IOException - the io exception

executeHqlQuery

public HqlQueryResults executeHqlQuery(InputStream is)
                                throws DatabaseException,
                                       UnknownException,
                                       WebserviceException,
                                       AccessDeniedException

Description copied from interface: BaseRepository

Execute hql query hql query results.

Specified by:: executeHqlQuery in interface BaseRepository
Parameters:: is - the is
Returns:: the hql query results
Throws:: DatabaseException - the database exception; UnknownException - the unknown exception; WebserviceException - the webservice exception; AccessDeniedException - the access denied exception

executeHqlQuery

public HqlQueryResults executeHqlQuery(String hql)
                                throws AccessDeniedException,
                                       DatabaseException,
                                       UnknownException,
                                       WebserviceException,
                                       IOException

Description copied from interface: BaseRepository

Execute hql query hql query results.

Specified by:: executeHqlQuery in interface BaseRepository
Parameters:: hql - the hql
Returns:: the hql query results
Throws:: AccessDeniedException - the access denied exception; DatabaseException - the database exception; UnknownException - the unknown exception; WebserviceException - the webservice exception; IOException - the io exception

getTranslations

public Map<String,String> getTranslations(String lang,
                                          String module)
                                   throws DatabaseException,
                                          UnknownException,
                                          WebserviceException,
                                          AccessDeniedException

Description copied from interface: BaseRepository

Gets translations.

Specified by:: getTranslations in interface BaseRepository
Parameters:: lang - the lang; module - the module
Returns:: the translations
Throws:: DatabaseException - the database exception; UnknownException - the unknown exception; WebserviceException - the webservice exception; AccessDeniedException - the access denied exception

getConfiguration
```
public Configuration getConfiguration(String key)
                               throws DatabaseException,
                                      UnknownException,
                                      WebserviceException
```
Description copied from interface: BaseRepository

Gets configuration.

Specified by:

getConfiguration in interface BaseRepository

Parameters:

key - the key

Returns:

the configuration

Throws:

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getChangeLog

public List<ChangeLogged> getChangeLog(String nodePath,
                                       Calendar modificationsFrom)
                                throws AccessDeniedException,
                                       DatabaseException,
                                       PathNotFoundException,
                                       UnknownException,
                                       WebserviceException

Description copied from interface: BaseRepository

Gets change log.

Specified by:: getChangeLog in interface BaseRepository
Parameters:: nodePath - the node path; modificationsFrom - the modifications from
Returns:: the change log
Throws:: AccessDeniedException - the access denied exception; DatabaseException - the database exception; PathNotFoundException - the path not found exception; UnknownException - the unknown exception; WebserviceException - the webservice exception

getAvailableLocales

public Map<String,String> getAvailableLocales(String locale)
                                       throws WebserviceException,
                                              PathNotFoundException,
                                              DatabaseException,
                                              UnknownException,
                                              AccessDeniedException

Description copied from interface: BaseRepository

Gets available locales.

Specified by:: getAvailableLocales in interface BaseRepository
Parameters:: locale - the locale
Returns:: the available locales
Throws:: WebserviceException - the webservice exception; PathNotFoundException - the path not found exception; DatabaseException - the database exception; UnknownException - the unknown exception; AccessDeniedException - the access denied exception

getServerTime
```
public String getServerTime()
                     throws UnknownException,
                            WebserviceException
```
Description copied from interface: BaseRepository

Gets server time.

Specified by:

getServerTime in interface BaseRepository

Returns:

the server time

Throws:

UnknownException - the unknown exception

WebserviceException - the webservice exception

getLicenseInfo

public LicenseInfo getLicenseInfo()
                           throws WebserviceException,
                                  RepositoryException,
                                  UnknownException,
                                  AccessDeniedException

Description copied from interface: BaseRepository

Gets license info.

Specified by:: getLicenseInfo in interface BaseRepository
Returns:: the license info
Throws:: WebserviceException - the webservice exception; RepositoryException - the repository exception; UnknownException - the unknown exception; AccessDeniedException - the access denied exception

getClusterUuid
```
public String getClusterUuid()
                      throws WebserviceException,
                             RepositoryException,
                             UnknownException
```
Description copied from interface: BaseRepository

Gets cluster uuid.

Specified by:

getClusterUuid in interface BaseRepository

Returns:

the cluster uuid

Throws:

WebserviceException - the webservice exception

RepositoryException - the repository exception

UnknownException - the unknown exception

getIsFilePlan
```
public boolean getIsFilePlan()
                      throws WebserviceException,
                             RepositoryException,
                             UnknownException
```
Description copied from interface: BaseRepository

Gets is file plan.

Specified by:

getIsFilePlan in interface BaseRepository

Returns:

the is file plan

Throws:

WebserviceException - the webservice exception

RepositoryException - the repository exception

UnknownException - the unknown exception

Class RepositoryImpl

Constructor Summary

Method Summary

Methods inherited from class com.openkm.sdk4j.impl.ClientImpl

Methods inherited from class java.lang.Object

Constructor Detail

RepositoryImpl

Method Detail

setAuthorizationToken

getRootFolder

getTrashFolder

getTrashFolderBase

getTemplatesFolder

getPersonalFolder

getPersonalFolderBase

getMailFolder

getMailFolderBase

getThesaurusFolder

getCategoriesFolder

purgeTrash

getUpdateMessage

getRepositoryUuid

hasNode

getNodePath

getNodeUuid

getAppVersion

copyAttributes

copyAttributes

executeScript

executeScript

executeSqlQuery

executeSqlQuery

executeHqlQuery

executeHqlQuery

getTranslations

getConfiguration

getChangeLog

getAvailableLocales

getServerTime

getLicenseInfo

getClusterUuid

getIsFilePlan