org.apache.nifi.cluster.manager

Class NodeResponse

java.lang.Object

org.apache.nifi.cluster.manager.NodeResponse

public class NodeResponse
extends Object

Encapsulates a node's response in regards to receiving a external API request. Both the ClientResponse and (server) Response may be obtained from this instance. The ClientResponse is stored as it is received from the node. This includes the entity input stream. The Response is constructed on demand when mapping a ClientResponse to the Response. The ClientResponse to Response mapping includes copying the ClientResponse's input stream to the Response. Therefore, the getResponse() method should not be called more than once. Furthermore, the method should not be called if the caller has already read the ClientResponse's input stream. If a ClientResponse was unable to be created, then a NodeResponse will store the Throwable, which may be obtained by calling getThrowable(). This class overrides hashCode and equals and considers two instances to be equal if they have the equal NodeIdentifiers.

Field Summary

Fields

Modifier and Type	Field and Description
private com.sun.jersey.api.client.ClientResponse	clientResponse
private boolean	hasCreatedResponse
private String	httpMethod
private static org.slf4j.Logger	logger
private NodeIdentifier	nodeId
private long	requestDurationNanos
private String	requestId
private URI	requestUri
private Throwable	throwable
private Entity	updatedEntity

Constructor Summary

Constructors

Constructor and Description
NodeResponse(NodeIdentifier nodeId, String httpMethod, URI requestUri, com.sun.jersey.api.client.ClientResponse clientResponse, long requestDurationNanos, String requestId)
NodeResponse(NodeIdentifier nodeId, String httpMethod, URI requestUri, Throwable throwable)
NodeResponse(NodeResponse example, Entity updatedEntity)

Method Summary

Modifier and Type	Method and Description
private javax.ws.rs.core.Response	createResponse()
boolean	equals(Object obj)
com.sun.jersey.api.client.ClientResponse	getClientResponse() Returns null if hasThrowable() is true; otherwise the client's response is returned.
String	getHttpMethod()
NodeIdentifier	getNodeId()
long	getRequestDuration(TimeUnit timeUnit)
String	getRequestId()
URI	getRequestUri()
javax.ws.rs.core.Response	getResponse() Creates a Response by mapping the ClientResponse values to it.
int	getStatus()
Throwable	getThrowable() Returns the throwable or null if no throwable exists.
Entity	getUpdatedEntity() If this node response has been merged returns the updated entity, otherwise null.
int	hashCode()
boolean	hasThrowable() Returns true if a throwable was thrown and a response was not able to be created; false otherwise.
boolean	is2xx()
boolean	is5xx()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final org.slf4j.Logger logger

httpMethod

private final String httpMethod

requestUri

private final URI requestUri

clientResponse

private final com.sun.jersey.api.client.ClientResponse clientResponse

nodeId

private final NodeIdentifier nodeId

throwable

private final Throwable throwable

hasCreatedResponse

private boolean hasCreatedResponse

updatedEntity

private final Entity updatedEntity

requestDurationNanos

private final long requestDurationNanos

requestId

private final String requestId

Constructor Detail

NodeResponse

public NodeResponse(NodeIdentifier nodeId,
                    String httpMethod,
                    URI requestUri,
                    com.sun.jersey.api.client.ClientResponse clientResponse,
                    long requestDurationNanos,
                    String requestId)

NodeResponse

public NodeResponse(NodeIdentifier nodeId,
                    String httpMethod,
                    URI requestUri,
                    Throwable throwable)

NodeResponse

public NodeResponse(NodeResponse example,
                    Entity updatedEntity)

Method Detail

getNodeId

public NodeIdentifier getNodeId()

getHttpMethod

public String getHttpMethod()

getRequestUri

public URI getRequestUri()

getStatus

public int getStatus()

Returns:

the HTTP response status code

is2xx

public boolean is2xx()

Returns:

true if the response status is 2xx, false otherwise.

is5xx

public boolean is5xx()

Returns:

true if the response status is 5xx, false otherwise.

getClientResponse

public com.sun.jersey.api.client.ClientResponse getClientResponse()

Returns null if hasThrowable() is true; otherwise the client's response is returned. The ClientResponse's input stream can only be read once.

Returns:

the client's response

getUpdatedEntity

public Entity getUpdatedEntity()

If this node response has been merged returns the updated entity, otherwise null. Also returns null if hasThrowable() is true. The intent of this method is to support getting the response entity when it was already consumed during the merge operation. In this case the client response rom getClientResponse() will not support a getEntity(...) or getEntityInputStream() call.

Returns:

If this node response has been merged returns the updated entity, otherwise null. Also returns null if hasThrowable() is true

getResponse

public javax.ws.rs.core.Response getResponse()

Creates a Response by mapping the ClientResponse values to it. Since the ClientResponse's input stream can only be read once, this method should only be called once. Furthermore, the caller should not have already read the ClientResponse's input stream.

Returns:

the response

getThrowable

public Throwable getThrowable()

Returns the throwable or null if no throwable exists.

Returns:

the throwable or null if no throwable exists

hasThrowable

public boolean hasThrowable()

Returns true if a throwable was thrown and a response was not able to be created; false otherwise.

Returns:

true if a throwable was thrown and a response was not able to be created; false otherwise

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getRequestDuration

public long getRequestDuration(TimeUnit timeUnit)

getRequestId

public String getRequestId()

createResponse

private javax.ws.rs.core.Response createResponse()

toString

public String toString()

Overrides:

toString in class Object