Skip navigation links

com.bharosa.vcrypt.auth.keypad
Class AuthentiPad

java.lang.Object
com.bharosa.vcrypt.auth.keypad.AuthentiPad

All Implemented Interfaces:

Serializable

public abstract class AuthentiPad

extends Object

implements Serializable

This encapsulates all the properties for the KeyPad which was generated for the given session.

See Also:

Serialized Form

Field Summary

protected AuthentiConfig	authentiConfig
protected Rectangle	authentiPadArea
protected AuthentiKey	authKey
protected static String	CAPTIONCONFIRMPAD
protected static String	CAPTIONPAD
protected VCryptLocalizedString	captionText
protected boolean	displayOnly
protected double	fileSizeEncryptValue
protected String	frameFileName
protected boolean	hasImgs
protected boolean	hasJS
protected String	imageFileName
protected boolean	isADACompliant
protected boolean	isInitialized
protected static String	KEYPAD
protected static Logger	logger
protected static String	NOIMG
protected String	padId
protected String	padKeySetProp
protected String	padName
protected String	padProp
protected String	padPropPrefix
protected String	padType
protected static String	PINPAD
protected static String	QUESTIONPAD
protected VCryptLocalizedString	questionText
protected static String	TEXTPAD
protected static String	TEXTPADRESET
protected Date	timeStamp
protected TimeZone	timeZone
protected boolean	useCaps
protected String	userInput

Constructor Summary

protected

AuthentiPad(String padName, String backgroundFilePath, String frameFilePath)

Method Summary

String	getADAImageMap() Gets the Image Map for ADA compliant AuthentiPads.
AuthentiConfig	getAuthentiConfig()
Rectangle	getAuthentiPadArea() Gets the value of AuthentiPadArea
AuthentiKey	getAuthKey() Gets the value of authKey
VCryptLocalizedString	getCaptionText() Gets the value of captionText
boolean	getDisplayOnly() Gets the value of displayOnly
double	getFileSizeEncryptValue() Gets the value of fileSizeEncryptValue
String	getFrameFileName() Gets the value of frameFileName
boolean	getHasImgs() Gets the value of Has Images Flag
boolean	getHasJS() Gets the value of Has Javascript Flag
String	getHTML() Gets the HTML for rendering an AuthentiPad.
String	getImageFileName() Gets the value of imageFileName
String	getImageMap()
boolean	getIsADACompliant() Gets the value of Is ADA Compliant Flag
String	getKeyboardControls() Gets the HTML for controls on the AuthentiPads.
protected String	getKeyboardControls(AuthentiConfig authConfig) Gets the HTML for controls on the AuthentiPads.
static Logger	getLogger() Gets the value of logger
String	getNonADAImageMap() Gets the Image Map for non ADA compliant AuthentiPads.
String	getNoScriptHTML() Gets the non javascript alternative HTML an AuthentiPad.
protected String	getNoScriptHTML(AuthentiConfig authConfig) Gets the non javascript alternative HTML an AuthentiPad.
String	getPadId()
String	getPadKeySetProp()
String	getPadName() Gets the value of padName
protected abstract PadImageDirectory	getParentImageDir()
VCryptLocalizedString	getQuestionText() Gets the value of questionText
Date	getTimeStamp() Gets the value of timeStamp
TimeZone	getTimeZone() Gets the value of timeZone
boolean	getUseCaps() Gets the value of Use Caps Flag
String	getUserInput() Gets the value of userInput
protected void	initialize()
void	setAuthentiPadArea(Rectangle argAuthentiPadArea) Sets the value of AuthentiPadArea
void	setAuthKey(AuthentiKey argAuthKey) Sets the value of authKey
void	setCaptionText(String captionText) Sets the value of captionText
void	setCaptionText(String captionText, Locale locale) Sets the value of captionText
void	setCaptionText(VCryptLocalizedString captionText) Sets the value of captionText
void	setDisplayOnly(boolean argDisplayOnly) Sets the value of displayOnly
void	setFileSizeEncryptValue(double argFileSizeEncryptValue) Sets the value of fileSizeEncryptValue
void	setFrameFileName(String argFrameFileName) Sets the value of frameFileName
void	setHasImgs(boolean argHasImgs) Sets the value of Has Images Flag
void	setHasJS(boolean argHasJS) Sets the value of Has Javascript Flag
void	setImageFileName(String argImageFileName) Sets the value of imageFileName
void	setIsADACompliant(boolean argIsADACompliant) Sets the value of Is ADA Compliant Flag
static void	setLogger(Logger argLogger) Sets the value of logger
void	setPadId(String padId)
void	setPadKeySetProp(String padKeySetProp)
void	setQuestionText(String argQuestionText) Sets the value of questionText
void	setQuestionText(String argQuestionText, Locale locale) Sets the value of questionText
void	setQuestionText(VCryptLocalizedString argQuestionText) Sets the value of questionText
void	setTimeStamp(Date argTimeStamp) Sets the value of timeStamp
void	setTimeZone(TimeZone argTimeZone) Sets the value of timeZone
void	setUseCaps(boolean argUseCaps) Sets the value of Use Caps Flag
void	setUserInput(String argUserInput) Sets the value of userInput

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static Logger logger

PINPAD

protected static String PINPAD

KEYPAD

protected static String KEYPAD

QUESTIONPAD

protected static String QUESTIONPAD

CAPTIONPAD

protected static String CAPTIONPAD

CAPTIONCONFIRMPAD

protected static String CAPTIONCONFIRMPAD

TEXTPAD

protected static String TEXTPAD

TEXTPADRESET

protected static String TEXTPADRESET

NOIMG

protected static String NOIMG

fileSizeEncryptValue

protected double fileSizeEncryptValue

padType

protected String padType

padProp

protected String padProp

padPropPrefix

protected String padPropPrefix

padKeySetProp

protected String padKeySetProp

padName

protected String padName

imageFileName

protected String imageFileName

frameFileName

protected String frameFileName

captionText

protected VCryptLocalizedString captionText

timeStamp

protected Date timeStamp

timeZone

protected TimeZone timeZone

questionText

protected VCryptLocalizedString questionText

userInput

protected String userInput

displayOnly

protected boolean displayOnly

hasImgs

protected boolean hasImgs

hasJS

protected boolean hasJS

padId

protected String padId

isInitialized

protected boolean isInitialized

isADACompliant

protected boolean isADACompliant

useCaps

protected boolean useCaps

authKey

protected AuthentiKey authKey

authentiPadArea

protected Rectangle authentiPadArea

authentiConfig

protected transient AuthentiConfig authentiConfig

Constructor Detail

AuthentiPad

protected AuthentiPad(String padName,
                      String backgroundFilePath,
                      String frameFilePath)

Method Detail

getParentImageDir

protected abstract PadImageDirectory getParentImageDir()

initialize

protected void initialize()
                   throws ObjectNotCreatedException

Throws:

ObjectNotCreatedException

getAuthentiConfig

public AuthentiConfig getAuthentiConfig()

getLogger

public static Logger getLogger()

Gets the value of logger

Returns:

the value of logger

setLogger

public static void setLogger(Logger argLogger)

Sets the value of logger

Parameters:

argLogger - Value to assign to this.logger

getPadName

public String getPadName()

Gets the value of padName

Returns:

the value of padName

getCaptionText

public VCryptLocalizedString getCaptionText()

Gets the value of captionText

Returns:

the value of captionText

setCaptionText

public void setCaptionText(String captionText)

Sets the value of captionText

Parameters:

captionText - Value to assign to this.captionText

setCaptionText

public void setCaptionText(String captionText,
                           Locale locale)

Sets the value of captionText

Parameters:

captionText - Value to assign to this.captionText

locale - Locale of captionText

setCaptionText

public void setCaptionText(VCryptLocalizedString captionText)

Sets the value of captionText

Parameters:

captionText - Value to assign to this.captionText

getQuestionText

public VCryptLocalizedString getQuestionText()

Gets the value of questionText

Returns:

the value of questionText

setQuestionText

public void setQuestionText(String argQuestionText)

Sets the value of questionText

Parameters:

argQuestionText - Value to assign to this.questionText

setQuestionText

public void setQuestionText(String argQuestionText,
                            Locale locale)

Sets the value of questionText

Parameters:

argQuestionText - Value to assign to this.questionText

locale - Locale of questionText

setQuestionText

public void setQuestionText(VCryptLocalizedString argQuestionText)

Sets the value of questionText

Parameters:

argQuestionText - Value to assign to this.questionText

getTimeStamp

public Date getTimeStamp()

Gets the value of timeStamp

Returns:

the value of timeStamp

setTimeStamp

public void setTimeStamp(Date argTimeStamp)

Sets the value of timeStamp

Parameters:

argTimeStamp - Value to assign to this.timeStamp

getTimeZone

public TimeZone getTimeZone()

Gets the value of timeZone

Returns:

the value of timeZone

setTimeZone

public void setTimeZone(TimeZone argTimeZone)

Sets the value of timeZone

Parameters:

argTimeZone - Value to assign to this.timeZone

getPadKeySetProp

public String getPadKeySetProp()

setPadKeySetProp

public void setPadKeySetProp(String padKeySetProp)

getDisplayOnly

public boolean getDisplayOnly()

Gets the value of displayOnly

Returns:

the value of displayOnly

setDisplayOnly

public void setDisplayOnly(boolean argDisplayOnly)

Sets the value of displayOnly

Parameters:

argDisplayOnly - Value to assign to this.displayOnly

getImageFileName

public String getImageFileName()

Gets the value of imageFileName

Returns:

the value of imageFileName

setImageFileName

public void setImageFileName(String argImageFileName)

Sets the value of imageFileName

Parameters:

argImageFileName - Value to assign to this.imageFileName

getFrameFileName

public String getFrameFileName()

Gets the value of frameFileName

Returns:

the value of frameFileName

setFrameFileName

public void setFrameFileName(String argFrameFileName)

Sets the value of frameFileName

Parameters:

argFrameFileName - Value to assign to this.frameFileName

setIsADACompliant

public void setIsADACompliant(boolean argIsADACompliant)

Sets the value of Is ADA Compliant Flag

Parameters:

argIsADACompliant - Value to assign to this.randomizeKeysFlag

getIsADACompliant

public boolean getIsADACompliant()

Gets the value of Is ADA Compliant Flag

Returns:

the value of isADACompliant

setHasImgs

public void setHasImgs(boolean argHasImgs)

Sets the value of Has Images Flag

Parameters:

argHasImgs - Value to assign to this.hasImgs

getHasImgs

public boolean getHasImgs()

Gets the value of Has Images Flag

Returns:

the value of hasImgs

setHasJS

public void setHasJS(boolean argHasJS)

Sets the value of Has Javascript Flag

Parameters:

argHasJS - Value to assign to this.hasImgs

getUseCaps

public boolean getUseCaps()

Gets the value of Use Caps Flag

Returns:

the value of useCaps

setUseCaps

public void setUseCaps(boolean argUseCaps)

Sets the value of Use Caps Flag

Parameters:

argUseCaps - Value to assign to this.useCaps

getHasJS

public boolean getHasJS()

Gets the value of Has Javascript Flag

Returns:

the value of hasJS

getAuthentiPadArea

public Rectangle getAuthentiPadArea()

Gets the value of AuthentiPadArea

Returns:

the value of authentiPadArea

setAuthentiPadArea

public void setAuthentiPadArea(Rectangle argAuthentiPadArea)

Sets the value of AuthentiPadArea

Parameters:

argAuthentiPadArea - Value to assign to this.authentiPadArea

getUserInput

public String getUserInput()

Gets the value of userInput

Returns:

the value of userInput

setUserInput

public void setUserInput(String argUserInput)

Sets the value of userInput

Parameters:

argUserInput - Value to assign to userInput

getAuthKey

public AuthentiKey getAuthKey()

Gets the value of authKey

Returns:

AuthentiKey authKey

setAuthKey

public void setAuthKey(AuthentiKey argAuthKey)

Sets the value of authKey

Parameters:

argAuthKey - Value to assign to authKey

getFileSizeEncryptValue

public double getFileSizeEncryptValue()

Gets the value of fileSizeEncryptValue

Returns:

the value of fileSizeEncryptValue

setFileSizeEncryptValue

public void setFileSizeEncryptValue(double argFileSizeEncryptValue)

Sets the value of fileSizeEncryptValue

Parameters:

argFileSizeEncryptValue - Value to assign to this.fileSizeEncryptValue

getKeyboardControls

public String getKeyboardControls()

Gets the HTML for controls on the AuthentiPads.

Returns:

The html string which includes the controls

getKeyboardControls

protected String getKeyboardControls(AuthentiConfig authConfig)

Gets the HTML for controls on the AuthentiPads.

Parameters:

authConfig - authConfig

Returns:

The html string which includes the controls

getImageMap

public String getImageMap()

getADAImageMap

public String getADAImageMap()

Gets the Image Map for ADA compliant AuthentiPads.

Returns:

The map string which includes the map tag

getNonADAImageMap

public String getNonADAImageMap()

Gets the Image Map for non ADA compliant AuthentiPads.

Returns:

The map string which includes the map tag

getHTML

public String getHTML()

Gets the HTML for rendering an AuthentiPad.

Returns:

The html string which includes the image map and javscript declarations

getPadId

public String getPadId()

setPadId

public void setPadId(String padId)

getNoScriptHTML

public String getNoScriptHTML()

Gets the non javascript alternative HTML an AuthentiPad.

Returns:

HTML string for non javascript alternative which includes image map and pad layout HTML

getNoScriptHTML

protected String getNoScriptHTML(AuthentiConfig authConfig)

Gets the non javascript alternative HTML an AuthentiPad.

Parameters:

authConfig - AuthentiConfig

Returns:

String - HTML string for non javascript alternative which includes image map and pad layout HTML

Skip navigation links