nl.teslanet.mule.connectors.coap.internal.utils

Class MessageUtils

java.lang.Object

nl.teslanet.mule.connectors.coap.internal.utils.MessageUtils

public class MessageUtils
extends Object

Utilities for handling message content.

Method Summary

Modifier and Type	Method and Description
static void	copyAcceptableRequestSize(Integer acceptableRequestSize, org.eclipse.californium.core.coap.OptionSet optionSet) Copy AcceptableRequestSize to OptionSet.
static void	copyEntityTagValue(org.mule.runtime.api.metadata.TypedValue<Object> entityTagValue, org.eclipse.californium.core.coap.OptionSet optionSet, org.mule.runtime.api.transformation.TransformationService transformationService) Copy EntityTagValue to OptionSet.
static void	copyLocationPath(String locationPath, org.eclipse.californium.core.coap.OptionSet optionSet) Copy LocationPath to OptionSet.
static void	copyLocationQuery(List<QueryParam> locationQuery, org.eclipse.californium.core.coap.OptionSet optionSet) Copy LocationQuery to OptionSet.
static void	copyMaxAge(Long maxAge, org.eclipse.californium.core.coap.OptionSet optionSet) Copy MaxAge to OptionSet.
static void	copyOptions(List<OtherOption> otherOptions, org.eclipse.californium.core.coap.OptionSet optionSet, org.mule.runtime.api.transformation.TransformationService transformationService) Copy other options from list of other options to OptionSet.
static void	copyOptions(RequestOptionsParams requestOptions, org.eclipse.californium.core.coap.OptionSet optionSet, org.mule.runtime.api.transformation.TransformationService transformationService) Copy options from RequestOptionsParams to OptionSet.
static void	copyOptions(ResponseOptionsParams responseOptions, org.eclipse.californium.core.coap.OptionSet optionSet, org.mule.runtime.api.transformation.TransformationService transformationService) Copy options from ResponseOptionsParams to OptionSet.
static void	copyResponseSize(Integer responseSize, org.eclipse.californium.core.coap.OptionSet optionSet) Copy ResponseSize to OptionSet.
static Optional<List<DefaultEntityTag>>	getList(List<byte[]> bytesList) Convenience method to create a list of Entity-tags form a list of byte arrays.
static boolean	isEqual(org.eclipse.californium.core.coap.option.OptionDefinition left, org.eclipse.californium.core.coap.option.OptionDefinition right) Establish equality of two option definitions based on their properties.
static boolean	isIn(DefaultEntityTag etag, Collection<DefaultEntityTag> etags) Check a collection of Entity-tags whether it contains the Entity-tag.
static String	queryString(List<? extends AbstractQueryParam> defaultQueryParams, List<? extends AbstractQueryParam> queryParams) Construct string representation of query parameters, merged with default parameters.
static byte[]	toBytes(Object toConvert, org.mule.runtime.api.transformation.TransformationService transformationService) Convert an object to byte array.
static org.eclipse.californium.core.coap.option.OptionDefinition	toCfOptionDefinition(OtherOptionConfig otherOptionConfig) Convert other option configuration to Cf option definition.
static OptionFormat	toOptionFormat(org.eclipse.californium.core.coap.OptionNumberRegistry.OptionFormat format) Convert Cf format to option format.
static String	uriString(List<String> path, List<? extends AbstractQueryParam> query) Create UriString from path and query.

Methods inherited from class java.lang.Object

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

Method Detail

copyOptions

public static void copyOptions(RequestOptionsParams requestOptions,
                               org.eclipse.californium.core.coap.OptionSet optionSet,
                               org.mule.runtime.api.transformation.TransformationService transformationService)
                        throws InternalInvalidOptionValueException

Copy options from RequestOptionsParams to OptionSet.

Parameters:

requestOptions - to copy from

optionSet - to copy to

transformationService - Mule transformation service.

Throws:

InternalInvalidOptionValueException - When given option value could not be copied

copyOptions

public static void copyOptions(List<OtherOption> otherOptions,
                               org.eclipse.californium.core.coap.OptionSet optionSet,
                               org.mule.runtime.api.transformation.TransformationService transformationService)
                        throws InternalInvalidOptionValueException,
                               InternalUnkownOptionException

Copy other options from list of other options to OptionSet.

Parameters:

otherOptions - to copy from.

optionSet - to copy to.

transformationService - Mules transformation service for unknown option value types.

Throws:

InternalInvalidOptionValueException - When given option value is not valid.

InternalUnkownOptionException - When given option alias was not defined.

copyOptions

public static void copyOptions(ResponseOptionsParams responseOptions,
                               org.eclipse.californium.core.coap.OptionSet optionSet,
                               org.mule.runtime.api.transformation.TransformationService transformationService)
                        throws InternalInvalidOptionValueException

Copy options from ResponseOptionsParams to OptionSet.

Parameters:

responseOptions - The options to copy.

optionSet - The set to copy to.

transformationService - Mule transformation service.

Throws:

InternalInvalidOptionValueException - When given option value is invalid.

copyEntityTagValue

public static void copyEntityTagValue(org.mule.runtime.api.metadata.TypedValue<Object> entityTagValue,
                                      org.eclipse.californium.core.coap.OptionSet optionSet,
                                      org.mule.runtime.api.transformation.TransformationService transformationService)
                               throws InternalInvalidOptionValueException

Copy EntityTagValue to OptionSet.

Parameters:

entityTagValue - The entityTagValue to copy.

optionSet - The set to copy to.

transformationService - Mule transformation service.

Throws:

InternalInvalidOptionValueException - When given option value is invalid.

copyMaxAge

public static void copyMaxAge(Long maxAge,
                              org.eclipse.californium.core.coap.OptionSet optionSet)
                       throws InternalInvalidOptionValueException

Copy MaxAge to OptionSet.

Parameters:

maxAge - The options to copy.

optionSet - The set to copy to.

Throws:

InternalInvalidOptionValueException - When given option value is invalid.

copyLocationPath

public static void copyLocationPath(String locationPath,
                                    org.eclipse.californium.core.coap.OptionSet optionSet)
                             throws InternalInvalidOptionValueException

Copy LocationPath to OptionSet.

Parameters:

locationPath - The options to copy.

optionSet - The set to copy to.

Throws:

InternalInvalidOptionValueException - When given option value is invalid.

copyLocationQuery

public static void copyLocationQuery(List<QueryParam> locationQuery,
                                     org.eclipse.californium.core.coap.OptionSet optionSet)
                              throws InternalInvalidOptionValueException

Copy LocationQuery to OptionSet.

Parameters:

locationQuery - The options to copy.

optionSet - The set to copy to.

Throws:

InternalInvalidOptionValueException - When given option value is invalid.

copyResponseSize

public static void copyResponseSize(Integer responseSize,
                                    org.eclipse.californium.core.coap.OptionSet optionSet)
                             throws InternalInvalidOptionValueException

Copy ResponseSize to OptionSet.

Parameters:

responseSize - The options to copy.

optionSet - The set to copy to.

Throws:

InternalInvalidOptionValueException - When given option value is invalid.

copyAcceptableRequestSize

public static void copyAcceptableRequestSize(Integer acceptableRequestSize,
                                             org.eclipse.californium.core.coap.OptionSet optionSet)
                                      throws InternalInvalidOptionValueException

Copy AcceptableRequestSize to OptionSet.

Parameters:

acceptableRequestSize - The options to copy.

optionSet - The set to copy to.

Throws:

InternalInvalidOptionValueException - When given option value is invalid.

toCfOptionDefinition

public static org.eclipse.californium.core.coap.option.OptionDefinition toCfOptionDefinition(OtherOptionConfig otherOptionConfig)

Convert other option configuration to Cf option definition.

Parameters:

otherOptionConfig - The option config to create definition from.

Returns:

The created definition.

isEqual

public static boolean isEqual(org.eclipse.californium.core.coap.option.OptionDefinition left,
                              org.eclipse.californium.core.coap.option.OptionDefinition right)

Establish equality of two option definitions based on their properties.

Parameters:

left - The first option definition.

right - The second option definition.

Returns:

true when the definition are equal otherwise false

toOptionFormat

public static OptionFormat toOptionFormat(org.eclipse.californium.core.coap.OptionNumberRegistry.OptionFormat format)

Convert Cf format to option format.

Parameters:

format - The Cf option format.

Returns:

The option format.

toBytes

public static byte[] toBytes(Object toConvert,
                             org.mule.runtime.api.transformation.TransformationService transformationService)

Convert an object to byte array.

Parameters:

toConvert - The object to convert.

Returns:

Converted object as bytes, or null when the input was null.

Throws:

InternalInvalidByteArrayValueException - When object cannot be converted to bytes.

queryString

public static String queryString(List<? extends AbstractQueryParam> defaultQueryParams,
                                 List<? extends AbstractQueryParam> queryParams)

Construct string representation of query parameters, merged with default parameters. The string conforms to URI format,

Parameters:

defaultQueryParams - The default parameters.

queryParams - The query parameters.

Returns:

The string representation for usage in an URI.

uriString

public static String uriString(List<String> path,
                               List<? extends AbstractQueryParam> query)

Create UriString from path and query.

Parameters:

path - The optional list of path segements.

query - The optional list of query parameters.

Returns:

The uri string.

getList

public static Optional<List<DefaultEntityTag>> getList(List<byte[]> bytesList)
                                                throws OptionValueException

Convenience method to create a list of Entity-tags form a list of byte arrays. To support ifMatch options no list is returned when one of the etags is empty, in stead of throwing an exception.

Parameters:

bytesList - The List of Byte arrays to make a list of Entity-tags from.

Returns:

The optional list of Entity-tags. Empty when an empty etag occurs.

Throws:

OptionValueException - when the Entity-tag could not be created from bytes

isIn

public static boolean isIn(DefaultEntityTag etag,
                           Collection<DefaultEntityTag> etags)

Check a collection of Entity-tags whether it contains the Entity-tag. When given collection is null the Entity-tag is considered not found.

Parameters:

etag - The Entity-tag to check.

etags - The collection of Entity-tags to find the Entity-tag in.

Returns:

True when the Entity-tag is found in the collection, otherwise false.