Package com.saperion.connector

Interface SaClassicConnector

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods 
      Modifier and Type Method Description
      void addListener​(SaEventListener listener)
      Deprecated.
      will be removed with version 8.1
      void addListener​(SaStatusEventListener listener)
      Deprecated.
      will be removed with version 8.1
      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.
      will be removed with version 8.1, use createDocument(DocumentInfo) instead.
      SaSaveInfo createDocument​(java.lang.String ddcName, java.util.Properties namevaluePairs, java.io.InputStream[] content, java.lang.String versionComment, java.lang.String acls)
      Deprecated.
      will be removed with version 8.1, use createDocument(DocumentInfo) instead.
      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.
      use createFolder(SaFolderSaveInfo, Properties) instead.
      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 checkoutDocument(String).
      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.
      use getAcls() instead.
      java.lang.String getAnnotations​(java.lang.String hDoc, int indexOfContentElement)
      Deprecated.
      use getAnnotations(String, int, boolean) instead.
      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.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)
      Deprecated.
      use getDDC(String) instead.
      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 startFolderId, java.lang.String folderPath)
      Returns the folders which match to the given path.
      SaDocumentInfo getFolderInfo​(java.lang.String folderTableDDC, java.lang.String folderId)
      Deprecated.
      use getFolderInfo(String, String, boolean) instead.
      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.
      No longer supported.
      java.lang.String getFulltext​(java.lang.String ddcName, java.lang.String sysRowId)
      Deprecated.
      Will be removed in 8.1.
      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.
      default 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)
      Fetches values of Full text columns
      java.util.List<java.lang.String> getInvolvedUsers​(java.lang.String documentHDOC)
      Deprecated.
      use getAuthorizedUsers(String, String, MatchKind) instead.
      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.
      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.
      ServerSideClientConfiguration getServerSideClientConfiguration()
      This method returns the configuration concerning the classic connector that is set on the server side.
      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.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.
      byte[] getThumbnail​(java.lang.String hDoc, int widthX, int widthY, boolean color)
      Reads the thumbnail of the given document.
      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.
      boolean hasRenderEngine()
      Checks wether this classic connector has a render engine.
      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.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.
      will be removed with version 8.1
      default com.saperion.connector.authentication.Session logon​(int rmiToken)
      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)
      Deprecated.
      use logon(Credentials) with UsernamePasswordKey instead.
      int logon​(jcifs.smb.NtlmPasswordAuthentication auth, int type, java.lang.String client)
      Deprecated.
      will be removed with version 8.1
      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 documentHDOC, 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 documentHDOC, boolean currentRevision, int elementNumber)
      Deprecated.
      will be removed with version 8.1
      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 versionID, int elementNumber)
      Loads a document version from the backend system.
      java.lang.String readVersionDocumentFilename​(java.lang.String documentHDOC, int elementNumber)
      Deprecated.
      use getDocumentInfo.getFullName() instead.
      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.
      no longer supported.
      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.
      will be removed with version 8.1
      void removeListener​(SaStatusEventListener listener)
      Deprecated.
      will be removed with version 8.1
      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.
      Use searchHQL() instead.
      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)
      Deprecated.
      Use updateCurrentUserInformation(MutableUserInformation) instead.
      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 setSetting​(Setting setting)
      This method stores a Setting in the database.
      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.
      Functionality removed because of security-concerns.
      void storeSystemFile​(SystemFileKind kind, java.lang.String name, java.io.InputStream data)
      This method stores a system file of a specific kind.
      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.
      will be removed with version 8.1, use updateDocument(UpdateDocumentInfo) instead.
      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.
      will be removed with version 8.1
      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.
      will be removed with version 8.1
      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.
      will be removed with version 8.1
      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.

    • Method Detail

      • getConfiguration

        java.util.Properties getConfiguration​(java.lang.String section)
                               throws SaSystemException,
                                      SaAuthenticationException
        This method reads the application configuration properties from the backend system.
        Parameters:
        section - the name of the section in the archief.ini to load configuration properties from
        Returns:
        Configuration properties as key-value pairs
        Throws:
        SaSystemException - SaSystemException
        SaAuthenticationException - SaAuthenticationException

      • stopServer

        @Deprecated
void stopServer()
         throws SaSystemException,
                SaAuthenticationException
        Deprecated.
        Functionality removed because of security-concerns. Method contained for compatibility only. Use windows service management tool or SAPERION MMC to stop the server. Will be removed with version 8.1.
        Stops the remote server.
        Throws:
        SaSystemException - SaSystemException
        SaAuthenticationException - SaAuthenticationException

      • removeListener

        @Deprecated
void removeListener​(SaEventListener listener)
             throws SaSystemException
        Deprecated.
        will be removed with version 8.1
        Removes a listener from the handler.
        Parameters:
        listener - Event listener
        Throws:
        SaSystemException - SaSystemException

      • removeListener

        @Deprecated
void removeListener​(SaStatusEventListener listener)
             throws SaSystemException
        Deprecated.
        will be removed with version 8.1
        Removes a listener from the handler.
        Parameters:
        listener - Event listener
        Throws:
        SaSystemException - SaSystemException

      • getDBDefinition

        @Deprecated
SaFieldDescription[] getDBDefinition​(java.lang.String name)
                              throws SaSystemException,
                                     SaAuthenticationException
        Deprecated.
        use getDDC(String) instead. Will be removed in version 8.1
        This method reads the field definitions of the database definition (DDC) with the given name.
        Parameters:
        name - the name of the database definition (DDC) to get the fields of
        Returns:
        an array of all field definitions SaFieldDescription in the definition
        Throws:
        SaAuthenticationException - when the classic connector is not authenticated or the current user has not the required rights for the operation
        SaSystemException - on general system failures

      • getSystemInfo

        SaSystemInfo getSystemInfo()
                    throws SaSystemException
        This method returns general information about the connected system.
        Returns:
        general information about the connected system
        Throws:
        SaSystemException - on general system failures

      • getFeatures

        SaFeature getFeatures()
               throws SaSystemException
        This method returns the features enabled in the Saperion system.
        Returns:
        the features enabled in the Saperion system
        Throws:
        SaSystemException - on general system failures

      • getUserSetting

        SaUserSetting getUserSetting​(java.lang.String accessKey)
                      throws SaSystemException,
                             SaAuthenticationException
        Retrieves a user-specific setting object. User-specific settings are stored in the system's ini-files.
        Parameters:
        accessKey - The key to get associated user setting. The key consists of the type of the setting and a key to identify the setting separated by '|'.



        Example: How to read a section from Saperion's ini-files:

        PROPERTIES|TheNameOfTheSection


        If the section's name contains a tenant-specific hex-id, you can use the placeholders $my_tenant$, which will be replaced by the current tenant's ID and $all_tenants$, which will be replaced by the ID representing all tenants.
        Returns:
        SaUserSetting
        Throws:
        SaSystemException - System exception
        SaAuthenticationException - when the user is not logged in or has insufficient rights

      • getSetting

        Setting getSetting​(java.lang.String name,
                   java.lang.String section,
                   boolean isLong)
            throws SaSystemException,
                   SaAuthenticationException
        This method retrieves a Setting identified by it's key and section from the database.
        Parameters:
        name - the setting's name
        section - the setting's section
        isLong - whether this is a setting with a long (>2KB) value or not
        Returns:
        the setting or null if no setting with the specified key and section was found
        Throws:
        SaSystemException - system error when retrieving the setting
        SaAuthenticationException - authentication error when retrieving the setting

      • deleteSetting

        boolean deleteSetting​(java.lang.String name,
                      java.lang.String section,
                      boolean isLong)
               throws SaSystemException,
                      SaAuthenticationException
        This method deletes a setting in the database.
        Parameters:
        name - the name of the setting to delete
        section - the section of the setting to delete
        isLong - whether this is a setting with a long (>2KB) value or not
        Returns:
        true if the setting was deleted, false if there was no such setting
        Throws:
        SaSystemException - system exception when deleting the setting
        SaAuthenticationException - when the user is not logged in or has insufficient rights when deleting the setting

      • logon

        @Deprecated
int logon​(java.lang.String username,
          java.lang.String password,
          int type,
          java.lang.String client)
   throws SaAuthenticationException,
          SaSystemException
        Deprecated.
        use logon(Credentials) with UsernamePasswordKey instead. Will be removed in version 8.1.
        This method authenticates the given user and returns the token of the newly created session.
        Parameters:
        username - User's full name
        password - Password
        type - User type that means client license type. There are possible the following integer values:
      • 1 = index
      • 2 = query
      • 3 = univeral administrator
      • 4 = web query
      • 7 = web index
      • 12 = workflow
      • 13 = scan
      • 14 = highend scan
      • 15 = API query
      • 16 = API index
      • 17 = API scan
      • 20 = basic administrator
      • 29 = web workflow
        • client - client/mandant name, used in multi-client systems
        Returns:
        User token for the current session.
        Throws:
        SaAuthenticationException - when the user is not logged in or has insufficient rights
        SaSystemException - SaSystemException

      • logon

        @Deprecated
int logon​(jcifs.smb.NtlmPasswordAuthentication auth,
          int type,
          java.lang.String client)
   throws SaAuthenticationException,
          SaSystemException
        Deprecated.
        will be removed with version 8.1
        Performs a logon with NTLM authentication.
        Parameters:
        auth - Ntlm authentication object
        type - User type that means client license type. There are possible the following integer values:
      • 1 = index
      • 2 = query
      • 3 = univeral administrator
      • 4 = web query
      • 7 = web index
      • 12 = workflow
      • 13 = scan
      • 14 = highend scan
      • 15 = API query
      • 16 = API index
      • 17 = API scan
      • 20 = basic administrator
      • 29 = web workflow
        • client - client/mandant name, used in multi-client systems
        Returns:
        User token for the current session.
        Throws:
        SaAuthenticationException - when the user is not logged in or has insufficient rights
        SaSystemException - SaSystemException

      • logon

        com.saperion.connector.authentication.Session logon​(com.lexmark.saperion.remote.common.authentication.Credentials credentials)
                                             throws SaAuthenticationException,
                                                    SaSystemException
        This method authenticates the given Credentials and returns the information about the open session.
        Parameters:
        credentials - credentials that authorize and authenticate the session returned
        Returns:
        information about the created session
        Throws:
        SaAuthenticationException - thrown if logon was not possible with the given credentials
        SaSystemException - thrown if the system is not reachable

      • logon

        com.saperion.connector.authentication.Session logon​(com.lexmark.saperion.remote.common.authentication.Credentials credentials,
                                                    com.saperion.connector.authentication.SessionInfo sessionInfo)
                                             throws SaAuthenticationException,
                                                    SaSystemException
        This method authenticates the given Credentials, associate the given SessionInfo and returns the information about the open session.
        Parameters:
        credentials - credentials that authorize and authenticate the session returned
        sessionInfo - The session information like user agent, remote address etc.
        Returns:
        information about the created session
        Throws:
        SaAuthenticationException - thrown if logon was not possible with the given credentials
        SaSystemException - thrown if the system is not reachable

      • logon

        @Deprecated
default com.saperion.connector.authentication.Session logon​(int rmiToken)
                                                     throws SaSystemException
        Deprecated.
        This method returns the information about the open session associated with given token
        Parameters:
        rmiToken - The rmi token associated with already created session
        Returns:
        information about the created session
        Throws:
        SaSystemException - thrown if the system is not reachable

      • getLicenseCount

        int getLicenseCount​(int type)
             throws SaSystemException
        This method returns the overall count of Licenses of the given type in the system.
        Parameters:
        type - the license type see LicenseType for values
        Returns:
        the overall count of Licenses of the given type in the system
        Throws:
        SaSystemException - Error on the saperion system

      • setUsedLicense

        boolean setUsedLicense​(int type,
                       int count)
                throws SaSystemException
        Set the count of used licenses.
        Parameters:
        type - Client type
        count - Number of licenses
        Returns:
        True, if success
        Throws:
        SaSystemException - Error on the saperion system

      • readDocument

        java.io.InputStream readDocument​(java.lang.String documentHDOC,
                                 boolean currentRevision,
                                 int elementNumber)
                          throws SaSystemException,
                                 SaAuthenticationException
        Loads a document's content from the backend system.

        This method creates a document's InputStream instance from the appropriate document in the backend system. This document is specified by its UID (XHDOC).
        The actual content of the document can be read by using InputStream.read()
        Parameters:
        documentHDOC - The ID of the document (XHDOC)
        currentRevision - flag indicating that the current revision of the document should be retrieved by resolving the XHDOC.
        elementNumber - position in the document structure; 0 if the document is unstructured, -1 returns a single multi-page tif containing all content elements, but only for COLD and multi-page tif documents
        Returns:
        InputStream containing the document content
        Throws:
        SaSystemException - if a backend system error occurs
        SaAuthenticationException - if the user is not logged in or has insufficient rights

      • readDocument

        java.io.InputStream readDocument​(java.lang.String docHdoc,
                                 boolean currentRevision,
                                 int elementNumber,
                                 boolean withAnnotations)
                          throws SaSystemException,
                                 SaAuthenticationException
        Loads a document's content from the backend system.

        This method creates a document's InputStream instance from the appropriate document in the backend system. This document is specified by its UID (XHDOC).
        The actual content of the document can be read by using InputStream.read()
        Parameters:
        docHdoc - The ID of the document (XHDOC)
        currentRevision - flag indicating that the current revision of the document should be retrieved by resolving the XHDOC.
        elementNumber - position in the document structure; 0 if the document is unstructured, -1 returns a single multi-page tif containing all content elements, but only for COLD and multi-page tif documents
        withAnnotations - if true, annotations will be saved on the document stream
        Returns:
        Input stream containing the document content
        Throws:
        SaSystemException - if a backend system error occurs
        SaAuthenticationException - if the user is not logged in or has insufficient rights

      • readReleasedDocument

        java.io.InputStream readReleasedDocument​(java.lang.String docHdoc,
                                         boolean currentRevision,
                                         int elementNumber)
                                  throws SaSystemException,
                                         SaAuthenticationException
        Read released document if the release feature is active.
        Parameters:
        docHdoc - the doc hdoc
        currentRevision - the current revision
        elementNumber - the element number
        Returns:
        the input stream
        Throws:
        SaSystemException - the sa system exception
        SaAuthenticationException - when the user is not logged in or has insufficient rights

      • readDocumentMetadata

        SaPropertyValue[] readDocumentMetadata​(java.lang.String documentSysRowID,
                                       java.lang.String ddcName,
                                       java.lang.String[] fields)
                                throws SaSystemException,
                                       SaAuthenticationException,
                                       SaDDCException
        Reads the metadata of the document with the given ID.

        The returned metadata fields depend on the corresponding document definition table (DDC).

        Parameters:
        documentSysRowID - The ID of the document (SYSROWID)
        ddcName - The name of the database definition
        fields - Fieldnames to be read. If empty or null, all fields will be read.
        Returns:
        The Metadata of the document represented as an array of SaPropertyValue instances.
        Throws:
        SaSystemException - if a backend system error occurs during the document creation
        SaAuthenticationException - if the user is not logged in or has insufficient rights
        SaDDCException - if a DDC related error occurs

      • getFulltext

        @Deprecated
java.lang.String getFulltext​(java.lang.String ddcName,
                             java.lang.String sysRowId)
                      throws SaSystemException,
                             SaAuthenticationException
        Deprecated.
        Will be removed in 8.1. Use getFulltext(String, String, String, long) instead.
        Reads the fulltext information for the given document with the given SYSROWID in the given DDC.
        Parameters:
        ddcName - DDC name of the document
        sysRowId - SYSROWID of the document
        Returns:
        Content of the fulltext for this document
        Throws:
        SaSystemException - if a backend system error occurs during the fulltext get operation
        SaAuthenticationException - if the user is not logged in or has insufficient rights

      • getFulltext

        java.lang.String getFulltext​(java.lang.String ddcName,
                             java.lang.String hdoc,
                             java.lang.String fieldName,
                             long length)
                      throws SaSystemException,
                             SaAuthenticationException
        Reads the fulltext information for the given document with the given HDOC in the given DDC from the specified field.
        Parameters:
        ddcName - DDC name of the document
        hdoc - HDOC of the document
        fieldName - name of the fulltext field to read from
        length - length of the content to return. If -1, the complete content will be returned.
        Returns:
        Content of the fulltext for this document as string.
        Throws:
        SaSystemException - if a backend system error occurs during the fulltext get operation
        SaAuthenticationException - if the user is not logged in or has insufficient rights

      • getThumbnail

        byte[] getThumbnail​(java.lang.String hDoc,
                    int widthX,
                    int widthY,
                    boolean color)
             throws SaSystemException,
                    SaAuthenticationException
        Reads the thumbnail of the given document. It is possible to set either widthX or widthY to -1 to auto-calculate the value. An empty array is returned, when no thumbnail is available.
        Parameters:
        hDoc - HDoc for the document.
        widthX - Width X or -1 to auto-calculate
        widthY - Width Y or -1 to auto-calculate
        color - True for colored
        Returns:
        Thumbnail BMP as byte array
        Throws:
        SaSystemException - System exception
        SaAuthenticationException - when the user is not logged in or has insufficient rights

      • createDocument

        @Deprecated
SaSaveInfo createDocument​(java.lang.String ddcName,
                          java.util.Properties namevaluePairs,
                          java.io.InputStream[] content,
                          java.lang.String versionComment)
                   throws SaSystemException,
                          SaAuthenticationException,
                          SaDDCException
        Deprecated.
        will be removed with version 8.1, use createDocument(DocumentInfo) instead.
        Creates a new document on the backend system with the given metadata and content.
        Parameters:
        ddcName - The name of the database definition
        namevaluePairs - A properties object containing the metadata of the document (e.g index fields and their values)
        content - Multiple content data (an array of InputStream instances)
        versionComment - The comment for the version
        Returns:
        SaSaveInfo object describing the document
        Throws:
        SaSystemException - SaSystemException
        SaAuthenticationException - if the user is not logged in or has insufficient rights
        SaDDCException - if a DDC related error occurs

      • updateDocument

        @Deprecated
SaSaveInfo updateDocument​(java.lang.String ddcName,
                          java.lang.String documentHDOC,
                          java.util.Properties namevaluePairs,
                          java.io.InputStream[] content,
                          java.lang.String versionComment)
                   throws SaSystemException,
                          SaAuthenticationException,
                          SaDDCException
        Deprecated.
        will be removed with version 8.1, use updateDocument(UpdateDocumentInfo) instead.
        Updates a document in the backend system with the given metadata and content. Only the attached metadata and elements are changed. If the document was checked out, it will be automatically checked in.
        Parameters:
        ddcName - The name of the database definition
        documentHDOC - The ID of the document (HDOC)
        namevaluePairs - A properties object containing the metadata
        content - Multiple content data
        versionComment - The comment for the version
        Returns:
        SaSaveInfo SaSaveInfo object describing the document
        Throws:
        SaSystemException - if a backend system error occurs
        SaAuthenticationException - if the user is not logged in or has insufficient rights
        SaDDCException - if a DDC related error occurs

      • createDocument

        @Deprecated
SaSaveInfo createDocument​(java.lang.String ddcName,
                          java.util.Properties namevaluePairs,
                          java.io.InputStream[] content,
                          java.lang.String versionComment,
                          java.lang.String acls)
                   throws SaSystemException,
                          SaAuthenticationException,
                          SaDDCException
        Deprecated.
        will be removed with version 8.1, use createDocument(DocumentInfo) instead.
        Creates a new document on the backend system with the given metadata, acl's and content.
        Parameters:
        ddcName - The name of the database definition
        namevaluePairs - A properties object containing the metadata of the document (e.g index fields and their values)
        content - Multiple content data (an array of InputStream instances)
        versionComment - The comment for the version
        acls - ACL name string (semicolon separated)
        Returns:
        SaSaveInfo SaSaveInfo object describing the new created document
        Throws:
        SaSystemException - if a backend system error occurs during the document creation
        SaAuthenticationException - if the user is not logged in or has insufficient rights
        SaDDCException - if a DDC related error occurs

      • updateDocument

        @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)
                   throws SaSystemException,
                          SaAuthenticationException,
                          SaDDCException
        Deprecated.
        will be removed with version 8.1
        Updates a document in the backend system with the given metadata, acls and content. Only the attached metadata and elements are changed. If the document was checked out, it will be automatically checked in. NOTE: With this method it is possible to update documents that are locked or checked out by other users. If this behaviour is not desired one has to implement the according checks oneself using searchHQL(SaQueryInfo), SaDocumentInfo.isCheckedout() and SaDocumentInfo.isLocked().
        Parameters:
        ddcName - The name of the database definition
        documentHDOC - The ID of the document (HDOC)
        namevaluePairs - A properties object containing the metadata
        content - Multiple content data
        versionComment - The comment for the version
        acls - ACL name string, if null it will be ignored, to delete existing ACLs set an empty string
        Returns:
        SaSaveInfo SaSaveInfo object describing the document
        Throws:
        SaSystemException - if a backend system error occurs
        SaAuthenticationException - if the user is not logged in or has insufficient rights
        SaDDCException - if a DDC related error occurs

      • updateDocument

        @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)
                   throws SaSystemException,
                          SaAuthenticationException,
                          SaDDCException
        Deprecated.
        will be removed with version 8.1
        Updates a document in the backend system with the given metadata, acls and content. Only the attached metadata and elements are changed. If the document was checked out, it will be automatically checked in. NOTE: With this method it is possible to update documents that are locked or checked out by other users. If this behaviour is not desired one has to implement the according checks oneself using searchHQL(SaQueryInfo), SaDocumentInfo.isCheckedout() and SaDocumentInfo.isLocked().
        Parameters:
        ddcName - The name of the database definition
        documentHDOC - The ID of the document (HDOC)
        namevaluePairs - A properties object containing the metadata
        content - Multiple content data
        versionComment - The comment for the version
        acls - ACL name string, if null it will be ignored, to delete existing ACLs set an empty string
        resolveLinks - Resolve links
        Returns:
        SaSaveInfo SaSaveInfo object describing the document
        Throws:
        SaSystemException - if a backend system error occurs
        SaAuthenticationException - if the user is not logged in or has insufficient rights
        SaDDCException - if a DDC related error occurs

      • updateDocument

        @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)
                   throws SaSystemException,
                          SaAuthenticationException,
                          SaDDCException
        Deprecated.
        will be removed with version 8.1
        Updates a document in the backend system with the given metadata, acls and content. Only the attached metadata and elements are changed. If the document was checked out, it will be automatically checked in. NOTE: With this method it is possible to update documents that are locked or checked out by other users. If this behaviour is not desired one has to implement the according checks oneself using searchHQL(SaQueryInfo), SaDocumentInfo.isCheckedout() and SaDocumentInfo.isLocked().
        Parameters:
        ddcName - The name of the database definition
        documentHDOC - The ID of the document (HDOC)
        namevaluePairs - A properties object containing the metadata
        content - Multiple content data
        versionComment - The comment for the version
        acls - ACL name string, if null it will be ignored, to delete existing ACLs set an empty string
        resolveLinks - Resolve links
        checkin - Checkin document
        Returns:
        SaSaveInfo SaSaveInfo object describing the document
        Throws:
        SaSystemException - if a system error occured
        SaAuthenticationException - if the user is not logged in or has insufficient rights
        SaDDCException - if a database definition was invalid or not found

      • checkoutDocument

        void checkoutDocument​(java.lang.String hDoc,
                      boolean withCloudShare,
                      int[] shareBaseDocIds)
               throws SaSystemException,
                      SaAuthenticationException,
                      SaGetNodeException
        Checks out a document with filesystem/ShareBase for the given document id (hdoc).

        This call should be performed before a document is edited to protect the document from conflicting changes. The checkin-operation is performed when the document is saved using updateDocument(UpdateDocumentInfo).

        Note:
        While the document is checked out, other users are able to access a read-only version of the latest revision, but they are not able to modify the document until the check out is discarded via discardCheckout(String) or persisted via updateDocument(UpdateDocumentInfo).

        Parameters:
        hDoc - id (HDOC) of document to checkout
        withCloudShare - true if open document is checked out with ShareBase else false
        shareBaseDocIds - Array of sharebase doc ids for open checkout docs
        Throws:
        SaSystemException - if a backend system error occurs during the check out operation
        SaAuthenticationException - if the user is not logged in or has insufficient rights
        SaGetNodeException - if an error occurs while getting the document node or content

      • getReleasedHdoc

        java.lang.String getReleasedHdoc​(java.lang.String oldHdoc)
                          throws SaAuthenticationException,
                                 SaSystemException
        Gets the released hdoc for given hdoc if release feature is on and release tag is set, otherwise returns the given hDoc.
        Parameters:
        oldHdoc - the hdoc to lookup released hdoc
        Returns:
        the released hdoc
        Throws:
        SaAuthenticationException - if authentication fails
        SaSystemException - the sa system exception

      • getDocumentInfo

        SaDocInfo getDocumentInfo​(java.lang.String hDoc,
                          boolean currentRevision,
                          boolean resolveLinks,
                          boolean forceSizeDetermination)
                   throws SaSystemException,
                          SaAuthenticationException
        Reads information like the document-structure and variables for the given document. Metadata stored in the database is not contained. Use readDocumentMetadata(String, String, String[]) or searchHQL(SaQueryInfo) to load metadata from the database.
        Parameters:
        hDoc - Document HDOC
        currentRevision - True for current revision
        resolveLinks - True for resolve links
        forceSizeDetermination - Forces the backend to determine the size of each element, even if it is not already available. Reqiures loading the document, so use only if really required.
        Returns:
        Document information
        Throws:
        SaSystemException - if a backend system error occurs during the discard operation
        SaAuthenticationException - if the user is not logged in or has insufficient rights

      • search

        @Deprecated
java.util.List<SaPropertyValue[]> search​(java.lang.String hqlQuery)
                                  throws SaSystemException,
                                         SaAuthenticationException,
                                         SaDBException
        Deprecated.
        Use searchHQL() instead. Will be removed with version 8.1
        Performs a search with the given hql query (hibernate query language).
        Parameters:
        hqlQuery - the Hibernate query - hql.
        Returns:
        a result list of values which are returned by the Hibernate. Each returned value represented as SaPropertyValue object.
        Throws:
        SaSystemException - SaSystemException
        SaAuthenticationException - when the user is not logged in or has insufficient rights
        SaDBException - exception thrown during query execution

      • getVersionIDs

        java.util.List<java.lang.String> getVersionIDs​(java.lang.String ddcName,
                                               java.lang.String sysrowID)
                                        throws SaSystemException,
                                               SaAuthenticationException
        Reads the version IDs of the given document. The versions (XHDOCs) are sorted descending (the most current version is the first element in the list).
        Parameters:
        ddcName - The name of the database definition
        sysrowID - The ID of the document
        Returns:
        Set of version IDs
        Throws:
        SaSystemException - if a backend system error occurs
        SaAuthenticationException - when the user is not logged in or has insufficient rights

      • readVersionDocument

        java.io.InputStream readVersionDocument​(java.lang.String versionID,
                                        int elementNumber)
                                 throws SaSystemException,
                                        SaAuthenticationException
        Loads a document version from the backend system.
        Parameters:
        versionID - Version ID (XHDOC is the revision number of the document)
        elementNumber - Element number
        Returns:
        Input stream with the document content
        Throws:
        SaSystemException - if a backend system error occurs during the document creation
        SaAuthenticationException - when the user of this session is not logged in (anymore) or has insufficient rights

      • readVersionMetadata

        SaVersionData readVersionMetadata​(java.lang.String versionID,
                                  boolean resolveLinks)
                           throws SaSystemException,
                                  SaAuthenticationException,
                                  SaDDCException
        Reads the version metadata of the document with the given ID.
        Parameters:
        versionID - Version ID (XHDOC is the revision number of the document)
        resolveLinks - If false will not resolve the link and show the metadata associated with the link itself.
        Returns:
        Metadata of the document
        Throws:
        SaSystemException - if a backend system error occurs during the read operation
        SaAuthenticationException - SaAuthenticationException
        SaDDCException - SaDDCException

      • resolveLatestHDoc

        java.lang.String resolveLatestHDoc​(java.lang.String oldHdoc)
                            throws SaSystemException,
                                   SaAuthenticationException
        Resolves and returns the XHDOC of the latest version of the document identified by the given HDOC.
        Parameters:
        oldHdoc - the HDOC to identify the document
        Returns:
        The XHDOC of the latest version of the document identified by the given HDOC.
        Throws:
        SaSystemException - if a backend system error occurs
        SaAuthenticationException - SaAuthenticationException

      • removeEvent

        @Deprecated
boolean removeEvent​(SaEvent event)
             throws SaSystemException
        Deprecated.
        no longer supported. Will be removed with version 8.1
        Deletes the row from XEvents for the given event.
        Parameters:
        event - Event object
        Returns:
        boolean true deleted
        Throws:
        SaSystemException - if a backend system error occurs

      • readDocumentFilename

        @Deprecated
java.lang.String readDocumentFilename​(java.lang.String documentHDOC,
                                      boolean currentRevision,
                                      int elementNumber)
                               throws SaSystemException,
                                      SaAuthenticationException,
                                      SaDDCException
        Deprecated.
        will be removed with version 8.1
        Reads the filenames of the application data of the document with the given ID.
        Parameters:
        documentHDOC - The ID of the document (XHDOC)
        currentRevision - flag indicating that the current revision of the document should be retrieved by resolving the HDoc.
        elementNumber - position in the document structure; 0 if the document is unstructured.
        Returns:
        Filenames of the application data
        Throws:
        SaSystemException - SaSystemException
        SaAuthenticationException - SaAuthenticationException
        SaDDCException - SaDDCException

      • readVersionDocumentFilename

        @Deprecated
java.lang.String readVersionDocumentFilename​(java.lang.String documentHDOC,
                                             int elementNumber)
                                      throws SaSystemException,
                                             SaAuthenticationException,
                                             SaDDCException
        Deprecated.
        use getDocumentInfo.getFullName() instead. Will be removed with version 8.1
        Reads the filenames of the application data of the document with the given ID.
        Parameters:
        documentHDOC - The ID of the document (XHDOC)
        elementNumber - position in the document structure; 0 if the document is unstructured.
        Returns:
        Filenames of the application data
        Throws:
        SaSystemException - SaSystemException
        SaAuthenticationException - SaAuthenticationException
        SaDDCException - SaDDCException

      • getACLNames

        java.lang.String getACLNames​(java.lang.String documentHDOC)
                      throws SaSystemException,
                             SaAuthenticationException,
                             SaDDCException
        This method returns the names of the Access Control Lists that are assigned to this document. Use getACLRights(String[]) to evaluate the rights of the current user on the given ACLs.
        Parameters:
        documentHDOC - The ID of the document revision (XHDOC)
        Returns:
        a ';'-separated list of names of the acls set on the given document
        Throws:
        SaDDCException - on functional failures concerning the given document
        SaAuthenticationException - when the classic connector is not authenticated or the current user has not the required rights for the operation
        SaSystemException - on general system failures

      • setACLName

        SaSaveInfo setACLName​(java.lang.String ddcname,
                      java.lang.String documentHDOC,
                      java.lang.String acl,
                      java.lang.String versionComment)
               throws SaSystemException,
                      SaAuthenticationException,
                      SaDDCException,
                      SaSetACLException
        This method specifies the Access Control Lists that secure the document given by its id. Note that this will create a new revision of the document.
        Parameters:
        ddcname - the name of the ddc in saperion
        documentHDOC - The ID of the document (XHDOC)
        acl - a ';' separated String of acl names that identify the Access Control Lists are requested to secure the given document
        versionComment - since changing a documents security creates a new revision, a revision comment must be given.
        Returns:
        the save information of the newly created revision
        Throws:
        SaDDCException - when the definition name given was invalid
        SaSetACLException - on functional failures concerning the given document or acls
        SaAuthenticationException - when the classic connector is not authenticated or the current user has not the required rights for the operation
        SaSystemException - on general system failures

      • getInvolvedUsers

        @Deprecated
java.util.List<java.lang.String> getInvolvedUsers​(java.lang.String documentHDOC)
                                           throws SaSystemException,
                                                  SaAuthenticationException,
                                                  SaDDCException
        Deprecated.
        use getAuthorizedUsers(String, String, MatchKind) instead. Will be removed in version 8.1.
        Lists the names of all users that are contained in all Access Control Lists set on the given document. Groups contained in the acls are evaluated to the users contained in the group.
        Parameters:
        documentHDOC - The ID of the document (XHDOC)
        Returns:
        the names of all users that are contained in all Access Control Lists set on the given document
        Throws:
        SaAuthenticationException - when the classic connector is not authenticated or the current user has not the required rights for the operation
        SaSystemException - on general system failures
        SaDDCException

      • getACLRights

        SaACLRights getACLRights​(java.lang.String[] acls)
                  throws SaSystemException,
                         SaAuthenticationException
        This method returns the access rights the current user has when in the context of the Access Controll Lists given by name.
        Parameters:
        acls - an array of names referencing the ACLs to evaluate
        Returns:
        the rights the current user has in the context of the given ACLs
        Throws:
        SaAuthenticationException - when the classic connector is not authenticated or the current user has not the required rights for the operation
        SaSystemException - on general system failures

      • getDocumentAccessData

        SaDocAccessData getDocumentAccessData​(java.lang.String documentHDOC)
                               throws SaSystemException,
                                      SaAuthenticationException
        This method reads the access rights the current user has on a given document.
        Parameters:
        documentHDOC - The ID of the document (XHDOC)
        Returns:
        the access rights the current user has on a given document
        Throws:
        SaAuthenticationException - when the classic connector is not authenticated or the current user has not the required rights for the operation
        SaSystemException - on general system failures

      • isAlive

        boolean isAlive()
         throws SaSystemException
        Tests the lifetime of this connector. If the connector is alive the expiration timeout will be reset (the connection will be kept alive until the next timeout).
        Returns:
        true if alive
        Throws:
        SaSystemException - System exception

      • getAnnotations

        java.lang.String getAnnotations​(java.lang.String hDoc,
                                int indexOfContentElement,
                                boolean currentRevision)
                         throws SaAuthenticationException,
                                SaSystemException
        Reads the annotations of the document with the specified ID.

        The returned annotation string contains a list of annotation using an INI format. 5 diffrent annotations types are available. Each annotation starts with its type description and a list of properties describing the annotation format.

        Annotation types:

      • [ARROW]
      • [BLACKMARKER]
      • [CUSTOM]
      • [TEXT]
      • [HIGHLIGHT]

        Example for a text marker: 

        [HIGHLIGHT]
 X = <x>
 Y = <y>
 WIDTH = <width>
 HEIGHT = <height>
 LINEWIDTH = 0
 FILLCOLOR = 255, 128, 0
 TRANSPARENT = 1
 PAGE = 
 EDIT = 1
 LABEL = Highlight1
 BORDER = 1
 SEMITRANSPARENT = 1

        Example for a sticky node: 

         [TEXT]
 X = <x>
 Y = <y>
 WIDTH = <width>
 HEIGHT = <height>
 PAGE = <page>
 EDIT = 1
 LABEL = text1
 TEXT = <text>
 FONT_HEIGHT = 67
 BORDER = 1
 COLOR = 255, 0, 0
 FILLCOLOR = 255, 255, 255
 TRANSPARENT = 0
 SEMITRANSPARENT = 0
 FONT_NAME = Arial
 FONT_BOLD = 0
 FONT_ITALIC = 0
 FONT_UNDERLINE = 0
 FONT_STRIKETHROUGH = 0
 BORDER = 1
 SEMITRANSPARENT = 1

        Example for a black marker: 

         [BLACKMARKER]
 X = <x>
 Y = <y>
 WIDTH = <width>
 HEIGHT = <height>
 LINEWIDTH = 0
 FILLCOLOR = 0, 0, 0
 TRANSPARENT = 0
 PAGE = <page>
 EDIT = 1
 LABEL = Highlight1
 BORDER = 1
 SEMITRANSPARENT = 1

        Example for a arrow annotation: 

         [ARROW]
 X1 = <x1>
 Y1 = <y1>
 X2 = <x2>
 Y2 = <y2>
 PAGE = <page>
 EDIT = 1
 LABEL = Arrow1
 COLOR = 255, 0, 0
 LINEWIDTH = 10
        A custom-section is contained in the INI that contains information for the client about how to handle annotations. See online documentation for more information about the custom-section.
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