com.adventnet.wifi.mediation.beans
Class RadioBean

java.lang.Object
  com.adventnet.wifi.mediation.beans.AbstractBean
      com.adventnet.wifi.mediation.beans.RadioBean

All Implemented Interfaces:

RadioBeanConstants

public class RadioBean

extends AbstractBean

implements RadioBeanConstants

Class holding the radio related parameters of the Access point. This class is primarily used to fetch the radio related details from the Accesss point or to configure the same.

Field Summary

static int	ANTENNA_DIVERSITY Constant used to represent diversity.
static int	ANTENNA_LEFT Constant used to represent the left Antenna.
static int	ANTENNA_RIGHT Constant used to represent the right Antenna.
static int	HALF_POWER Constant to represent half power.
static int	MAXIMUM_POWER Constant to represent maximum power.
static int	MINIMUM_POWER Constant to represent minimum power.
static int	PREAMBLE_LONG Represents long preamble.
static int	PREAMBLE_SHORT Represents short preamble.
static int	QUARTER_POWER Constant to represent quarter power.
static int	SELECT_AUTO_CHANNEL Deprecated. This variable is deprecated. Kindly use setAutoChannelSelectionEnable(boolean)

Fields inherited from interface com.adventnet.wifi.mediation.RadioBeanConstants

BEACON_PERIOD, CHANNEL, DATA_RATE, DATA_RETRIES, DTIM_PERIOD, ENABLE_RADIO, FRAGMENT_THRESHOLD, RADIO_PREAMBLE, RECEIVE_ANTENNA, RTS_RETRIES, RTS_THRESHOLD, TRANSMIT_ANTENNA, TRANSMIT_POWER

Constructor Summary

RadioBean()
Constructor for the RadioBean

Method Summary

int	getBeaconPeriod() Fetches the transmission interval of the beacon frames.
int	getChannel() Fetches the channel in which the radio is operating.
java.lang.Object	getData() Returns the data for configuration.
DataRateSettings	getDataRate() Fetches the data rate settings of this radio.
int	getDataRetries() Fetches the value configured for retries for data frames.
int	getDTIMPeriod() Fetches the DTIM period for the radio.
int	getFragmentationThreshold() Fetches the fragmentation threshold value configured in the Access point.
int	getPreamble() Fetches the preamble type of the radio.
int	getReceiveAntenna() Fetches the antenna used for receiving.
int	getRTSRetries() Fetches the value configured for retries for RTS frames.
int	getRTSThreshold() Fetches the RTS (Request To Send) threshold value configured in the Access point.
static java.lang.String[]	getTemplateConstants() Used for internal purposes.
int	getTransmitAntenna() Fetches the antenna used for transmitting.
int	getTransmitPower() Fetches the transmit power of the radio.
boolean	isAutoChannelSelectionEnabled() Says whether the AP is in AutoSelection Mode.
boolean	isRadioEnabled() Returns the status of that particular radio of the Access point.
void	setAutoChannelSelectionEnable(boolean autoChannel) Sets the APs to the auto selection mode of the channel.
void	setBeaconPeriod(int period) Sets radio's beacon period.
void	setChannel(int ch) Sets the channel for the radio.
void	setDataRate(DataRateSettings ds) Sets the data rate settings for this radio.
void	setDataRetries(int retries) Sets the value configured for retries for data frames.
void	setDTIMPeriod(int period) Sets the DTIM period for the radio.
void	setEnableRadio(boolean status) Sets the status of that particular radio of the Access point
void	setFragmentationThreshold(int value) Sets the fragmentation threshold value for the radio.
void	setPreamble(int pre) Sets the Preamble type for the radio, throws IllegalArgumentException.
void	setRadioMode(int radioMode) Sets the mode (802.11a/b/g) of the radio represented by this bean.
void	setReceiveAntenna(int antenna) Sets the Receive Antenna for the radio.
void	setRTSRetries(int retries) Sets the value for retries for RTS frames.
void	setRTSThreshold(int thresh) Sets the RTS (Request To Send) threshold value configured in the Access point.
void	setTransmitAntenna(int antenna) Sets the antenna used for transmitting.
void	setTransmitPower(int power) Sets the Transmit Power for the radio.
java.lang.String	toString() Returns the String representation of this bean.

Methods inherited from class com.adventnet.wifi.mediation.beans.AbstractBean

getOperationType, getRadioIndex, getRadioMac, getRadioMode, setOperationType, setRadioIndex, setRadioMac

Methods inherited from class java.lang.Object

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

Field Detail

SELECT_AUTO_CHANNEL

public static final int SELECT_AUTO_CHANNEL

Deprecated. This variable is deprecated. Kindly use setAutoChannelSelectionEnable(boolean)

Constant used to represent Auto Channel Select.

See Also:

Constant Field Values

ANTENNA_LEFT

public static final int ANTENNA_LEFT

Constant used to represent the left Antenna.

See Also:

Constant Field Values

ANTENNA_RIGHT

public static final int ANTENNA_RIGHT

Constant used to represent the right Antenna.

See Also:

Constant Field Values

ANTENNA_DIVERSITY

public static final int ANTENNA_DIVERSITY

Constant used to represent diversity.

See Also:

Constant Field Values

MAXIMUM_POWER

public static final int MAXIMUM_POWER

Constant to represent maximum power.

See Also:

Constant Field Values

MINIMUM_POWER

public static final int MINIMUM_POWER

Constant to represent minimum power.

See Also:

Constant Field Values

HALF_POWER

public static final int HALF_POWER

Constant to represent half power.

See Also:

Constant Field Values

QUARTER_POWER

public static final int QUARTER_POWER

Constant to represent quarter power.

See Also:

Constant Field Values

PREAMBLE_SHORT

public static final int PREAMBLE_SHORT

Represents short preamble.

See Also:

Constant Field Values

PREAMBLE_LONG

public static final int PREAMBLE_LONG

Represents long preamble.

See Also:

Constant Field Values

Constructor Detail

RadioBean

public RadioBean()

Constructor for the RadioBean

Method Detail

setRadioMode

public void setRadioMode(int radioMode)

Description copied from class: AbstractBean

Sets the mode (802.11a/b/g) of the radio represented by this bean.

Overrides:

setRadioMode in class AbstractBean

Parameters:

radioMode - the mode (802.11 a/b/g) of the radio.

See Also:

MediationConstants.RADIO_A, MediationConstants.RADIO_BG

isRadioEnabled

public boolean isRadioEnabled()

Returns the status of that particular radio of the Access point.

Returns:

status of the radio

setEnableRadio

public void setEnableRadio(boolean status)

Sets the status of that particular radio of the Access point

Parameters:

status - boolean to enable/disable the radio of the device.

setAutoChannelSelectionEnable

public void setAutoChannelSelectionEnable(boolean autoChannel)

Sets the APs to the auto selection mode of the channel.

isAutoChannelSelectionEnabled

public boolean isAutoChannelSelectionEnabled()

Says whether the AP is in AutoSelection Mode.

getChannel

public int getChannel()

Fetches the channel in which the radio is operating.

Returns:

radio's channel.

setChannel

public void setChannel(int ch)

Sets the channel for the radio.

Parameters:

ch - the channel in which the radio has to operate.

getRTSThreshold

public int getRTSThreshold()

Fetches the RTS (Request To Send) threshold value configured in the Access point. RTSThreshold value refers to the size of the data packet above which the Access point has to initiate RTS request.

Returns:

the RTS threshold value

setRTSThreshold

public void setRTSThreshold(int thresh)

Sets the RTS (Request To Send) threshold value configured in the Access point. RTSThreshold value refers to the size of the data packet above which the Access point has to initiate RTS request.

Parameters:

thresh - the RTS threshold limit for the radio.

getRTSRetries

public int getRTSRetries()

Fetches the value configured for retries for RTS frames. RTS retries refers to the number of attempts that the Access point should make to send the RTS frame if it encounters a problem in sending it.

Returns:

RTS retries value.

setRTSRetries

public void setRTSRetries(int retries)

Sets the value for retries for RTS frames. RTS retries refers to the number of attempts that the Access point should make to send the RTS frame if it encounters a problem in sending it.

Parameters:

retries - RTS retries value.

getDataRetries

public int getDataRetries()

Fetches the value configured for retries for data frames. This retries value refers to the number of attempts that the Access point should make to send the frame if it encounters a problem in sending it.

Returns:

the retries value.

setDataRetries

public void setDataRetries(int retries)

Sets the value configured for retries for data frames. This retries value refers to the number of attempts that the Access point should make to send the frame if it encounters a problem in sending it.

Parameters:

retries - the data retries for the radio.

getFragmentationThreshold

public int getFragmentationThreshold()

Fetches the fragmentation threshold value configured in the Access point. fragmentation threshold value refers to the maximum size of the data packet transmitted over the radio. If the data packet's size exceeds this value it gets fragmented into smaller packets.

Returns:

the fragmentation threshold value

setFragmentationThreshold

public void setFragmentationThreshold(int value)

Sets the fragmentation threshold value for the radio. fragmentation threshold value refers to the maximum size of the data packet transmitted over the radio. If the data packet's size exceeds this value it gets fragmented into smaller packets.

Parameters:

value - the fragmentation threshold value.

getBeaconPeriod

public int getBeaconPeriod()

Fetches the transmission interval of the beacon frames. That is the time period between two successive beacon frame transmission. Beacon frames are transmitted by an access point at regular intervals to announce the existence of the wireless network.

Returns:

the beacon interval.

setBeaconPeriod

public void setBeaconPeriod(int period)

Sets radio's beacon period. Beacon frames are transmitted by an access point at regular intervals to announce the existence of the wireless network. The default behavior is to send a beacon frame once every 100 milliseconds (or 10 per second). The Beacon Interval value is set in milliseconds. Enter a value from 20 to 2000.

Parameters:

period - the beacon period for the radio in milliseconds.

getDTIMPeriod

public int getDTIMPeriod()

Fetches the DTIM period for the radio. The Delivery Traffic Information Map (DTIM) message is an element included in some Beacon frames. It indicates which client stations, currently sleeping in low-power mode, have data buffered on the access point awaiting pick-up. The DTIM period you specify determines how often the access point sents a beacon containing a Delivery Traffic Indicator Message (DTIM). When client devices receive a beacon that contains a DTIM, they normally wake up to check for pending packets. Longer intervals between DTIMs let clients sleep longer and preserve power. Conversely, shorter DTIM periods reduce the delay in receiving packets but use more battery power because clients wake up more often.

Returns:

the DTIM period

setDTIMPeriod

public void setDTIMPeriod(int period)

Sets the DTIM period for the radio. The Delivery Traffic Information Map (DTIM) message is an element included in some Beacon frames. It indicates which client stations, currently sleeping in low-power mode, have data buffered on the access point awaiting pick-up. The DTIM period you specify determines how often the access point sents a beacon containing a Delivery Traffic Indicator Message (DTIM). When client devices receive a beacon that contains a DTIM, they normally wake up to check for pending packets. Longer intervals between DTIMs let clients sleep longer and preserve power. Conversely, shorter DTIM periods reduce the delay in receiving packets but use more battery power because clients wake up more often.

Parameters:

period - the DTIM period for the radio.

getPreamble

public int getPreamble()

Fetches the preamble type of the radio.

Returns:

the preamble type

See Also:

PREAMBLE_SHORT, PREAMBLE_LONG

setPreamble

public void setPreamble(int pre)

Sets the Preamble type for the radio, throws IllegalArgumentException.

Parameters:

pre - Sets the Preamble for the radio.

See Also:

PREAMBLE_SHORT, PREAMBLE_LONG

getReceiveAntenna

public int getReceiveAntenna()

Fetches the antenna used for receiving.

Returns:

the receive antenna.

See Also:

ANTENNA_LEFT, ANTENNA_RIGHT, ANTENNA_DIVERSITY

setReceiveAntenna

public void setReceiveAntenna(int antenna)

Sets the Receive Antenna for the radio.

Parameters:

antenna - the receive antenna.

See Also:

ANTENNA_LEFT, ANTENNA_RIGHT, ANTENNA_DIVERSITY

getTransmitAntenna

public int getTransmitAntenna()

Fetches the antenna used for transmitting.

Returns:

the transmit antenna.

See Also:

ANTENNA_LEFT, ANTENNA_RIGHT, ANTENNA_DIVERSITY

setTransmitAntenna

public void setTransmitAntenna(int antenna)

Sets the antenna used for transmitting.

Parameters:

antenna - the transmit antenna.

See Also:

ANTENNA_LEFT, ANTENNA_RIGHT, ANTENNA_DIVERSITY

setTransmitPower

public void setTransmitPower(int power)

Sets the Transmit Power for the radio.

Parameters:

power - the transmit Power for the radio.

getTransmitPower

public int getTransmitPower()

Fetches the transmit power of the radio.

Returns:

the transmit power.

setDataRate

public void setDataRate(DataRateSettings ds)

Sets the data rate settings for this radio.

Parameters:

ds - the object with all required data rate settings.

getDataRate

public DataRateSettings getDataRate()

Fetches the data rate settings of this radio.

Returns:

the DataRateSettings object.

toString

public java.lang.String toString()

Returns the String representation of this bean.

Returns:

this bean as String.

getData

public java.lang.Object getData()

Description copied from class: AbstractBean

Returns the data for configuration. Used for internal purposes.

Overrides:

getData in class AbstractBean

getTemplateConstants

public static java.lang.String[] getTemplateConstants()

Description copied from class: AbstractBean

Used for internal purposes.