Package io.deephaven.server.session
Class ExportTicketResolver
java.lang.Object
io.deephaven.server.session.PathResolverPrefixedBase
io.deephaven.server.session.TicketResolverBase
io.deephaven.server.session.ExportTicketResolver
- All Implemented Interfaces:
PathResolver
,TicketResolver
Note that the export ticket resolver does not run the export results through the auth table transformation. This is
because any source tables will be transformed as they are initially exported to the session.
-
Nested Class Summary
Nested classes/interfaces inherited from interface io.deephaven.server.session.TicketResolver
TicketResolver.Authorization
-
Field Summary
Fields inherited from class io.deephaven.server.session.TicketResolverBase
authorization
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionSessionState.ExportObject<org.apache.arrow.flight.impl.Flight.FlightInfo>
flightInfoFor
(@Nullable SessionState session, org.apache.arrow.flight.impl.Flight.FlightDescriptor descriptor, String logId) Retrieve a FlightInfo for a given FlightDescriptor.void
forAllFlightInfo
(@Nullable SessionState session, Consumer<org.apache.arrow.flight.impl.Flight.FlightInfo> visitor) This invokes the provided visitor for each valid flight descriptor this ticket resolver exposes via flight.getLogNameFor
(ByteBuffer ticket, String logId) Create a human readable string to identify this ticket.<T> SessionState.ExportBuilder<T>
publish
(SessionState session, ByteBuffer ticket, String logId, @Nullable Runnable onPublish) Publish a new result as a flight ticket to an export object future.<T> SessionState.ExportBuilder<T>
publish
(SessionState session, org.apache.arrow.flight.impl.Flight.FlightDescriptor descriptor, String logId, @Nullable Runnable onPublish) Publish a new result as a flight descriptor to an export object future.<T> SessionState.ExportObject<T>
resolve
(@Nullable SessionState session, ByteBuffer ticket, String logId) Resolve a flight ticket to an export object future.<T> SessionState.ExportObject<T>
resolve
(@Nullable SessionState session, org.apache.arrow.flight.impl.Flight.FlightDescriptor descriptor, String logId) Resolve a flight descriptor to an export object future.Methods inherited from class io.deephaven.server.session.TicketResolverBase
ticketRoute
Methods inherited from class io.deephaven.server.session.PathResolverPrefixedBase
flightDescriptorRoute, handlesPath
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface io.deephaven.server.session.TicketResolver
publish
-
Constructor Details
-
ExportTicketResolver
-
-
Method Details
-
getLogNameFor
Description copied from interface:TicketResolver
Create a human readable string to identify this ticket.- Parameters:
ticket
- the ticket to parselogId
- an end-user friendly identification of the ticket should an error occur- Returns:
- a string that is good for log/error messages
-
flightInfoFor
public SessionState.ExportObject<org.apache.arrow.flight.impl.Flight.FlightInfo> flightInfoFor(@Nullable @Nullable SessionState session, org.apache.arrow.flight.impl.Flight.FlightDescriptor descriptor, String logId) Description copied from interface:TicketResolver
Retrieve a FlightInfo for a given FlightDescriptor.descriptor
- the flight descriptor to retrieve a ticket forlogId
- an end-user friendly identification of the ticket should an error occur- Returns:
- a FlightInfo describing this flight
-
forAllFlightInfo
public void forAllFlightInfo(@Nullable @Nullable SessionState session, Consumer<org.apache.arrow.flight.impl.Flight.FlightInfo> visitor) Description copied from interface:TicketResolver
This invokes the provided visitor for each valid flight descriptor this ticket resolver exposes via flight.- Parameters:
session
- optional session that the resolver can use to filter which flights a visitor seesvisitor
- the callback to invoke per descriptor path
-
resolve
public <T> SessionState.ExportObject<T> resolve(@Nullable @Nullable SessionState session, ByteBuffer ticket, String logId) Description copied from interface:TicketResolver
Resolve a flight ticket to an export object future.- Type Parameters:
T
- the expected return type of the ticket; this is not validated- Parameters:
session
- the user session contextticket
- (as ByteByffer) the ticket to resolvelogId
- an end-user friendly identification of the ticket should an error occur- Returns:
- an export object; see
SessionState
for lifecycle propagation details
-
resolve
public <T> SessionState.ExportObject<T> resolve(@Nullable @Nullable SessionState session, org.apache.arrow.flight.impl.Flight.FlightDescriptor descriptor, String logId) Description copied from interface:TicketResolver
Resolve a flight descriptor to an export object future.- Type Parameters:
T
- the expected return type of the ticket; this is not validated- Parameters:
session
- the user session contextdescriptor
- the descriptor to resolvelogId
- an end-user friendly identification of the ticket should an error occur- Returns:
- an export object; see
SessionState
for lifecycle propagation details
-
publish
public <T> SessionState.ExportBuilder<T> publish(SessionState session, ByteBuffer ticket, String logId, @Nullable @Nullable Runnable onPublish) Description copied from interface:TicketResolver
Publish a new result as a flight ticket to an export object future.The user must call
SessionState.ExportBuilder.submit(java.util.concurrent.Callable<T>)
to publish the result value.- Type Parameters:
T
- the type of the result the export will publish- Parameters:
session
- the user session contextticket
- (as ByteByffer) the ticket to publish tologId
- an end-user friendly identification of the ticket should an error occuronPublish
- an optional callback to invoke when the result is published- Returns:
- an export object; see
SessionState
for lifecycle propagation details
-
publish
public <T> SessionState.ExportBuilder<T> publish(SessionState session, org.apache.arrow.flight.impl.Flight.FlightDescriptor descriptor, String logId, @Nullable @Nullable Runnable onPublish) Description copied from interface:TicketResolver
Publish a new result as a flight descriptor to an export object future.The user must call
SessionState.ExportBuilder.submit(java.util.concurrent.Callable<T>)
to publish the result value.- Type Parameters:
T
- the type of the result the export will publish- Parameters:
session
- the user session contextdescriptor
- (as Flight.Descriptor) the descriptor to publish tologId
- an end-user friendly identification of the ticket should an error occuronPublish
- an optional callback to invoke when the result is published- Returns:
- an export object; see
SessionState
for lifecycle propagation details
-