com.aspose.slides

Class ProtectionManager

java.lang.Object

com.aspose.slides.ProtectionManager

All Implemented Interfaces:

IProtectionManager

public final class ProtectionManager
extends java.lang.Object
implements IProtectionManager

Presentation password protection management.

Method Summary

Modifier and Type	Method and Description
boolean	checkWriteProtection(java.lang.String password) Determines whether a presentation is a password protected to modify.
void	encrypt(java.lang.String encryptionPassword) Encrypts Presentation with specified password.
boolean	getEncryptDocumentProperties() This property makes sense, if presentation is password protected.
java.lang.String	getEncryptionPassword() Gets the password which is used for presentation encryption.
boolean	getReadOnlyRecommended() Gets or sets read-only recommendation.
boolean	isEncrypted() Gets a value indicating whether this instance is encrypted.
boolean	isOnlyDocumentPropertiesLoaded() This property makes sense, if presentation file is password protected and document properties of this file are public.
boolean	isWriteProtected() Gets a value indicating whether this presentation is write protected.
void	removeEncryption() Removes the encryption.
void	removeWriteProtection() Removes write protection for this presentation.
void	setEncryptDocumentProperties(boolean value) This property makes sense, if presentation is password protected.
void	setReadOnlyRecommended(boolean value) Gets or sets read-only recommendation.
void	setWriteProtection(java.lang.String password) Set write protection for this presentation with specified password.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getEncryptDocumentProperties

public final boolean getEncryptDocumentProperties()

This property makes sense, if presentation is password protected. If true then document properties is encrypted in presentation file. If false then document properties is public while presentation is encrypted. Read/write boolean.

Specified by:

getEncryptDocumentProperties in interface IProtectionManager

setEncryptDocumentProperties

public final void setEncryptDocumentProperties(boolean value)

This property makes sense, if presentation is password protected. If true then document properties is encrypted in presentation file. If false then document properties is public while presentation is encrypted. Read/write boolean.

Specified by:

setEncryptDocumentProperties in interface IProtectionManager

isEncrypted

public final boolean isEncrypted()

Gets a value indicating whether this instance is encrypted. Read-only boolean.

Value: true if presentation was loaded from encrypted file or encrypt(String) method was called ; otherwise, false.

Specified by:

isEncrypted in interface IProtectionManager

isOnlyDocumentPropertiesLoaded

public final boolean isOnlyDocumentPropertiesLoaded()

This property makes sense, if presentation file is password protected and document properties of this file are public. Value of true means that only document properties are loaded from an encrypted presentation file without use of password. Value of false means that entire encrypted presentation is loaded with use of right password, not only document properties are loaded. If presentation isn't encrypted then property value is always false. If document properties of an encrypted file aren't public then property value is always false. If Presentation.EncryptDocumentProperties is true than IsOnlyDocumentPropertiesLoaded property value is always false. Read-only boolean.

Specified by:

isOnlyDocumentPropertiesLoaded in interface IProtectionManager

isWriteProtected

public final boolean isWriteProtected()

Gets a value indicating whether this presentation is write protected. Read-only boolean.

Specified by:

isWriteProtected in interface IProtectionManager

encrypt

public final void encrypt(java.lang.String encryptionPassword)

Encrypts Presentation with specified password.

 The following sample code shows you how to encrypt a PowerPoint Presentation.
 
 Presentation pres = new Presentation("pres.pptx");
 try {
     pres.getProtectionManager().encrypt("123123");
     pres.save("encrypted-pres.pptx", SaveFormat.Pptx);
 } finally {
     if (pres != null) pres.dispose();
 }
 
 

Specified by:

encrypt in interface IProtectionManager

Parameters:

encryptionPassword - The password.

removeEncryption

public final void removeEncryption()

Removes the encryption.

Specified by:

removeEncryption in interface IProtectionManager

setWriteProtection

public final void setWriteProtection(java.lang.String password)

Set write protection for this presentation with specified password.

 The following sample code shows you how to set a write protection to a presentation.
 
 Presentation pres = new Presentation("pres.pptx");
 try {
     pres.getProtectionManager().setWriteProtection("123123");
     pres.save("write-protected-pres.pptx", SaveFormat.Pptx);
 } finally {
     if (pres != null) pres.dispose();
 }
 
 

Specified by:

setWriteProtection in interface IProtectionManager

Parameters:

password - The password.

removeWriteProtection

public final void removeWriteProtection()

Removes write protection for this presentation.

 This sample code shows you how to remove the write protection from a PowerPoint Presentation.
 
 Presentation pres = new Presentation("pres.pptx");
 try {
     pres.getProtectionManager().removeWriteProtection();
     pres.save("write-protection-removed.pptx", SaveFormat.Pptx);
 } finally {
     if (pres != null) pres.dispose();
 }
 
 

Specified by:

removeWriteProtection in interface IProtectionManager

checkWriteProtection

public final boolean checkWriteProtection(java.lang.String password)

Determines whether a presentation is a password protected to modify.

 
 Presentation presentation = new Presentation(presentationFilePath);
 try {
     boolean isWriteProtected = presentation.getProtectionManager().checkWriteProtection("my_password");
 } finally {
     if (presentation != null) presentation.dispose();
 }
 
 

Specified by:

checkWriteProtection in interface IProtectionManager

Parameters:

password - The password for checking.

1. You should check the (isWriteProtected()) property before calling this method. 2. When the password is null or empty, this method returns false.

Returns:

True if the password is valid; otherwise, false.

getEncryptionPassword

public final java.lang.String getEncryptionPassword()

Gets the password which is used for presentation encryption. Read-only String.

Specified by:

getEncryptionPassword in interface IProtectionManager

getReadOnlyRecommended

public final boolean getReadOnlyRecommended()

Gets or sets read-only recommendation. Read/write boolean.

 
 Presentation pres = new Presentation();
 try {
     pres.getProtectionManager().setReadOnlyRecommended(true);
     pres.save("ReadOnlyPresentation.pptx", SaveFormat.Pptx);
 } finally {
     if (pres != null) pres.dispose();
 }
 
 

Specified by:

getReadOnlyRecommended in interface IProtectionManager

setReadOnlyRecommended

public final void setReadOnlyRecommended(boolean value)

Gets or sets read-only recommendation. Read/write boolean.

 
 Presentation pres = new Presentation();
 try {
     pres.getProtectionManager().setReadOnlyRecommended(true);
     pres.save("ReadOnlyPresentation.pptx", SaveFormat.Pptx);
 } finally {
     if (pres != null) pres.dispose();
 }
 
 

Specified by:

setReadOnlyRecommended in interface IProtectionManager