Package org.apache.hadoop.ipc

Class RefreshResponse

java.lang.Object

org.apache.hadoop.ipc.RefreshResponse

@Unstable
public class RefreshResponse
extends java.lang.Object

Return a response in the handler method for the user to see. Useful since you may want to display status to a user even though an error has not occurred.

Constructor Summary

Constructors

Constructor	Description
RefreshResponse(int returnCode, java.lang.String message)

Method Summary

Modifier and Type	Method	Description
java.lang.String	getMessage()
int	getReturnCode()
java.lang.String	getSenderName()
void	setMessage(java.lang.String m)
void	setReturnCode(int rc)
void	setSenderName(java.lang.String name)	Optionally set the sender of this RefreshResponse.
static RefreshResponse	successResponse()	Convenience method to create a response for successful refreshes.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

RefreshResponse

public RefreshResponse(int returnCode,
                       java.lang.String message)

Method Detail

successResponse

public static RefreshResponse successResponse()

Convenience method to create a response for successful refreshes.

Returns:

void response

setSenderName

public void setSenderName(java.lang.String name)

Optionally set the sender of this RefreshResponse. This helps clarify things when multiple handlers respond.

Parameters:

name - The name of the sender

getSenderName

public java.lang.String getSenderName()

getReturnCode

public int getReturnCode()

setReturnCode

public void setReturnCode(int rc)

setMessage

public void setMessage(java.lang.String m)

getMessage

public java.lang.String getMessage()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object