Package org.eclipse.hono.util

Class CredentialsResult<T>

java.lang.Object

org.eclipse.hono.util.RequestResponseResult<T>

org.eclipse.hono.util.CredentialsResult<T>

Type Parameters:

T - denotes the concrete type of the payload that is conveyed in the result

public final class CredentialsResult<T>
extends RequestResponseResult<T>

A container for the result returned by Hono's credentials API.

Method Summary

Modifier and Type	Method	Description
static <T> CredentialsResult<T>	from(int status)	Creates a new result for a status code.
static <T> CredentialsResult<T>	from(int status, T payload)	Creates a new result for a status code and payload.
static <T> CredentialsResult<T>	from(int status, T payload, CacheDirective cacheDirective)	Creates a new result for a status code and payload.
static <T> CredentialsResult<T>	from(int status, T payload, CacheDirective cacheDirective, org.apache.qpid.proton.amqp.messaging.ApplicationProperties applicationProperties)	Creates a new result for a status code and payload.

Methods inherited from class org.eclipse.hono.util.RequestResponseResult

getApplicationProperties, getApplicationProperty, getCacheDirective, getPayload, getStatus, isError, isNotFound, isOk

Methods inherited from class java.lang.Object

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

Method Detail

from

public static <T> CredentialsResult<T> from(int status)

Creates a new result for a status code.

Type Parameters:

T - The type of the payload that is conveyed in the result.

Parameters:

status - The status code indicating the outcome of the request.

Returns:

The result.

from

public static <T> CredentialsResult<T> from(int status,
                                            T payload)

Creates a new result for a status code and payload.

This method simply invokes from(int, Object, CacheDirective) with CacheDirective.noCacheDirective().

Type Parameters:

T - The type of the payload that is conveyed in the result.

Parameters:

status - The status code indicating the outcome of the request.

payload - The payload to convey to the sender of the request.

Returns:

The result.

from

public static <T> CredentialsResult<T> from(int status,
                                            T payload,
                                            CacheDirective cacheDirective)

Creates a new result for a status code and payload.

Type Parameters:

T - The type of the payload that is conveyed in the result.

Parameters:

status - The status code indicating the outcome of the request.

payload - The payload to convey to the sender of the request.

cacheDirective - Restrictions regarding the caching of the payload by the receiver of the result (may be null).

Returns:

The result.

from

public static <T> CredentialsResult<T> from(int status,
                                            T payload,
                                            CacheDirective cacheDirective,
                                            org.apache.qpid.proton.amqp.messaging.ApplicationProperties applicationProperties)

Creates a new result for a status code and payload.

Type Parameters:

T - The type of the payload that is conveyed in the result.

Parameters:

status - The status code indicating the outcome of the request.

payload - The payload to convey to the sender of the request.

cacheDirective - Restrictions regarding the caching of the payload by the receiver of the result (may be null).

applicationProperties - Arbitrary properties conveyed in the response message's application-properties.

Returns:

The result.