nl.teslanet.mule.connectors.coap.api.config

Class BlockwiseParams

java.lang.Object

nl.teslanet.mule.connectors.coap.api.config.BlockwiseParams

All Implemented Interfaces:

VisitableConfig

public class BlockwiseParams
extends Object
implements VisitableConfig

Configuration of blockwise parameters

Field Summary

Fields

Modifier and Type	Field and Description
boolean	entityTooLargeFailover When activated CoAP client will try to use block mode or adapt the block size when receiving a 4.13 Entity too large response code.
Integer	maxMessageSize The maximum payload size [bytes] that can be transferred in a single message, i.e.
Integer	maxResourceBodySize The maximum size [bytes] of a resource body that will be accepted as the payload of a POST/PUT or the response to a GET request in a transparent blockwise transfer.
Integer	preferredBlockSize The block size [bytes] to use when doing a blockwise transfer.
String	statusInterval The interval in milliseconds [ms] for removing expired/stale blockwise entries.
String	statusLifetime The maximum amount of time in milliseconds [ms], allowed between transfers of individual blocks in a blockwise transfer, before the blockwise transfer state is discarded.
boolean	strictBlock1Option When activated the the Block1 option should be included in the error-responses.
boolean	strictBlock2Option When activated the Block2 option is also included when client requests early blockwise negotiation but the response can be sent on one packet.

Constructor Summary

Constructors

Constructor and Description
BlockwiseParams()

Method Summary

Modifier and Type	Method and Description
void	accept(ConfigVisitor visitor) Accept visitor.
boolean	equals(Object obj)
int	hashCode()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

preferredBlockSize

@Parameter
 @Optional(defaultValue="512")
 @Summary(value="The block size [bytes] to use when doing a blockwise transfer. This value serves as the upper limit for block size in blockwise transfers.")
 @Expression(value=NOT_SUPPORTED)
 @ParameterDsl(allowReferences=false)
public Integer preferredBlockSize

The block size [bytes] to use when doing a blockwise transfer. This value serves as the upper limit for block size in blockwise transfers.

maxMessageSize

@Parameter
 @Optional(defaultValue="1024")
 @Summary(value="The maximum payload size [bytes] that can be transferred in a single message, i.e. without requiring a blockwise transfer. This value cannot exceed the network\'s MTU.")
 @Expression(value=NOT_SUPPORTED)
 @ParameterDsl(allowReferences=false)
public Integer maxMessageSize

The maximum payload size [bytes] that can be transferred in a single message, i.e. without requiring a blockwise transfer. This value cannot exceed the network's MTU.

maxResourceBodySize

@Parameter
 @Optional(defaultValue="8192")
 @Summary(value="The maximum size [bytes] of a resource body that will be accepted as the payload of a POST/PUT or the response to a GET request in a transparent blockwise transfer.")
 @Expression(value=NOT_SUPPORTED)
 @ParameterDsl(allowReferences=false)
public Integer maxResourceBodySize

The maximum size [bytes] of a resource body that will be accepted as the payload of a POST/PUT or the response to a GET request in a transparent blockwise transfer. Note that this option does not prevent local clients or resource implementations from sending large bodies as part of a request or response to a peer.

statusLifetime

@Parameter
 @Optional(defaultValue="5m")
 @Summary(value=" The maximum amount of time allowed between transfers of individual blocks in a blockwise transfer, before the blockwise transfer state is discarded.")
 @Expression(value=NOT_SUPPORTED)
 @ParameterDsl(allowReferences=false)
public String statusLifetime

The maximum amount of time in milliseconds [ms], allowed between transfers of individual blocks in a blockwise transfer, before the blockwise transfer state is discarded.

statusInterval

@Parameter
 @Optional(defaultValue="5s")
 @Summary(value="The interval for removing expired/stale blockwise entries.")
 @Expression(value=NOT_SUPPORTED)
 @ParameterDsl(allowReferences=false)
public String statusInterval

The interval in milliseconds [ms] for removing expired/stale blockwise entries.

strictBlock1Option

@Parameter
 @Optional(defaultValue="false")
 @Summary(value="When activated the the Block1 option should be included in the error-responses.")
 @Expression(value=NOT_SUPPORTED)
 @ParameterDsl(allowReferences=false)
public boolean strictBlock1Option

When activated the the Block1 option should be included in the error-responses.

strictBlock2Option

@Parameter
 @Optional(defaultValue="false")
 @Summary(value="When activated the Block2 option is also included when client requests early \nblockwise negotiation but the response can be sent on one packet.")
 @Expression(value=NOT_SUPPORTED)
 @ParameterDsl(allowReferences=false)
public boolean strictBlock2Option

When activated the Block2 option is also included when client requests early blockwise negotiation but the response can be sent on one packet.

entityTooLargeFailover

@Parameter
 @Optional(defaultValue="true")
 @Summary(value="When activated CoAP client will try to use block mode or adapt \nthe block size when receiving a 4.13 Entity too large response code.")
 @Expression(value=NOT_SUPPORTED)
 @ParameterDsl(allowReferences=false)
public boolean entityTooLargeFailover

When activated CoAP client will try to use block mode or adapt the block size when receiving a 4.13 Entity too large response code.

Constructor Detail

BlockwiseParams

public BlockwiseParams()

Method Detail

accept

public void accept(ConfigVisitor visitor)
            throws ConfigException

Accept visitor.

Specified by:

accept in interface VisitableConfig

Parameters:

visitor - The visitor of the configuration object.

Throws:

ConfigException - When the visit was not successful.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

Object.hashCode()