Class OutputStreamHandle

All Implemented Interfaces:

ContentDescriptor, AbstractWriteHandle, BinaryWriteHandle, CtsQueryWriteHandle, DocumentMetadataWriteHandle, DocumentPatchHandle, GenericWriteHandle, JSONWriteHandle, QueryOptionsWriteHandle, RuleWriteHandle, StructureWriteHandle, TextWriteHandle, TriplesWriteHandle, XMLWriteHandle

• Field Summary

  Fields inherited from interface com.marklogic.client.document.ContentDescriptor

  UNKNOWN_LENGTH

• Constructor Summary

  Constructors
  Constructor

  Description

  OutputStreamHandle()

  Zero-argument constructor.

  OutputStreamHandle(OutputStreamSender sender)

  Initializes the handle with an outputstream sender providing the callback that writes content to the database via an output stream.

• Method Summary

  All MethodsInstance MethodsConcrete Methods

  Modifier and Type

  Method

  Description

  OutputStreamSender

  get()

  Returns the output stream sender that writes the content.

  boolean

  isResendable()

  Returns whether the content can be resent to the output stream if the request must be retried.

  protected OutputStreamSender

  sendContent()

   

  void

  set(OutputStreamSender sender)

  Assigns an output stream sender providing the callback that writes content to the database via an output stream.

  void

  setResendable(boolean resendable)

  Specifies whether the content can be resent to the output stream if the request must be retried.

  OutputStreamHandle

  with(OutputStreamSender sender)

  Assigns an output stream sender providing the callback that writes content to the database and returns the handle as a fluent convenience.

  OutputStreamHandle

  withFormat(Format format)

  Specifies the format of the content and returns the handle as a fluent convenience.

  OutputStreamHandle

  withMimetype(String mimetype)

  Specifies the mime type of the content and returns the handle as a fluent convenience.

  OutputStreamHandle

  withResendable(boolean resendable)

  Specifies whether the content can be resent to the output stream and returns the handle as a fluent convenience.

  Methods inherited from class com.marklogic.client.io.BaseHandle

  getByteLength, getFormat, getMimetype, getServerTimestamp, setByteLength, setFormat, setMimetype, setServerTimestamp

  Methods inherited from class com.marklogic.client.impl.HandleImplementation

  getPointInTimeQueryTimestamp, receiveAs, receiveContent, setPointInTimeQueryTimestamp, setResponseServerTimestamp

  Methods inherited from class java.lang.Object

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

• Constructor Details

  • OutputStreamHandle

    public OutputStreamHandle()
    Zero-argument constructor.

  • OutputStreamHandle

    public OutputStreamHandle(OutputStreamSender sender)
    Initializes the handle with an outputstream sender providing the callback that writes content to the database via an output stream.

    Parameters:

    sender - the processor that sends content to the database

• Method Details

  • withFormat

    public OutputStreamHandle withFormat(Format format)
    Specifies the format of the content and returns the handle as a fluent convenience.

    Parameters:

    format - the format of the content

    Returns:

    this handle

  • withMimetype

    public OutputStreamHandle withMimetype(String mimetype)
    Specifies the mime type of the content and returns the handle as a fluent convenience.

    Parameters:

    mimetype - the mime type of the content

    Returns:

    this handle

  • isResendable

    public boolean isResendable()
    Returns whether the content can be resent to the output stream if the request must be retried. The default is false.

    Overrides:

    isResendable in class com.marklogic.client.impl.HandleImplementation<OperationNotSupported,OutputStreamSender>

  • setResendable

    public void setResendable(boolean resendable)
    Specifies whether the content can be resent to the output stream if the request must be retried.

    Overrides:

    setResendable in class com.marklogic.client.impl.HandleImplementation<OperationNotSupported,OutputStreamSender>

  • withResendable

    public OutputStreamHandle withResendable(boolean resendable)
    Specifies whether the content can be resent to the output stream and returns the handle as a fluent convenience.

    Parameters:

    resendable - true if the content can be sent again

    Returns:

    this handle

  • get

    public OutputStreamSender get()
    Returns the output stream sender that writes the content.

    Returns:

    the output stream sender

  • set

    public void set(OutputStreamSender sender)
    Assigns an output stream sender providing the callback that writes content to the database via an output stream.

    Parameters:

    sender - the output stream sender

  • with

    public OutputStreamHandle with(OutputStreamSender sender)
    Assigns an output stream sender providing the callback that writes content to the database and returns the handle as a fluent convenience.

    Parameters:

    sender - the output stream sender

    Returns:

    this handle

  • sendContent

    protected OutputStreamSender sendContent()

    Overrides:

    sendContent in class com.marklogic.client.impl.HandleImplementation<OperationNotSupported,OutputStreamSender>

Copyright (c) 2010-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.