Package org.apache.hadoop.ipc

Class Server.Call

java.lang.Object

org.apache.hadoop.ipc.Server.Call

All Implemented Interfaces:

java.security.PrivilegedExceptionAction<java.lang.Void>, Schedulable

Direct Known Subclasses:

ExternalCall

Enclosing class:

Server

public static class Server.Call
extends java.lang.Object
implements Schedulable, java.security.PrivilegedExceptionAction<java.lang.Void>

A generic call queued for handling.

Constructor Summary

Constructors

Constructor	Description
Call(int id, int retryCount, java.lang.Void ignore1, java.lang.Void ignore2, RPC.RpcKind kind, byte[] clientId)

Method Summary

Modifier and Type	Method	Description
void	abortResponse(java.lang.Throwable t)
void	deferResponse()
CallerContext	getCallerContext()	This is overridden only in Server.Call.
long	getClientStateId()
org.apache.hadoop.thirdparty.protobuf.ByteString	getFederatedNamespaceState()
java.lang.String	getHostAddress()
java.net.InetAddress	getHostInetAddress()
int	getPriorityLevel()
ProcessingDetails	getProcessingDetails()
java.lang.String	getProtocol()
int	getRemotePort()
UserGroupInformation	getRemoteUser()
long	getTimestampNanos()
UserGroupInformation	getUserGroupInformation()
boolean	isCallCoordinated()
boolean	isResponseDeferred()
void	markCallCoordinated(boolean flag)
void	postponeResponse()	Allow a IPC response to be postponed instead of sent immediately after the handler returns from the proxy method.
java.lang.Void	run()
void	sendResponse()
void	setClientStateId(long stateId)
void	setDeferredError(java.lang.Throwable t)
void	setDeferredResponse(Writable response)
void	setFederatedNamespaceState(org.apache.hadoop.thirdparty.protobuf.ByteString federatedNamespaceState)
void	setPriorityLevel(int priorityLevel)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Call

@VisibleForTesting
public Call(int id,
            int retryCount,
            java.lang.Void ignore1,
            java.lang.Void ignore2,
            RPC.RpcKind kind,
            byte[] clientId)

Method Detail

getProcessingDetails

public ProcessingDetails getProcessingDetails()

setFederatedNamespaceState

public void setFederatedNamespaceState(org.apache.hadoop.thirdparty.protobuf.ByteString federatedNamespaceState)

getFederatedNamespaceState

public org.apache.hadoop.thirdparty.protobuf.ByteString getFederatedNamespaceState()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

run

public java.lang.Void run()
                   throws java.lang.Exception

Specified by:

run in interface java.security.PrivilegedExceptionAction<java.lang.Void>

Throws:

java.lang.Exception

getRemoteUser

public UserGroupInformation getRemoteUser()

getHostInetAddress

public java.net.InetAddress getHostInetAddress()

getRemotePort

public int getRemotePort()

getHostAddress

public java.lang.String getHostAddress()

getProtocol

public java.lang.String getProtocol()

postponeResponse

@Unstable
@LimitedPrivate("HDFS")
public final void postponeResponse()

Allow a IPC response to be postponed instead of sent immediately after the handler returns from the proxy method. The intended use case is freeing up the handler thread when the response is known, but an expensive pre-condition must be satisfied before it's sent to the client.

sendResponse

@Unstable
@LimitedPrivate("HDFS")
public final void sendResponse()
                        throws java.io.IOException

Throws:

java.io.IOException

abortResponse

@Unstable
@LimitedPrivate("HDFS")
public final void abortResponse(java.lang.Throwable t)
                         throws java.io.IOException

Throws:

java.io.IOException

getUserGroupInformation

public UserGroupInformation getUserGroupInformation()

Specified by:

getUserGroupInformation in interface Schedulable

getCallerContext

public CallerContext getCallerContext()

Description copied from interface: Schedulable

This is overridden only in Server.Call. The CallerContext field will be used to carry information about the user in cases where UGI proves insufficient. Any other classes that might try to use this method, will get an UnsupportedOperationException.

Specified by:

getCallerContext in interface Schedulable

Returns:

an instance of CallerContext if method is overridden else get an UnsupportedOperationException

getPriorityLevel

public int getPriorityLevel()

Specified by:

getPriorityLevel in interface Schedulable

setPriorityLevel

public void setPriorityLevel(int priorityLevel)

getClientStateId

public long getClientStateId()

setClientStateId

public void setClientStateId(long stateId)

markCallCoordinated

public void markCallCoordinated(boolean flag)

isCallCoordinated

public boolean isCallCoordinated()

deferResponse

@Unstable
public void deferResponse()

isResponseDeferred

@Unstable
public boolean isResponseDeferred()

setDeferredResponse

public void setDeferredResponse(Writable response)

setDeferredError

public void setDeferredError(java.lang.Throwable t)

getTimestampNanos

public long getTimestampNanos()