Open Kilda Java Documentation
Static Public Member Functions | Static Public Attributes | List of all members
org.openkilda.messaging.Utils Class Reference

Static Public Member Functions

static boolean validateVlanRange (final Integer vlanId)
 
static boolean validateOutputVlanType (final Integer outputVlanId, final OutputVlanType outputVlanType)
 
static boolean validateInputVlanType (final Integer inputVlanId, final OutputVlanType outputVlanType)
 
static boolean validateSwitchId (SwitchId switchId)
 

Static Public Attributes

static final ObjectMapper MAPPER = new ObjectMapper()
 
static final String TIMESTAMP = "timestamp"
 
static final String TRANSACTION_ID = "transaction_id"
 
static final String CORRELATION_ID = "correlation_id"
 
static final String EXTRA_AUTH = "EXTRA_AUTH"
 
static final String DESTINATION = "destination"
 
static final String ROUTE = "route"
 
static final String PAYLOAD = "payload"
 
static final String FLOW_ID = "flowid"
 
static final String FLOW_PATH = "flowpath"
 
static final String DEFAULT_CORRELATION_ID = "admin-request"
 
static final String SYSTEM_CORRELATION_ID = "system-request"
 
static final String HEALTH_CHECK_OPERATIONAL_STATUS = "operational"
 
static final String HEALTH_CHECK_NON_OPERATIONAL_STATUS = "non-operational"
 
static final int ETH_TYPE = 0x8100
 

Detailed Description

Utils for flow commands.

Definition at line 27 of file Utils.java.

Member Function Documentation

◆ validateInputVlanType()

static boolean org.openkilda.messaging.Utils.validateInputVlanType ( final Integer  inputVlanId,
final OutputVlanType  outputVlanType 
)
static

Validates output vlan operation type value by input vlan tag.

Parameters
inputVlanIdinput vlan id
outputVlanTypeoutput vlan operation type
Returns
true if output vlan operation type is valid

Definition at line 132 of file Utils.java.

◆ validateOutputVlanType()

static boolean org.openkilda.messaging.Utils.validateOutputVlanType ( final Integer  outputVlanId,
final OutputVlanType  outputVlanType 
)
static

Validates output vlan operation type value by output vlan tag.

Parameters
outputVlanIdoutput vlan id
outputVlanTypeoutput vlan operation type
Returns
true if output vlan operation type is valid

Definition at line 119 of file Utils.java.

◆ validateSwitchId()

static boolean org.openkilda.messaging.Utils.validateSwitchId ( SwitchId  switchId)
static

Return true if switch id is valid.

Parameters
switchIdswitch id.
Returns
true if switch id is valid.

Definition at line 144 of file Utils.java.

◆ validateVlanRange()

static boolean org.openkilda.messaging.Utils.validateVlanRange ( final Integer  vlanId)
static

Checks if specified vlan id is in allowable range.

Parameters
vlanIdvlan id
Returns
true if vlan id is valid

Definition at line 108 of file Utils.java.

Member Data Documentation

◆ CORRELATION_ID

final String org.openkilda.messaging.Utils.CORRELATION_ID = "correlation_id"
static

The correlation ID header name.

Definition at line 43 of file Utils.java.

◆ DEFAULT_CORRELATION_ID

final String org.openkilda.messaging.Utils.DEFAULT_CORRELATION_ID = "admin-request"
static

The default correlation ID value.

Definition at line 69 of file Utils.java.

◆ DESTINATION

final String org.openkilda.messaging.Utils.DESTINATION = "destination"
static

The destination property.

Definition at line 51 of file Utils.java.

◆ ETH_TYPE

final int org.openkilda.messaging.Utils.ETH_TYPE = 0x8100
static

VLAN TAG Ether type value.

Definition at line 85 of file Utils.java.

◆ EXTRA_AUTH

final String org.openkilda.messaging.Utils.EXTRA_AUTH = "EXTRA_AUTH"
static

The correlation ID header name.

Definition at line 47 of file Utils.java.

◆ FLOW_ID

final String org.openkilda.messaging.Utils.FLOW_ID = "flowid"
static

The payload property.

Definition at line 61 of file Utils.java.

◆ FLOW_PATH

final String org.openkilda.messaging.Utils.FLOW_PATH = "flowpath"
static

The payload property.

Definition at line 65 of file Utils.java.

◆ HEALTH_CHECK_NON_OPERATIONAL_STATUS

final String org.openkilda.messaging.Utils.HEALTH_CHECK_NON_OPERATIONAL_STATUS = "non-operational"
static

The health check non operational status.

Definition at line 81 of file Utils.java.

◆ HEALTH_CHECK_OPERATIONAL_STATUS

final String org.openkilda.messaging.Utils.HEALTH_CHECK_OPERATIONAL_STATUS = "operational"
static

The health check operational status.

Definition at line 77 of file Utils.java.

◆ MAPPER

final ObjectMapper org.openkilda.messaging.Utils.MAPPER = new ObjectMapper()
static

Common object mapper.

Definition at line 31 of file Utils.java.

◆ PAYLOAD

final String org.openkilda.messaging.Utils.PAYLOAD = "payload"
static

The payload property.

Definition at line 57 of file Utils.java.

◆ ROUTE

final String org.openkilda.messaging.Utils.ROUTE = "route"
static

Definition at line 53 of file Utils.java.

◆ SYSTEM_CORRELATION_ID

final String org.openkilda.messaging.Utils.SYSTEM_CORRELATION_ID = "system-request"
static

The default correlation ID value.

Definition at line 73 of file Utils.java.

◆ TIMESTAMP

final String org.openkilda.messaging.Utils.TIMESTAMP = "timestamp"
static

The request timestamp attribute.

Definition at line 35 of file Utils.java.

◆ TRANSACTION_ID

final String org.openkilda.messaging.Utils.TRANSACTION_ID = "transaction_id"
static

The transaction ID property name.

Definition at line 39 of file Utils.java.

The documentation for this class was generated from the following file: