org.apache.nifi.processors.standard.relp.response

Class RELPResponse

java.lang.Object

org.apache.nifi.processors.standard.relp.response.RELPResponse

public class RELPResponse
extends Object

The data portion of a RELPFrame for a response: RSP-CODE [SP HUMANMSG] LF [CMDDATA]

Field Summary

Fields

Modifier and Type	Field and Description
private int	code
private String	data
static int	ERROR
private String	message
static int	OK
static String	RSP_CMD
private long	txnr

Constructor Summary

Constructors

Constructor and Description
RELPResponse(long txnr, int code)
RELPResponse(long txnr, int code, String message, String data)

Method Summary

Modifier and Type	Method and Description
static RELPResponse	error(long txnr) Utility method to create a default "ERROR" response.
static RELPResponse	ok(long txnr) Utility method to create a default "OK" response.
static RELPResponse	open(long txnr, Map<String,String> offers) Utility method to create a response to an open request.
static Map<String,String>	parseOffers(byte[] data, Charset charset) Parses the provided data into a Map of offers.
RELPFrame	toFrame(Charset charset) Creates a RELPFrame where the data portion will contain this response.

Methods inherited from class java.lang.Object

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

Field Detail

OK

public static final int OK

See Also:

Constant Field Values

ERROR

public static final int ERROR

See Also:

Constant Field Values

RSP_CMD

public static final String RSP_CMD

See Also:

Constant Field Values

txnr

private final long txnr

code

private final int code

message

private final String message

data

private final String data

Constructor Detail

RELPResponse

public RELPResponse(long txnr,
                    int code)

RELPResponse

public RELPResponse(long txnr,
                    int code,
                    String message,
                    String data)

Method Detail

toFrame

public RELPFrame toFrame(Charset charset)

Creates a RELPFrame where the data portion will contain this response.

Parameters:

charset - the character set to encode the response

Returns:

a RELPFrame for for this response

open

public static RELPResponse open(long txnr,
                                Map<String,String> offers)

Utility method to create a response to an open request.

Parameters:

txnr - the transaction number of the open request

offers - the accepted offers

Returns:

the RELPResponse for the given open request

ok

public static RELPResponse ok(long txnr)

Utility method to create a default "OK" response.

Parameters:

txnr - the transaction number being responded to

Returns:

a RELPResponse with a 200 code and a message of "OK"

error

public static RELPResponse error(long txnr)

Utility method to create a default "ERROR" response.

Parameters:

txnr - the transaction number being responded to

Returns:

a RELPResponse with a 500 code and a message of "ERROR"

parseOffers

public static Map<String,String> parseOffers(byte[] data,
                                             Charset charset)

Parses the provided data into a Map of offers.

Parameters:

data - the data portion of a RELPFrame for an "open" command

charset - the charset to decode the data

Returns:

a Map of offers, or an empty Map if no data is provided