Package com.microstrategy.webapi

Interface IDSSXMLEncryptor

  • public interface IDSSXMLEncryptor
    This object exposes an API for encryption. This can be used by web applications to encrypt/decrypt sensitive data (e.g. passwords) which has to travel to the Web Browser.
    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String Decrypt​(java.lang.String key, java.lang.String encryptedData)
      Decrypts a string using the given key.
      java.lang.String Encrypt​(java.lang.String key, java.lang.String clearData)
      Encrypts a string using the given key.
      java.lang.String Encrypt​(java.lang.String key, java.lang.String clearData, java.lang.String cipherVersion)
      Encrypts a string using the given key, and cipher.
      java.lang.String GenerateRandomKey()
      Returns a random key of length 16 for encryption.
      java.lang.String GetSignature​(java.lang.String data)
      Returns the signature of the given data.

    • Method Detail

      • Decrypt

        java.lang.String Decrypt​(java.lang.String key,
                         java.lang.String encryptedData)
        Decrypts a string using the given key.
        Parameters:
        key - The key to use in decrypting the given string.
        encryptedData - The data string to decrypt.
        Returns:
        The result of applying the decryption algorithm to the given string using the given key.

      • Encrypt

        java.lang.String Encrypt​(java.lang.String key,
                         java.lang.String clearData)
        Encrypts a string using the given key.
        Parameters:
        key - The key to use in encrypting the given string.
        clearData - The data string to encrypt.
        Returns:
        The result of applying the encryption algorithm to the given string using the given key.

      • Encrypt

        java.lang.String Encrypt​(java.lang.String key,
                         java.lang.String clearData,
                         java.lang.String cipherVersion)
        Encrypts a string using the given key, and cipher.
        Parameters:
        key - The key to use in encrypting the given string.
        clearData - The data string to encrypt.
        cipherVersion - Version string from EnumCipher.getVersion().
        Returns:
        The result of applying the encryption algorithm to the given string using the given key and cipher.
        Since:
        MicroStrategy Web 9.0.0

      • GetSignature

        java.lang.String GetSignature​(java.lang.String data)
        Returns the signature of the given data.
        Parameters:
        data - The data to obtain the signature for.
        Returns:
        The signature of the given string.

      • GenerateRandomKey

        java.lang.String GenerateRandomKey()
        Returns a random key of length 16 for encryption.
        Returns:
        The random key generated.