io.nexusrpc.handler

Class OperationContext

java.lang.Object

io.nexusrpc.handler.OperationContext

public class OperationContext
extends java.lang.Object

Context for use in operation handling.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OperationContext.Builder Builder for operation context.

Method Summary

Modifier and Type	Method and Description
OperationContext	addLinks(Link... links) Associates links with the current operation to be propagated back to the caller.
OperationContext	addMethodCancellationListener(OperationMethodCancellationListener listener) Add a listener for method cancellation.
boolean	equals(java.lang.Object o)
java.util.Map<java.lang.String,java.lang.String>	getHeaders() Headers for the call.
java.util.List<Link>	getLinks() Get a read only list of links attached to this context.
@Nullable java.lang.String	getMethodCancellationReason() Reason the method was cancelled or null if not canceled.
java.lang.String	getOperation() Operation name for the call.
java.lang.String	getService() Service name for the call.
int	hashCode()
boolean	isMethodCancelled() True if the method has been cancelled, false if not.
static OperationContext.Builder	newBuilder() Create a builder.
static OperationContext.Builder	newBuilder(OperationContext context) Create a builder from an existing context.
OperationContext	removeMethodCancellationListener(OperationMethodCancellationListener listener) Remove a listener, if present, for method cancellation using hash code.
OperationContext	setLinks(Link... links) Associates links with the current operation to be propagated back to the caller.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

newBuilder

public static OperationContext.Builder newBuilder()

Create a builder.

newBuilder

public static OperationContext.Builder newBuilder(OperationContext context)

Create a builder from an existing context.

getService

public java.lang.String getService()

Service name for the call.

getOperation

public java.lang.String getOperation()

Operation name for the call.

getHeaders

public java.util.Map<java.lang.String,java.lang.String> getHeaders()

Headers for the call. The returned map operates without regard to case.

getLinks

public java.util.List<Link> getLinks()

Get a read only list of links attached to this context.

isMethodCancelled

public boolean isMethodCancelled()

True if the method has been cancelled, false if not. Note, this is method cancellation, unrelated to operation cancellation.

getMethodCancellationReason

public @Nullable java.lang.String getMethodCancellationReason()

Reason the method was cancelled or null if not canceled. Note, this is method cancellation, unrelated to operation cancellation.

addMethodCancellationListener

public OperationContext addMethodCancellationListener(OperationMethodCancellationListener listener)

Add a listener for method cancellation. This will be invoked immediately before this function returns if the method is already cancelled. The listener must not block. This is not reentrant and therefore must not be called in another cancellation listener.

Returns:

this

addLinks

public OperationContext addLinks(Link... links)

Associates links with the current operation to be propagated back to the caller. Links will only be attached on successful responses.

Returns:

this

setLinks

public OperationContext setLinks(Link... links)

Associates links with the current operation to be propagated back to the caller. It is recommended to use addLinks(Link...) to avoid accidental override. Links will only be attached on successful responses.

Returns:

this

removeMethodCancellationListener

public OperationContext removeMethodCancellationListener(OperationMethodCancellationListener listener)

Remove a listener, if present, for method cancellation using hash code. This is not reentrant and therefore must not be called in another cancellation listener.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object