org.kurento.client.SDES Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kurento-client Show documentation
Kurento Client The Kurento Client project allows server applications to control media server resources.
There is a newer version: 7.1.0
/**
 * This file is generated with Kurento ktool-rom-processor.
 * Please don't edit. Changes should go to kms-interface-rom and
 * ktool-rom-processor templates.
 */
package org.kurento.client;

/**
 *
 * Security Descriptions for Media Streams
 *
 **/
@org.kurento.client.internal.ModuleName ("kurento")
public class SDES  {

/**
 *
 * Master key and salt (plain text)
 *           
 *           This field provides the the cryptographic master key appended with the master salt, in plain text format. This allows to provide a key that is composed of readable ASCII characters.
 *           
 *           
 *           The expected length of the key (as provided to this parameter) is determined by the crypto-suite for which the key applies (30 characters for AES_CM_128, 46 characters for AES_CM_256). If the length does not match the expected value, the key will be considered invalid.
 *           
 *           
 *           If no key is provided, a random one will be generated using the `getrandom` system call.
 *           
 *
 **/
    private String key;
/**
 *
 * Master key and salt (base64 encoded)
 *           
 *           This field provides the cryptographic master key appended with the master salt, encoded in base64. This allows to provide a binary key that is not limited to the ASCII character set.
 *           
 *           
 *           The expected length of the key (after being decoded from base64) is determined by the crypto-suite for which the key applies (30 bytes for AES_CM_128, 46 bytes for AES_CM_256). If the length does not match the expected value, the key will be considered invalid.
 *           
 *           
 *           If no key is provided, a random one will be generated using the `getrandom` system call.
 *           
 *
 **/
    private String keyBase64;
/**
 *
 * Selects the cryptographic suite to be used. For available values, please see the CryptoSuite enum.
 *
 **/
    private org.kurento.client.CryptoSuite crypto;


/**
 *
 * Create a SDES
 *
 **/
    public SDES() {

	super();

    }

/**
 *
 * get Master key and salt (plain text)
 *           
 *           This field provides the the cryptographic master key appended with the master salt, in plain text format. This allows to provide a key that is composed of readable ASCII characters.
 *           
 *           
 *           The expected length of the key (as provided to this parameter) is determined by the crypto-suite for which the key applies (30 characters for AES_CM_128, 46 characters for AES_CM_256). If the length does not match the expected value, the key will be considered invalid.
 *           
 *           
 *           If no key is provided, a random one will be generated using the `getrandom` system call.
 *           
 *
 **/
    public String getKey(){
    	return key;
    }

/**
 *
 * set Master key and salt (plain text)
 *           
 *           This field provides the the cryptographic master key appended with the master salt, in plain text format. This allows to provide a key that is composed of readable ASCII characters.
 *           
 *           
 *           The expected length of the key (as provided to this parameter) is determined by the crypto-suite for which the key applies (30 characters for AES_CM_128, 46 characters for AES_CM_256). If the length does not match the expected value, the key will be considered invalid.
 *           
 *           
 *           If no key is provided, a random one will be generated using the `getrandom` system call.
 *           
 *
 **/
    public void setKey(String key){
    	this.key = key;
    }

/**
 *
 * get Master key and salt (base64 encoded)
 *           
 *           This field provides the cryptographic master key appended with the master salt, encoded in base64. This allows to provide a binary key that is not limited to the ASCII character set.
 *           
 *           
 *           The expected length of the key (after being decoded from base64) is determined by the crypto-suite for which the key applies (30 bytes for AES_CM_128, 46 bytes for AES_CM_256). If the length does not match the expected value, the key will be considered invalid.
 *           
 *           
 *           If no key is provided, a random one will be generated using the `getrandom` system call.
 *           
 *
 **/
    public String getKeyBase64(){
    	return keyBase64;
    }

/**
 *
 * set Master key and salt (base64 encoded)
 *           
 *           This field provides the cryptographic master key appended with the master salt, encoded in base64. This allows to provide a binary key that is not limited to the ASCII character set.
 *           
 *           
 *           The expected length of the key (after being decoded from base64) is determined by the crypto-suite for which the key applies (30 bytes for AES_CM_128, 46 bytes for AES_CM_256). If the length does not match the expected value, the key will be considered invalid.
 *           
 *           
 *           If no key is provided, a random one will be generated using the `getrandom` system call.
 *           
 *
 **/
    public void setKeyBase64(String keyBase64){
    	this.keyBase64 = keyBase64;
    }

/**
 *
 * get Selects the cryptographic suite to be used. For available values, please see the CryptoSuite enum.
 *
 **/
    public org.kurento.client.CryptoSuite getCrypto(){
    	return crypto;
    }

/**
 *
 * set Selects the cryptographic suite to be used. For available values, please see the CryptoSuite enum.
 *
 **/
    public void setCrypto(org.kurento.client.CryptoSuite crypto){
    	this.crypto = crypto;
    }

}