DocumentSecurity

Inheritance: java.lang.Object

public class DocumentSecurity

Used as a value for the BuiltInDocumentProperties.getSecurity() / BuiltInDocumentProperties.setSecurity(int) property. Specifies the security level of a document as a numeric value.

Examples:

Shows how to use document properties to display the security level of a document.

 Document doc = new Document();

 Assert.assertEquals(DocumentSecurity.NONE, doc.getBuiltInDocumentProperties().getSecurity());

 // If we configure a document to be read-only, it will display this status using the "Security" built-in property.
 doc.getWriteProtection().setReadOnlyRecommended(true);
 doc.save(getArtifactsDir() + "DocumentProperties.Security.ReadOnlyRecommended.docx");

 Assert.assertEquals(DocumentSecurity.READ_ONLY_RECOMMENDED,
         new Document(getArtifactsDir() + "DocumentProperties.Security.ReadOnlyRecommended.docx").getBuiltInDocumentProperties().getSecurity());

 // Write-protect a document, and then verify its security level.
 doc = new Document();

 Assert.assertFalse(doc.getWriteProtection().isWriteProtected());

 doc.getWriteProtection().setPassword("MyPassword");

 Assert.assertTrue(doc.getWriteProtection().validatePassword("MyPassword"));
 Assert.assertTrue(doc.getWriteProtection().isWriteProtected());

 doc.save(getArtifactsDir() + "DocumentProperties.Security.ReadOnlyEnforced.docx");

 Assert.assertEquals(DocumentSecurity.READ_ONLY_ENFORCED,
         new Document(getArtifactsDir() + "DocumentProperties.Security.ReadOnlyEnforced.docx").getBuiltInDocumentProperties().getSecurity());

 // "Security" is a descriptive property. We can edit its value manually.
 doc = new Document();

 doc.protect(ProtectionType.ALLOW_ONLY_COMMENTS, "MyPassword");
 doc.getBuiltInDocumentProperties().setSecurity(DocumentSecurity.READ_ONLY_EXCEPT_ANNOTATIONS);
 doc.save(getArtifactsDir() + "DocumentProperties.Security.ReadOnlyExceptAnnotations.docx");

 Assert.assertEquals(DocumentSecurity.READ_ONLY_EXCEPT_ANNOTATIONS,
         new Document(getArtifactsDir() + "DocumentProperties.Security.ReadOnlyExceptAnnotations.docx").getBuiltInDocumentProperties().getSecurity());
 

Fields

Field	Description
NONE	There are no security states specified by the property.
PASSWORD_PROTECTED	The document is password protected.
READ_ONLY_ENFORCED	The document to always be opened read-only.
READ_ONLY_EXCEPT_ANNOTATIONS	The document to always be opened read-only except for annotations.
READ_ONLY_RECOMMENDED	The document to be opened read-only if possible, but the setting can be overridden.
length

Methods

Method	Description
fromName(String documentSecurityName)
fromNames(Set documentSecurityNames)
getName(int documentSecurity)
getNames(int documentSecurity)
getValues()
toString(int documentSecurity)
toStringSet(int attr)

NONE

public static int NONE

There are no security states specified by the property.

PASSWORD_PROTECTED

public static int PASSWORD_PROTECTED

The document is password protected. (Note has never been seen in a document so far).

READ_ONLY_ENFORCED

public static int READ_ONLY_ENFORCED

The document to always be opened read-only.

READ_ONLY_EXCEPT_ANNOTATIONS

public static int READ_ONLY_EXCEPT_ANNOTATIONS

The document to always be opened read-only except for annotations.

READ_ONLY_RECOMMENDED

public static int READ_ONLY_RECOMMENDED

The document to be opened read-only if possible, but the setting can be overridden.

length

public static int length

fromName(String documentSecurityName)

public static int fromName(String documentSecurityName)

Parameters:

Parameter	Type	Description
documentSecurityName	java.lang.String

Returns: int

fromNames(Set documentSecurityNames)

public static int fromNames(Set documentSecurityNames)

Parameters:

Parameter	Type	Description
documentSecurityNames	java.util.Set

Returns: int

getName(int documentSecurity)

public static String getName(int documentSecurity)

Parameters:

Parameter	Type	Description
documentSecurity	int

Returns: java.lang.String

getNames(int documentSecurity)

public static Set getNames(int documentSecurity)

Parameters:

Parameter	Type	Description
documentSecurity	int

Returns: java.util.Set

getValues()

public static int[] getValues()

Returns: int[]

toString(int documentSecurity)

public static String toString(int documentSecurity)

Parameters:

Parameter	Type	Description
documentSecurity	int

Returns: java.lang.String

toStringSet(int attr)

public static String toStringSet(int attr)

Parameters:

Parameter	Type	Description
attr	int

Returns: java.lang.String