Package com.saperion.connector

Class SaClassicConnectorImpl

    • Constructor Summary

      Constructors 
      Constructor Description
      SaClassicConnectorImpl()
      Constructs the SaClassicConnectorImpl instance which provides DMS functionality.
      SaClassicConnectorImpl​(java.lang.String configPath)
      Constructs the SaClassicConnectorImpl instance which provides DMS functionality.
      SaClassicConnectorImpl​(java.util.Properties configuration)
      Constructs the SaClassicConnectorImpl instance which provides DMS functionality.
      SaClassicConnectorImpl​(java.util.Properties configuration, com.saperion.cache.CacheManager cacheManager)
      Constructs the SaClassicConnectorImpl instance which provides DMS functionality.

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      void addComment​(java.lang.String comment, java.lang.String taskUID, int level)
      Adds a comment to the task.
      void addHistory​(java.lang.String description, java.lang.String taskUID)
      Adds a history entry to the task.
      void addListener​(SaEventListener listener)
      Deprecated.
      void addListener​(SaStatusEventListener listener)
      Deprecated.
      void addToFolder​(java.lang.String folderTableDDC, java.lang.String documentId, java.lang.String documentDDC, java.lang.String folderId)
      Adds the document with given documentId to a given folder with given folderId.
      SaSaveInfo cacheDocument​(java.lang.String xhDoc, DocumentInfo document)
      Caches a new document in the backend system with the given metadata and content.
      SaSaveInfo cacheDocument​(java.lang.String xhDoc, java.lang.String ddcName, java.util.Properties namevaluePairs, java.io.InputStream[] content, java.lang.String versionComment, java.lang.String strAcl)
      Caches a new document in the backend system with the given metadata and content.
      void changePassword​(java.lang.String user, java.lang.String oldPassword, java.lang.String tenant, java.lang.String newPassword)
      Changes the password of an existing user.
      void checkoutDocument​(java.lang.String hDoc)
      Checks out a document for the given document id (hdoc).
      void checkoutDocument​(java.lang.String hDoc, boolean withCloudShare, int[] shareBaseDocIds)
      Checks out a document with filesystem/ShareBase for the given document id (hdoc).
      SapDocInfo checkSapUrl​(java.lang.String url)
      Checks the given SAP URL on the R/Link server and returns, if successfull, the HDOC and the DDC.
      boolean closeSession​(com.saperion.connector.authentication.Session session)
      Close the given Session of logged in user
      java.lang.String copyFolder​(java.lang.String folderTableDDC, java.lang.String folderId, java.lang.String destinationId, java.lang.String beforeChild, boolean withDocuments)
      Copies the given folder and all it's children to the destination.
      SaSaveInfo createDocument​(DocumentInfo document)
      Creates a new document on the backend system with the given DocumentInfo.
      SaSaveInfo createDocument​(java.lang.String ddcName, java.util.Properties namevaluePairs, java.io.InputStream[] content, java.lang.String versionComment)
      Deprecated.
      SaSaveInfo createDocument​(java.lang.String ddcName, java.util.Properties namevaluePairs, java.io.InputStream[] content, java.lang.String versionComment, java.lang.String acls)
      Deprecated.
      void createExternalStorageFolderMapping​(SaperionExternalStorageMappingInfo mappingInfo)
      Stores the mapping information about Saperion document and External Storage folder
      java.lang.String createFolder​(SaFolderSaveInfo info, java.util.Properties namevaluePairs)
      Creates a new folder below a given folder.
      java.lang.String createFolder​(java.lang.String folderTableDDC, java.lang.String parentId, java.lang.String beforeChild, java.lang.String folderName, SaFolderConstants.FOLDER_TYPE folderType, java.util.Properties namevaluePairs)
      Deprecated.
      SaSaveInfo createLink​(LinkInfo link)
      Creates a link to a document for given LinkInfo.
      void deleteDocument​(java.lang.String documentHDOC, int deleteType)
      Deletes a document from the backend system with the given delete type strategy.
      int deleteExternalStorageFolderMapping​(java.util.Date expiryTime, java.util.List<ExternalStorageDocUploadStatus> statusList)
      Deletes external storage mappings for given status and older than the given time
      void deleteFolder​(java.lang.String folderTableDDC, java.lang.String folderId)
      Deletes an existing folder.
      boolean deleteSetting​(java.lang.String name, java.lang.String section, boolean isLong)
      This method deletes a setting in the database.
      void discardCheckout​(java.lang.String hDoc)
      Discards a checkout of a document which was performed via the method SaClassicConnector.checkoutDocument(String).
      java.lang.String executeCommand​(ContextInfo contextInfo)
      Performs the given command.
      java.lang.String getACLNames​(java.lang.String documentHDOC)
      This method returns the names of the Access Control Lists that are assigned to this document.
      SaACLRights getACLRights​(java.lang.String[] acls)
      This method returns the access rights the current user has when in the context of the Access Controll Lists given by name.
      java.util.List<SaAcl> getAcls()
      This method returns all Access Control Lists in the current tenant.
      java.util.List<java.lang.String> getAllACLs()
      Deprecated.
      java.lang.String getAnnotations​(java.lang.String hDoc, int indexOfContentElement)
      Deprecated.
      java.lang.String getAnnotations​(java.lang.String hDoc, int indexOfContentElement, boolean currentRevision)
      Reads the annotations of the document with the specified ID.
      int getArchivedSize​(java.lang.String hDoc)
      Returns the total document size in the archive in bytes.
      java.util.List<UsersRights> getAuthorizedUsers​(java.lang.String hDoc, java.lang.String rights, MatchKind match)
      This method returns the users that have specific rights on a document.
      java.lang.Long getBoxCount​(int boxId)
      Reads the count (number of workflow item) of the inbox identified by the given id.
      java.util.List<BoxDefinition> getBoxDefinitions()
      Reads the box definitions.
      SaRMIClientCommand getClientConnector()  
      java.util.Collection<CommandInfo> getCommandInfos​(java.lang.String docUID)
      Reads all possible transitions for this task.
      java.util.Collection<CommandInfo> getCommandInfos​(java.lang.String docUID, boolean transitionsOnly)
      Reads all possible transitions and optional other possible commands for this task.
      java.util.List<CommentInfo> getCommentInfos​(java.lang.String taskId)
      Reads the comments for the given task.
      java.util.List<java.util.List<HistoryInfo>> getCompleteHistoryInfos​(java.lang.String docId)
      Reads the history and comments for the given document.
      java.util.Properties getConfiguration​(java.lang.String section)
      This method reads the application configuration properties from the backend system.
      SaUserInfo getCurrentUserInfo()
      This method returns detailed info about the current user.
      java.lang.String getCurrentUserName()
      This method returns the name of teh user currently logged in.
      com.lexmark.saperion.administration.RoleType getCurrentUserRole()  
      SaFieldDescription[] getDBDefinition​(java.lang.String name)
      This method reads the field definitions of the database definition (DDC) with the given name.
      DDC getDDC​(java.lang.String ddcName)
      This method returns a document definition given by its name.
      java.lang.String[] getDefinitions()
      This method returns the names of all DDCs registered in the Saperion system.
      SaDocAccessData getDocumentAccessData​(java.lang.String documentHDOC)
      This method reads the access rights the current user has on a given document.
      long getDocumentFolderCount​(java.lang.String folderTableDDC, java.lang.String documentDDC, java.lang.String sysRowId)
      Returns the total count over all folders from all users in which the specified document is contained in.
      java.util.List<SaDocumentInfo> getDocumentFolders​(java.lang.String folderTableDDC, java.lang.String documentDDC, java.lang.String sysRowId)
      Returns a list of folder properties which contains all folders the document is contained in.
      SaDocInfo getDocumentInfo​(java.lang.String hDoc, boolean currentRevision, boolean resolveLinks)
      Reads information like the document-structure and variables for the given document.
      SaDocInfo getDocumentInfo​(java.lang.String hDoc, boolean currentRevision, boolean resolveLinks, boolean forceSizeDetermination)
      Reads information like the document-structure and variables for the given document.
      boolean getEventsEnabled()
      This method returns whether events (e.g.
      java.util.List<SaperionExternalStorageMappingInfo> getExternalStorageFoldersForUpload()
      Fetches all folders of all types of External Storage services from where documents need to be uploaded
      java.util.List<SaperionExternalStorageMappingInfo> getExternalStorageFoldersForUpload​(ExternalStorageType storageType)
      Fetches all folders of External Storage from where documents need to be uploaded
      SaperionExternalStorageMappingInfo getExternalStorageMapping​(java.lang.String sysRowId)
      Fetches the external storage mapping for the provided SysRowId
      SaFeature getFeatures()
      This method returns the features enabled in the Saperion system.
      SaDocumentInfo getFolderByPath​(java.lang.String folderTableDDC, java.lang.String startFolderId, java.lang.String folderPath)
      Returns the folder which matches to the given path.
      java.util.List<SaDocumentInfo> getFolderChildren​(java.lang.String folderTableDDC, java.lang.String folderId, int depth, SaQueryInfo filter, int allowedMaxNrOfChildFolders)
      Returns a list with the children of the given node.
      SaFolderClass getFolderClass​(java.lang.String className)
      Reads the folder class with the given name.
      java.lang.String[] getFolderDefinitions()
      Reads the registered folder DDC names from the repository.
      java.util.List<SaDocumentInfo> getFolderFromPath​(java.lang.String folderTableDDC, java.lang.String startNodeId, java.lang.String folderPath)
      Returns the folders which match to the given path.
      SaDocumentInfo getFolderInfo​(java.lang.String folderTableDDC, java.lang.String folderId)
      Deprecated.
      SaDocumentInfo getFolderInfo​(java.lang.String folderTableDDC, java.lang.String folderId, boolean forceLoadVariables)
      Returns the folder information object for the given folder.
      SaDocumentInfo getFolderParent​(java.lang.String folderTableDDC, java.lang.String folderId)
      Returns the parent of the given folder.
      SaDocAccessData getFolderRights​(java.lang.String folderTableDDC, java.lang.String folderId)
      Returns the rights mask for the given folder and user.
      java.util.Set<FolderUpdateInfo> getFolderUpdateInfo​(java.util.Map<java.lang.String,​java.lang.Long> folderIds)
      Deprecated.
      java.lang.String getFulltext​(java.lang.String ddcName, java.lang.String sysRowId)
      Deprecated.
      java.lang.String getFulltext​(java.lang.String ddcName, java.lang.String hdoc, java.lang.String fieldName, long length)
      Reads the fulltext information for the given document with the given HDOC in the given DDC from the specified field.
      java.util.Set<java.util.Map.Entry<java.lang.String,​java.lang.String>> getFullTextFields​(java.lang.String ddcName, java.util.List<java.lang.String> fullTextFields, java.lang.String hdoc)
      See SaClassicConnector.getFullTextFields(String, List, String)
      java.util.List<HistoryInfo> getHistoryInfos​(java.lang.String taskId)
      Reads the history for the given task.
      java.util.List<java.lang.String> getInvolvedUsers​(java.lang.String documentHDOC)
      Lists the names of all users that are contained in all Access Control Lists set on the given document.
      int getLicenseCount​(int type)
      This method returns the overall count of Licenses of the given type in the system.
      SaLockInfo getLockInfo​(java.lang.String sysRowId)
      This method returns the locking information for a given document.
      WorkflowMember getMember​(WorkflowMember member, int depth, java.lang.String filter)
      Returns the workflow members by the given parameters.
      This method is considered as a search-method.
      WorkflowMember getMembers()
      Reads the workflow members in a full structured tree.
      boolean getOutOfOffice()
      Get the substitute for the logged on user.
      TaskInfo getParentTask​(java.lang.String taskID)
      Reads the parent task info for the given ID.
      java.lang.String getReleaseAclName()
      Gets the release ACL name, configured in the program.ini in section [Release].
      java.lang.String getReleasedHdoc​(java.lang.String oldHdoc)
      Gets the released hdoc for given hdoc if release feature is on and release tag is set, otherwise returns the given hDoc.
      java.util.List<com.saperion.connector.renditions.Rendition> getRendition​(Element element, com.saperion.connector.options.Options options)
      Returns the rendition object from a rendered document.
      java.util.List<SaRMIServerInfo> getServerInfos()  
      ServerSideClientConfiguration getServerSideClientConfiguration()
      This method returns the configuration concerning the classic connector that is set on the server side.
      com.saperion.connector.authentication.Session getSession()
      Returns the session of the logged in user.
      Setting getSetting​(java.lang.String name, java.lang.String section, boolean isLong)
      This method retrieves a Setting identified by it's key and section from the database.
      java.lang.String getSubstitute()
      Get the substitute for the logged on user.
      java.util.Set<com.saperion.connector.formats.SourceFormat> getSupportedRenderSourceFormats()
      Gets the supported source formats from the render engine.
      java.util.Set<com.saperion.connector.formats.TargetFormat> getSupportedRenderTargetFormats()
      Gets the supported target formats from the render engine.
      java.util.List<java.lang.String> getSystemFiles​(SystemFileKind kind, java.lang.String filter)
      This method returns the names of all system files of a specific kind.
      SaSystemInfo getSystemInfo()
      This method returns general information about the connected system.
      SaSystemSetting getSystemSetting​(java.lang.String accessKey)
      Retrieves a system setting object.
      TaskInfo getTask​(java.lang.String taskID)
      Reads the task info for the given ID.
      java.util.List<TaskAuditInfo> getTaskAuditList​(int[] ids, java.lang.String filter, java.util.Map<java.lang.String,​java.lang.Object> parameter)
      Reads the task audits for this user.
      java.util.List<TaskInfo> getTaskList​(int[] ids, java.lang.String filter, java.util.Map<java.lang.String,​java.lang.Object> parameter)
      Reads the tasks for this user.
      byte[] getThumbnail​(java.lang.String hDoc, int widthX, int widthY, boolean color)
      Reads the thumbnail of the given document.
      int getToken()  
      java.util.List<java.lang.String> getUsers​(java.lang.String filter)
      Reads a list of filtered users.
      SaUserSetting getUserSetting​(java.lang.String accessKey)
      Retrieves a user-specific setting object.
      java.util.List<java.lang.String> getVersionIDs​(java.lang.String ddcName, java.lang.String sysrowID)
      Reads the version IDs of the given document.
      SaWFConnector getWorkflowConnector()
      Returns a workflow connector based on this classic connector.
      java.lang.String getWorkflowDdcName()
      Gets the workflow ddc name.
      java.util.List<java.lang.String> getWorkflowDefinitions()
      Reads all available workflow definitions.
      java.util.List<ProcessDefinitionDescriptor> getWorkflowDefinitions​(java.lang.String ddcName)
      Returns the workflow definitions that are allowed to be used for documents contained in the specified DDC.
      int hashCode()  
      boolean hasRenderEngine()
      Checks wether this classic connector has a render engine.
      <T extends java.io.Serializable>
      T      		 invoke​(LegacyOperation<T> operation)
      Invokes the given Operation on the server side.
      boolean isActive()
      Checks, if the connector is logged on.
      boolean isAlive()
      Tests the lifetime of this connector.
      boolean isReleaseActive()
      Checks if is release feature in the program.ini in section [Release] is active.
      java.util.List<com.saperion.connector.authentication.Session> listActiveSessions()
      List active sessions of the logged in user
      java.util.Map<java.lang.String,​java.lang.String> loadLocalize​(java.lang.String language)
      Load localize.
      java.io.InputStream loadSystemFile​(SystemFileKind kind, java.lang.String name)
      This method loads a system file of a specific kind.
      boolean lockDocument​(java.lang.String sysRowId, java.lang.String ddcName)
      Locks a document.
      void logClientEvent​(java.lang.String hdoc, SaConstants.ProtoEvents event, java.lang.String remark)
      Adds an audit log event.
      boolean logoff()
      This method logs the current user off from the system.
      int logon​(byte[] token, int type, java.lang.String client)
      Deprecated.
      com.saperion.connector.authentication.Session logon​(com.lexmark.saperion.remote.common.authentication.Credentials credentials)
      This method authenticates the given Credentials and returns the information about the open session.
      com.saperion.connector.authentication.Session logon​(com.lexmark.saperion.remote.common.authentication.Credentials credentials, com.saperion.connector.authentication.SessionInfo sessionInfo)
      This method authenticates the given Credentials, associate the given SessionInfo and returns the information about the open session.
      int logon​(java.lang.String username, java.lang.String password, int type, java.lang.String client)
      This method authenticates the given user and returns the token of the newly created session.
      int logon​(jcifs.smb.NtlmPasswordAuthentication auth, int type, java.lang.String client)
      Deprecated.
      void moveFolder​(java.lang.String folderTableDDC, java.lang.String folderId, java.lang.String destinationId, java.lang.String beforeChild)
      Moves the given folder to a new destination.
      void moveToFolder​(java.lang.String folderTableDDC, java.lang.String documentId, java.lang.String documentDDC, java.lang.String folderId, java.lang.String destinationId)
      Removes the document from the source folder and adds it to the source folder.
      java.io.InputStream readDocument​(java.lang.String docHdoc, boolean currentRevision, int elementNumber)
      Loads a document's content from the backend system.
      java.io.InputStream readDocument​(java.lang.String docHdoc, boolean currentRevision, int elementNumber, boolean withAnnotations)
      Loads a document's content from the backend system.
      java.lang.String readDocumentFilename​(java.lang.String docHdoc, boolean currentRevision, int elementNumber)
      Reads the filenames of the application data of the document with the given ID.
      SaPropertyValue[] readDocumentMetadata​(java.lang.String documentSysRowID, java.lang.String ddcName, java.lang.String[] fields)
      Reads the metadata of the document with the given ID.
      java.io.InputStream readReleasedDocument​(java.lang.String docHdoc, boolean currentRevision, int elementNumber)
      Read released document if the release feature is active.
      java.io.InputStream readVersionDocument​(java.lang.String docHdoc, int elementNumber)
      Loads a document version from the backend system.
      java.lang.String readVersionDocumentFilename​(java.lang.String docHdoc, int elementNumber)
      Reads the filenames of the application data of the document with the given ID.
      SaVersionData readVersionMetadata​(java.lang.String versionID)
      Reads the version metadata of the document with the given ID.
      SaVersionData readVersionMetadata​(java.lang.String versionID, boolean resolveLinks)
      Reads the version metadata of the document with the given ID.
      void releaseDocument​(java.lang.String ddcName, java.lang.String hDoc, java.lang.String versionComment)
      Release the given document.
      boolean removeEvent​(SaEvent event)
      Deprecated.
      void removeFromFolder​(java.lang.String folderTableDDC, java.lang.String documentSysRowId, java.lang.String documentDDC, java.lang.String folderId)
      Removes the document from the given folder.
      void removeListener​(SaEventListener listener)
      Deprecated.
      void removeListener​(SaStatusEventListener listener)
      Deprecated.
      java.lang.String resolveLatestHDoc​(java.lang.String oldHdoc)
      Resolves and returns the XHDOC of the latest version of the document identified by the given HDOC.
      SaSaveInfo restoreVersion​(java.lang.String versionID)
      Restores the version with the given HDOC.
      java.util.List<SaPropertyValue[]> search​(java.lang.String hqlQuery)
      Deprecated.
      java.util.Set<SaFolderClass> searchFolderClass​(SaFolderClassSearchInfo searchInfo)
      Searches for folder classes that match the specified propertied.
      java.util.List<SaDocumentInfo> searchFolderDocuments​(java.lang.String folderTableDDC, java.lang.String folderId, SaQueryInfo hqlFilter)
      HQL search extended with additional folder informations and depth.
      java.util.List<SaDocumentInfo> searchHQL​(SaQueryInfo hqlQuery)
      Performs a search with the given hql query (hibernate query language).
      SettingSearchResult searchSettings​(SettingSearchInfo searchInfo)
      This method searches settings in the database.
      void sendBarcode​(java.lang.String indexMask, java.lang.String docUid, java.lang.String contentRep, java.lang.String sid, java.lang.String docType, java.lang.String value, int mandant)
      Sends the Document UID with the barcode to SAP R/3.
      SaSaveInfo setACLName​(java.lang.String ddcname, java.lang.String documentHDOC, java.lang.String acl, java.lang.String versionComment)
      This method specifies the Access Control Lists that secure the document given by its id.
      void setAnnotations​(java.lang.String hDoc, int indexOfContentElement, java.lang.String annotations)
      Sets the given annotations to the document.
      void setCurrentUserPresent​(boolean present)
      Sets whether the current user is present.
      void setEventsEnabled​(boolean enabled)
      This method sets whether events (e.g.
      void setFolderAcl​(java.lang.String folderTableDDC, java.lang.String folderId, java.lang.String aclName)
      Sets an ACL for the given folder.
      void setLocale​(java.util.Locale locale)
      This methods sets the localization information for the current user.
      void setOutOfOffice​(boolean isOutOfOffice)
      set the out of office status for the logged on user.
      void setSetting​(Setting setting)
      This method stores a Setting in the database.
      void setSubstitute​(java.lang.String name)
      Set the substitute for the logged on user.
      boolean setUsedLicense​(int type, int count)
      Set the count of used licenses.
      void setUserSetting​(SaUserSetting setting)
      Persists a user-specific setting object.
      void stopServer()
      Deprecated.
      void storeSystemFile​(SystemFileKind kind, java.lang.String name, java.io.InputStream data)
      This method stores a system file of a specific kind.
      java.lang.String toString()  
      boolean unlockDocument​(java.lang.String sysRowId, java.lang.String ddcName)
      Unlocks a document.
      void updateCurrentUserInformation​(MutableUserInformation user)
      Changes information about the current user.
      SaSaveInfo updateDocument​(UpdateDocumentInfo updateInfo)
      Updates a document in the backend system with the given metadata, acls and content.
      SaSaveInfo updateDocument​(java.lang.String ddcName, java.lang.String documentHDOC, java.util.Properties namevaluePairs, java.io.InputStream[] content, java.lang.String versionComment)
      Deprecated.
      SaSaveInfo updateDocument​(java.lang.String ddcName, java.lang.String documentHDOC, java.util.Properties namevaluePairs, java.io.InputStream[] content, java.lang.String versionComment, java.lang.String acls)
      Deprecated.
      SaSaveInfo updateDocument​(java.lang.String ddcName, java.lang.String documentHDOC, java.util.Properties namevaluePairs, java.io.InputStream[] content, java.lang.String versionComment, java.lang.String acls, boolean resolveLinks)
      Deprecated.
      SaSaveInfo updateDocument​(java.lang.String ddcName, java.lang.String documentHDOC, java.util.Properties namevaluePairs, java.io.InputStream[] content, java.lang.String versionComment, java.lang.String acls, boolean resolveLinks, boolean checkin)
      Deprecated.
      void updateExternalStorageUploadStatus​(java.lang.String folderId, ExternalStorageDocUploadStatus status, ExternalStorageType storageType)
      Updates the upload status of External Storage folder
      void updateFolder​(java.lang.String folderTableDDC, java.lang.String folderId, java.util.Properties namevaluePairs)
      Updates an existing folder with the given properties.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait
Specified by:
getAnnotations in interface SaClassicConnector
Parameters:
hDoc - Document HDOC
indexOfContentElement - the index of the chosen context element
currentRevision - true to get current revision
Returns:
Annotation string as describe above
Throws:
SaAuthenticationException - if the user is not logged in or has insufficient rights
SaSystemException - if a backend system error occurs