Package org.springframework.security.rsocket.api

Enum Class PayloadExchangeType

java.lang.Object

java.lang.Enum<PayloadExchangeType>

org.springframework.security.rsocket.api.PayloadExchangeType

All Implemented Interfaces:

Serializable, Comparable<PayloadExchangeType>, Constable

public enum PayloadExchangeType
extends Enum<PayloadExchangeType>

The PayloadExchange type

Since:

5.2

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FIRE_AND_FORGET	A Fire and Forget exchange.
METADATA_PUSH	A Metadata Push exchange.
PAYLOAD	A Payload exchange.
REQUEST_CHANNEL	A Request Channel exchange.
REQUEST_RESPONSE	A Request Response exchange.
REQUEST_STREAM	A Request Stream exchange.
SETUP	The Setup.

Method Summary

Modifier and Type	Method	Description
boolean	isRequest()	Determines if this exchange is a type of request (i.e.
static PayloadExchangeType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PayloadExchangeType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SETUP

public static final PayloadExchangeType SETUP

The Setup. Can be used to determine if a Payload is part of the connection

FIRE_AND_FORGET

public static final PayloadExchangeType FIRE_AND_FORGET

A Fire and Forget exchange.

REQUEST_RESPONSE

public static final PayloadExchangeType REQUEST_RESPONSE

A Request Response exchange.

REQUEST_STREAM

public static final PayloadExchangeType REQUEST_STREAM

A Request Stream exchange. This is only represents the request portion. The PAYLOAD type represents the data that submitted.

REQUEST_CHANNEL

public static final PayloadExchangeType REQUEST_CHANNEL

A Request Channel exchange.

PAYLOAD

public static final PayloadExchangeType PAYLOAD

A Payload exchange.

METADATA_PUSH

public static final PayloadExchangeType METADATA_PUSH

A Metadata Push exchange.

Method Details

values

public static PayloadExchangeType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static PayloadExchangeType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

isRequest

public boolean isRequest()

Determines if this exchange is a type of request (i.e. the initial frame).

Returns:

true if it is a request, else false