CTPasswordKeyEncryptor (docx4j 6.1.2 API)

java.lang.Object
- org.docx4j.com.microsoft.schemas.office.x2006.keyEncryptor.password.CTPasswordKeyEncryptor

public class CTPasswordKeyEncryptor
extends Object

Java class for CT_PasswordKeyEncryptor complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="CT_PasswordKeyEncryptor">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <attribute name="saltSize" use="required" type="{http://schemas.microsoft.com/office/2006/encryption}ST_SaltSize" />
       <attribute name="blockSize" use="required" type="{http://schemas.microsoft.com/office/2006/encryption}ST_BlockSize" />
       <attribute name="keyBits" use="required" type="{http://schemas.microsoft.com/office/2006/encryption}ST_KeyBits" />
       <attribute name="hashSize" use="required" type="{http://schemas.microsoft.com/office/2006/encryption}ST_HashSize" />
       <attribute name="cipherAlgorithm" use="required" type="{http://schemas.microsoft.com/office/2006/encryption}ST_CipherAlgorithm" />
       <attribute name="cipherChaining" use="required" type="{http://schemas.microsoft.com/office/2006/encryption}ST_CipherChaining" />
       <attribute name="hashAlgorithm" use="required" type="{http://schemas.microsoft.com/office/2006/encryption}ST_HashAlgorithm" />
       <attribute name="saltValue" use="required" type="{http://www.w3.org/2001/XMLSchema}base64Binary" />
       <attribute name="spinCount" use="required" type="{http://schemas.microsoft.com/office/2006/encryption}ST_SpinCount" />
       <attribute name="encryptedVerifierHashInput" use="required" type="{http://www.w3.org/2001/XMLSchema}base64Binary" />
       <attribute name="encryptedVerifierHashValue" use="required" type="{http://www.w3.org/2001/XMLSchema}base64Binary" />
       <attribute name="encryptedKeyValue" use="required" type="{http://www.w3.org/2001/XMLSchema}base64Binary" />
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected long`	`blockSize`
`protected String`	`cipherAlgorithm`
`protected STCipherChaining`	`cipherChaining`
`protected byte[]`	`encryptedKeyValue`
`protected byte[]`	`encryptedVerifierHashInput`
`protected byte[]`	`encryptedVerifierHashValue`
`protected STHashAlgorithm`	`hashAlgorithm`
`protected long`	`hashSize`
`protected long`	`keyBits`
`protected long`	`saltSize`
`protected byte[]`	`saltValue`
`protected long`	`spinCount`

Constructor Summary

Constructors
Constructor and Description

CTPasswordKeyEncryptor()

Constructors
Constructor and Description
`CTPasswordKeyEncryptor()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`getBlockSize()` Gets the value of the blockSize property.
`String`	`getCipherAlgorithm()` Gets the value of the cipherAlgorithm property.
`STCipherChaining`	`getCipherChaining()` Gets the value of the cipherChaining property.
`byte[]`	`getEncryptedKeyValue()` Gets the value of the encryptedKeyValue property.
`byte[]`	`getEncryptedVerifierHashInput()` Gets the value of the encryptedVerifierHashInput property.
`byte[]`	`getEncryptedVerifierHashValue()` Gets the value of the encryptedVerifierHashValue property.
`STHashAlgorithm`	`getHashAlgorithm()` Gets the value of the hashAlgorithm property.
`long`	`getHashSize()` Gets the value of the hashSize property.
`long`	`getKeyBits()` Gets the value of the keyBits property.
`long`	`getSaltSize()` Gets the value of the saltSize property.
`byte[]`	`getSaltValue()` Gets the value of the saltValue property.
`long`	`getSpinCount()` Gets the value of the spinCount property.
`void`	`setBlockSize(long value)` Sets the value of the blockSize property.
`void`	`setCipherAlgorithm(String value)` Sets the value of the cipherAlgorithm property.
`void`	`setCipherChaining(STCipherChaining value)` Sets the value of the cipherChaining property.
`void`	`setEncryptedKeyValue(byte[] value)` Sets the value of the encryptedKeyValue property.
`void`	`setEncryptedVerifierHashInput(byte[] value)` Sets the value of the encryptedVerifierHashInput property.
`void`	`setEncryptedVerifierHashValue(byte[] value)` Sets the value of the encryptedVerifierHashValue property.
`void`	`setHashAlgorithm(STHashAlgorithm value)` Sets the value of the hashAlgorithm property.
`void`	`setHashSize(long value)` Sets the value of the hashSize property.
`void`	`setKeyBits(long value)` Sets the value of the keyBits property.
`void`	`setSaltSize(long value)` Sets the value of the saltSize property.
`void`	`setSaltValue(byte[] value)` Sets the value of the saltValue property.
`void`	`setSpinCount(long value)` Sets the value of the spinCount property.

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

- Field Detail
  - saltSize
```
protected long saltSize
```
  - blockSize
```
protected long blockSize
```
  - keyBits
```
protected long keyBits
```
  - hashSize
```
protected long hashSize
```
  - cipherAlgorithm
```
protected String cipherAlgorithm
```
  - cipherChaining
```
protected STCipherChaining cipherChaining
```
  - hashAlgorithm
```
protected STHashAlgorithm hashAlgorithm
```
  - saltValue
```
protected byte[] saltValue
```
  - spinCount
```
protected long spinCount
```
  - encryptedVerifierHashInput
```
protected byte[] encryptedVerifierHashInput
```
  - encryptedVerifierHashValue
```
protected byte[] encryptedVerifierHashValue
```
  - encryptedKeyValue
```
protected byte[] encryptedKeyValue
```
- Constructor Detail
  - CTPasswordKeyEncryptor
```
public CTPasswordKeyEncryptor()
```
- Method Detail
  - getSaltSize
```
public long getSaltSize()
```
    Gets the value of the saltSize property.
  - setSaltSize
```
public void setSaltSize(long value)
```
    Sets the value of the saltSize property.
  - getBlockSize
```
public long getBlockSize()
```
    Gets the value of the blockSize property.
  - setBlockSize
```
public void setBlockSize(long value)
```
    Sets the value of the blockSize property.
  - getKeyBits
```
public long getKeyBits()
```
    Gets the value of the keyBits property.
  - setKeyBits
```
public void setKeyBits(long value)
```
    Sets the value of the keyBits property.
  - getHashSize
```
public long getHashSize()
```
    Gets the value of the hashSize property.
  - setHashSize
```
public void setHashSize(long value)
```
    Sets the value of the hashSize property.
  - getCipherAlgorithm
```
public String getCipherAlgorithm()
```
    Gets the value of the cipherAlgorithm property.
    
    Returns:
    
    possible object is String
  - setCipherAlgorithm
```
public void setCipherAlgorithm(String value)
```
    Sets the value of the cipherAlgorithm property.
    
    Parameters:
    
    value - allowed object is String
  - getCipherChaining
```
public STCipherChaining getCipherChaining()
```
    Gets the value of the cipherChaining property.
    
    Returns:
    
    possible object is STCipherChaining
  - setCipherChaining
```
public void setCipherChaining(STCipherChaining value)
```
    Sets the value of the cipherChaining property.
    
    Parameters:
    
    value - allowed object is STCipherChaining
  - getHashAlgorithm
```
public STHashAlgorithm getHashAlgorithm()
```
    Gets the value of the hashAlgorithm property.
    
    Returns:
    
    possible object is STHashAlgorithm
  - setHashAlgorithm
```
public void setHashAlgorithm(STHashAlgorithm value)
```
    Sets the value of the hashAlgorithm property.
    
    Parameters:
    
    value - allowed object is STHashAlgorithm
  - getSaltValue
```
public byte[] getSaltValue()
```
    Gets the value of the saltValue property.
    
    Returns:
    
    possible object is byte[]
  - setSaltValue
```
public void setSaltValue(byte[] value)
```
    Sets the value of the saltValue property.
    
    Parameters:
    
    value - allowed object is byte[]
  - getSpinCount
```
public long getSpinCount()
```
    Gets the value of the spinCount property.
  - setSpinCount
```
public void setSpinCount(long value)
```
    Sets the value of the spinCount property.
  - getEncryptedVerifierHashInput
```
public byte[] getEncryptedVerifierHashInput()
```
    Gets the value of the encryptedVerifierHashInput property.
    
    Returns:
    
    possible object is byte[]
  - setEncryptedVerifierHashInput
```
public void setEncryptedVerifierHashInput(byte[] value)
```
    Sets the value of the encryptedVerifierHashInput property.
    
    Parameters:
    
    value - allowed object is byte[]
  - getEncryptedVerifierHashValue
```
public byte[] getEncryptedVerifierHashValue()
```
    Gets the value of the encryptedVerifierHashValue property.
    
    Returns:
    
    possible object is byte[]
  - setEncryptedVerifierHashValue
```
public void setEncryptedVerifierHashValue(byte[] value)
```
    Sets the value of the encryptedVerifierHashValue property.
    
    Parameters:
    
    value - allowed object is byte[]
  - getEncryptedKeyValue
```
public byte[] getEncryptedKeyValue()
```
    Gets the value of the encryptedKeyValue property.
    
    Returns:
    
    possible object is byte[]
  - setEncryptedKeyValue
```
public void setEncryptedKeyValue(byte[] value)
```
    Sets the value of the encryptedKeyValue property.
    
    Parameters:
    
    value - allowed object is byte[]

Class CTPasswordKeyEncryptor

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

saltSize

blockSize

keyBits

hashSize

cipherAlgorithm

cipherChaining

hashAlgorithm

saltValue

spinCount

encryptedVerifierHashInput

encryptedVerifierHashValue

encryptedKeyValue

Constructor Detail

CTPasswordKeyEncryptor

Method Detail

getSaltSize

setSaltSize

getBlockSize

setBlockSize

getKeyBits

setKeyBits

getHashSize

setHashSize

getCipherAlgorithm

setCipherAlgorithm

getCipherChaining

setCipherChaining

getHashAlgorithm

setHashAlgorithm

getSaltValue

setSaltValue

getSpinCount

setSpinCount

getEncryptedVerifierHashInput

setEncryptedVerifierHashInput

getEncryptedVerifierHashValue

setEncryptedVerifierHashValue

getEncryptedKeyValue

setEncryptedKeyValue