EAPOLMkpduParameterSet (ONOS Java API (1.15.0))

All Known Implementing Classes:

EAPOLMkpduBasicParameterSet, EAPOLMkpduDistributedSAKParameterSet, EAPOLMkpduICVIndicatorParameterSet, EAPOLMkpduMACSecUseParameterSet, EAPOLMkpduPeerListParameterSet
```
public interface EAPOLMkpduParameterSet
```
Class representing EAPOL MKPDU Parameter Set. IEEE 802.1X Clause 11; Figure 11-7, Table 11-6

Field Summary

Fields
Modifier and Type	Field and Description
`static byte`	`BODY_LENGTH_MSB_MASK`
`static byte`	`BODY_LENGTH_MSB_SHIFT`
`static byte`	`BODY_LENGTH_OCTET_OFFSET`
`static int`	`FIELD_MI_LENGTH`
`static int`	`FIELD_MN_LENGTH`
`static int`	`FIELD_SCI_LENGTH`
`static byte`	`PARAMETERSET_TYPE_BASIC`
`static byte`	`PARAMETERSET_TYPE_DISTRIBUTED_SAK`
`static byte`	`PARAMETERSET_TYPE_ICV_INDICATOR`
`static byte`	`PARAMETERSET_TYPE_LIVE_PEER_LIST`
`static byte`	`PARAMETERSET_TYPE_MACSEC_SAK_USE`
`static byte`	`PARAMETERSET_TYPE_POTENTIAL_PEER_LIST`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`short`	`getBodyLength()` Retrieve Body Length field of Parameter Set.
`byte`	`getParameterSetType()` Retrieve Type of Parameter Set.
`short`	`getTotalLength()` Total length; ie.
`byte[]`	`serialize()` Utility function for Serializing Parameter Set.

- Field Detail
  - PARAMETERSET_TYPE_BASIC
```
static final byte PARAMETERSET_TYPE_BASIC
```
    See Also:
    
    Constant Field Values
  - PARAMETERSET_TYPE_LIVE_PEER_LIST
```
static final byte PARAMETERSET_TYPE_LIVE_PEER_LIST
```
    See Also:
    
    Constant Field Values
  - PARAMETERSET_TYPE_POTENTIAL_PEER_LIST
```
static final byte PARAMETERSET_TYPE_POTENTIAL_PEER_LIST
```
    See Also:
    
    Constant Field Values
  - PARAMETERSET_TYPE_MACSEC_SAK_USE
```
static final byte PARAMETERSET_TYPE_MACSEC_SAK_USE
```
    See Also:
    
    Constant Field Values
  - PARAMETERSET_TYPE_DISTRIBUTED_SAK
```
static final byte PARAMETERSET_TYPE_DISTRIBUTED_SAK
```
    See Also:
    
    Constant Field Values
  - PARAMETERSET_TYPE_ICV_INDICATOR
```
static final byte PARAMETERSET_TYPE_ICV_INDICATOR
```
    See Also:
    
    Constant Field Values
  - FIELD_MI_LENGTH
```
static final int FIELD_MI_LENGTH
```
    See Also:
    
    Constant Field Values
  - FIELD_MN_LENGTH
```
static final int FIELD_MN_LENGTH
```
    See Also:
    
    Constant Field Values
  - FIELD_SCI_LENGTH
```
static final int FIELD_SCI_LENGTH
```
    See Also:
    
    Constant Field Values
  - BODY_LENGTH_MSB_MASK
```
static final byte BODY_LENGTH_MSB_MASK
```
    See Also:
    
    Constant Field Values
  - BODY_LENGTH_MSB_SHIFT
```
static final byte BODY_LENGTH_MSB_SHIFT
```
    See Also:
    
    Constant Field Values
  - BODY_LENGTH_OCTET_OFFSET
```
static final byte BODY_LENGTH_OCTET_OFFSET
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getParameterSetType
```
byte getParameterSetType()
```
    Retrieve Type of Parameter Set.
    
    Returns:
    
    parameter set type.
  - getTotalLength
```
short getTotalLength()
```
    Total length; ie. including header and body length.
    
    Returns:
    
    short value.
  - getBodyLength
```
short getBodyLength()
```
    Retrieve Body Length field of Parameter Set.
    
    Returns:
    
    body length of parameter set.
  - serialize
```
byte[] serialize()
```
    Utility function for Serializing Parameter Set.
    
    Returns:
    
    byte[] value

Interface EAPOLMkpduParameterSet

Field Summary

Method Summary

Field Detail

PARAMETERSET_TYPE_BASIC

PARAMETERSET_TYPE_LIVE_PEER_LIST

PARAMETERSET_TYPE_POTENTIAL_PEER_LIST

PARAMETERSET_TYPE_MACSEC_SAK_USE

PARAMETERSET_TYPE_DISTRIBUTED_SAK

PARAMETERSET_TYPE_ICV_INDICATOR

FIELD_MI_LENGTH

FIELD_MN_LENGTH

FIELD_SCI_LENGTH

BODY_LENGTH_MSB_MASK

BODY_LENGTH_MSB_SHIFT

BODY_LENGTH_OCTET_OFFSET

Method Detail

getParameterSetType

getTotalLength

getBodyLength

serialize