io.starter.formats.XLS

Class ProtectionManager

java.lang.Object

io.starter.formats.XLS.ProtectionManager

Direct Known Subclasses:

BookProtectionManager, SheetProtectionManager

public abstract class ProtectionManager
extends Object

Coordinates the various records involved in protection.

Field Summary

Fields

Modifier and Type	Field and Description
protected FeatHeadr	enhancedProtection
protected Password	password
protected Protect	protect

Constructor Summary

Constructors

Constructor and Description
ProtectionManager()

Method Summary

Modifier and Type	Method and Description
void	addRecord(BiffRec record) Adds a protection-related record to be managed.
boolean	checkPassword(String guess) Checks whether the given password matches the protection password.
void	close() clear out object references in prep for closing workbook
String	getPassword() Returns the entity's password verifier.
boolean	getProtected() Returns whether the entity is protected.
void	setPassword(String pass) Sets or removes the entity's protection password.
void	setPasswordHashed(String pass) Sets or removes the entity's protection password.
void	setProtected(boolean value) Sets whether the sheet is protected.

Methods inherited from class java.lang.Object

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

Field Detail

protect

protected Protect protect

enhancedProtection

protected FeatHeadr enhancedProtection

password

protected Password password

Constructor Detail

ProtectionManager

public ProtectionManager()

Method Detail

addRecord

public void addRecord(BiffRec record)

Adds a protection-related record to be managed. This method will be called automatically by the init() method of the record where appropriate. It should probably never be called anywhere else.

Parameters:

record - the record to be managed

getProtected

public boolean getProtected()

Returns whether the entity is protected.

setProtected

public void setProtected(boolean value)

Sets whether the sheet is protected.

getPassword

public String getPassword()

Returns the entity's password verifier.

Returns:

the password verifier as four upper-case hexadecimal digits or "0000" if no password is set on the sheet

setPassword

public void setPassword(String pass)

Sets or removes the entity's protection password.

Parameters:

pass - the string password to set or null to remove the password

setPasswordHashed

public void setPasswordHashed(String pass)

Sets or removes the entity's protection password.

Parameters:

pass - the pre-hashed string password to set or null to remove the password

checkPassword

public boolean checkPassword(String guess)

Checks whether the given password matches the protection password.

Parameters:

guess - the password to be checked against the stored hash

Returns:

whether the given password matches the stored hash

close

public void close()

clear out object references in prep for closing workbook