com.adventnet.wifi.mediation.beans
Class EncryptionSettings

java.lang.Object
  com.adventnet.wifi.mediation.beans.EncryptionSettings

public class EncryptionSettings

extends java.lang.Object

Class holding all the encryption related details. Primarily used while fetching the encryption related details from the Access point or to configure the same.

Field Summary

static int	DISABLE_KEY Constant to disable a WEP Key.
static int	WEP_KEY1 Represents the first WEP key.
static int	WEP_KEY2 Represents the second WEP key.
static int	WEP_KEY3 Represents the third WEP key.
static int	WEP_KEY4 Represents the fourth WEP key.
static int	WEP_KEYLEN_128 Constant to represent the length of the WEP key, represents WEP key of length 128 bit.
static int	WEP_KEYLEN_152 Constant to represent the length of the WEP key, represents WEP key of length 152 bit.
static int	WEP_KEYLEN_40 Constant to represent the length of the WEP key, represents WEP key of length 40 bit.
static int	WEP_KEYLEN_64 Constant to represent the length of the WEP key, represents WEP key of length 64 bit.

Constructor Summary

EncryptionSettings()

Method Summary

void	disableWEP() Method to disable the WEP.
void	disableWEPKey(int index) Method to disable the a particular WEP Key.
void	enableAESCCMP(boolean status) Sets the status of AES-CCMP encryption.
void	enableTKIP(boolean status) Sets the status of TKIP encryption.
void	enableWEPEncryption(int wepKey, java.lang.String wepKeyValue, int wepKeyLen, boolean transmitKey) API to set the WEP keys.
int	getTransmitWEPKey() Fetches the index of the key that is used for tranmission.
int	getWEPKey1Len() Fetches the first WEP key length.
java.lang.String	getWEPKey1Value() Fetches the first WEP key.
int	getWEPKey2Len() Fetches the second WEP key length.
java.lang.String	getWEPKey2Value() Fetches the second WEP key.
int	getWEPKey3Len() Fetches the third WEP key length.
java.lang.String	getWEPKey3Value() Fetches the third WEP key.
int	getWEPKey4Len() Fetches the fourth WEP key length.
java.lang.String	getWEPKey4Value() Fetches the fourth WEP key.
int	getWEPKeyLength(int index) Fetches the WEP key length corresponding to the index specified.
java.lang.String	getWEPKeyValue(int index) Fetches the WEP key corresponding to the index specified.
java.lang.String[]	getWEPKeyValues()
boolean	isAESCCMPEnabled() Returns the status of AES-CCMP encryption.
boolean	isTKIPEnabled() Returns the status of TKIP encryption.
boolean	isWEPEnabled() Returns the status of WEP encryption.
void	setTransmitWEPKey(int wepKey) Sets the WEP key that is to be used for encryption.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DISABLE_KEY

public static final int DISABLE_KEY

Constant to disable a WEP Key.

See Also:

Constant Field Values

WEP_KEY1

public static final int WEP_KEY1

Represents the first WEP key.

See Also:

Constant Field Values

WEP_KEY2

public static final int WEP_KEY2

Represents the second WEP key.

See Also:

Constant Field Values

WEP_KEY3

public static final int WEP_KEY3

Represents the third WEP key.

See Also:

Constant Field Values

WEP_KEY4

public static final int WEP_KEY4

Represents the fourth WEP key.

See Also:

Constant Field Values

WEP_KEYLEN_40

public static final int WEP_KEYLEN_40

Constant to represent the length of the WEP key, represents WEP key of length 40 bit.

See Also:

Constant Field Values

WEP_KEYLEN_64

public static final int WEP_KEYLEN_64

Constant to represent the length of the WEP key, represents WEP key of length 64 bit.

See Also:

Constant Field Values

WEP_KEYLEN_128

public static final int WEP_KEYLEN_128

Constant to represent the length of the WEP key, represents WEP key of length 128 bit.

See Also:

Constant Field Values

WEP_KEYLEN_152

public static final int WEP_KEYLEN_152

Constant to represent the length of the WEP key, represents WEP key of length 152 bit.

See Also:

Constant Field Values

Constructor Detail

EncryptionSettings

public EncryptionSettings()

Method Detail

isWEPEnabled

public boolean isWEPEnabled()

Returns the status of WEP encryption.

Returns:

the status of WEP.

disableWEP

public void disableWEP()

Method to disable the WEP.

See Also:

enableWEPEncryption(int,String,int,boolean)

disableWEPKey

public void disableWEPKey(int index)

Method to disable the a particular WEP Key.

Parameters:

index - the index of the key that is to be set.

See Also:

WEP_KEY1, WEP_KEY2, WEP_KEY3, WEP_KEY4, enableWEPEncryption(int,String,int,boolean)

enableTKIP

public void enableTKIP(boolean status)

Sets the status of TKIP encryption.

Parameters:

status - boolean indicating whether or not TKIP should be enabled.

isTKIPEnabled

public boolean isTKIPEnabled()

Returns the status of TKIP encryption.

Returns:

the status of TKIP encryption.

enableAESCCMP

public void enableAESCCMP(boolean status)

Sets the status of AES-CCMP encryption.

Parameters:

status - boolean indicating whether or not AES-CCMP should be enabled.

isAESCCMPEnabled

public boolean isAESCCMPEnabled()

Returns the status of AES-CCMP encryption.

Returns:

the status of AES-CCMP encryption.

getWEPKeyValue

public java.lang.String getWEPKeyValue(int index)

Fetches the WEP key corresponding to the index specified.

Parameters:

index - Indicates any one of the four values(WEP_KEY1,WEP_KEY2,WEP_KEY3,WEP_KEY4).

getWEPKeyValues

public java.lang.String[] getWEPKeyValues()

getWEPKeyLength

public int getWEPKeyLength(int index)

Fetches the WEP key length corresponding to the index specified.

Parameters:

index - Indicates any one of the four values(WEP_KEY1,WEP_KEY2,WEP_KEY3,WEP_KEY4).

getTransmitWEPKey

public int getTransmitWEPKey()

Fetches the index of the key that is used for tranmission.

Returns:

the index of the key used for transmission.

setTransmitWEPKey

public void setTransmitWEPKey(int wepKey)

Sets the WEP key that is to be used for encryption.

Parameters:

wepKey - the index of the WEP key that is to be used.

enableWEPEncryption

public void enableWEPEncryption(int wepKey,
                                java.lang.String wepKeyValue,
                                int wepKeyLen,
                                boolean transmitKey)

API to set the WEP keys. WEP encryption is automatically enabled if the keys are set, so no explicit methods are provided to enable WEP encryption.

Parameters:

wepKey - the index of the key that is to be set.

wepKeyValue - the WEP String.

wepKeyLen - the length of the WEP key.

transmitKey - the key that is to be currently used for encryption, this can be any one of the four keys that are set.

getWEPKey1Len

public int getWEPKey1Len()

Fetches the first WEP key length.

Returns:

the first WEP key length.

getWEPKey2Len

public int getWEPKey2Len()

Fetches the second WEP key length.

Returns:

the second WEP key length.

getWEPKey3Len

public int getWEPKey3Len()

Fetches the third WEP key length.

Returns:

the third WEP key length.

getWEPKey4Len

public int getWEPKey4Len()

Fetches the fourth WEP key length.

Returns:

the fourth WEP key length.

getWEPKey1Value

public java.lang.String getWEPKey1Value()

Fetches the first WEP key.

Returns:

the first WEP key.

getWEPKey2Value

public java.lang.String getWEPKey2Value()

Fetches the second WEP key.

Returns:

the second WEP key.

getWEPKey3Value

public java.lang.String getWEPKey3Value()

Fetches the third WEP key.

Returns:

the third WEP key.

getWEPKey4Value

public java.lang.String getWEPKey4Value()

Fetches the fourth WEP key.

Returns:

the fourth WEP key.

toString

public java.lang.String toString()