Package com.oracle.bmc.streaming

Class StreamAsyncClient

  • All Implemented Interfaces:
    StreamAsync, AutoCloseable
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20180418")
public class StreamAsyncClient
extends BaseAsyncClient
implements StreamAsync
    Async client implementation for Stream service.
    There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is an InputStream, like getObject Api in object storage service, developers need to process the stream in AsyncHandler, and not anywhere else, because the stream will be closed right after the AsyncHandler is invoked.
    2. Use Java Future: using Java Future, developers need to close the stream after they are done with the Java Future.
    Accessing the result should be done in a mutually exclusive manner, either through the Future or the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine whether or not the request was completed via Future.isDone/isCancelled.
    Please refer to https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java

    • Field Detail

      • SERVICE

        public static final Service SERVICE
        Service instance for Stream.

      • clientCommonLibraryVersion

        public final String clientCommonLibraryVersion
        Compatible SDK version, provided by the codegen.

      • minimumClientCommonLibraryVersionFromClient

        public final Optional<String> minimumClientCommonLibraryVersionFromClient
        Minimum compatible SDK version, maybe provided by the codegen.

    • Constructor Detail

      • StreamAsyncClient

        @Deprecated
public StreamAsyncClient​(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
        Deprecated.
        Use the builder instead.
        Create a new client instance.
        Parameters:
        authenticationDetailsProvider - The authentication details (see Builder#build)

      • StreamAsyncClient

        @Deprecated
public StreamAsyncClient​(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                         ClientConfiguration configuration)
        Deprecated.
        Use the builder instead.
        Create a new client instance.
        Parameters:
        authenticationDetailsProvider - The authentication details (see Builder#build)
        configuration - Builder#configuration

      • StreamAsyncClient

        @Deprecated
public StreamAsyncClient​(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                         ClientConfiguration configuration,
                         ClientConfigurator clientConfigurator)
        Deprecated.
        Use the builder instead.
        Create a new client instance.
        Parameters:
        authenticationDetailsProvider - The authentication details (see Builder#build)
        configuration - Builder#configuration
        clientConfigurator - Builder#clientConfigurator

      • StreamAsyncClient

        @Deprecated
public StreamAsyncClient​(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                         ClientConfiguration configuration,
                         ClientConfigurator clientConfigurator,
                         RequestSignerFactory defaultRequestSignerFactory)
        Deprecated.
        Use the builder instead.
        Create a new client instance.
        Parameters:
        authenticationDetailsProvider - The authentication details (see Builder#build)
        configuration - Builder#configuration
        clientConfigurator - Builder#clientConfigurator
        defaultRequestSignerFactory - Builder#requestSignerFactory

      • StreamAsyncClient

        @Deprecated
public StreamAsyncClient​(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                         ClientConfiguration configuration,
                         ClientConfigurator clientConfigurator,
                         RequestSignerFactory defaultRequestSignerFactory,
                         List<ClientConfigurator> additionalClientConfigurators)
        Deprecated.
        Use the builder instead.
        Create a new client instance.
        Parameters:
        authenticationDetailsProvider - The authentication details (see Builder#build)
        configuration - Builder#configuration
        clientConfigurator - Builder#clientConfigurator
        defaultRequestSignerFactory - Builder#requestSignerFactory
        additionalClientConfigurators - Builder#additionalClientConfigurators

      • StreamAsyncClient

        @Deprecated
public StreamAsyncClient​(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                         ClientConfiguration configuration,
                         ClientConfigurator clientConfigurator,
                         RequestSignerFactory defaultRequestSignerFactory,
                         List<ClientConfigurator> additionalClientConfigurators,
                         String endpoint)
        Deprecated.
        Use the builder instead.
        Create a new client instance.
        Parameters:
        authenticationDetailsProvider - The authentication details (see Builder#build)
        configuration - Builder#configuration
        clientConfigurator - Builder#clientConfigurator
        defaultRequestSignerFactory - Builder#requestSignerFactory
        additionalClientConfigurators - Builder#additionalClientConfigurators
        endpoint - Builder#endpoint

      • StreamAsyncClient

        @Deprecated
public StreamAsyncClient​(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                         ClientConfiguration configuration,
                         ClientConfigurator clientConfigurator,
                         RequestSignerFactory defaultRequestSignerFactory,
                         Map<SigningStrategy,​RequestSignerFactory> signingStrategyRequestSignerFactories,
                         List<ClientConfigurator> additionalClientConfigurators,
                         String endpoint)
        Deprecated.
        Use the builder instead.
        Create a new client instance.
        Parameters:
        authenticationDetailsProvider - The authentication details (see Builder#build)
        configuration - Builder#configuration
        clientConfigurator - Builder#clientConfigurator
        defaultRequestSignerFactory - Builder#requestSignerFactory
        additionalClientConfigurators - Builder#additionalClientConfigurators
        endpoint - Builder#endpoint
        signingStrategyRequestSignerFactories - Builder#signingStrategyRequestSignerFactories

    • Method Detail

      • consumerCommit

        public Future<ConsumerCommitResponse> consumerCommit​(ConsumerCommitRequest request,
                                                     AsyncHandler<ConsumerCommitRequest,​ConsumerCommitResponse> handler)
        Description copied from interface: StreamAsync
        Provides a mechanism to manually commit offsets, if not using commit-on-get consumer semantics.

        This commits offsets assicated with the provided cursor, extends the timeout on each of the affected partitions, and returns an updated cursor.

        Specified by:
        consumerCommit in interface StreamAsync
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • consumerHeartbeat

        public Future<ConsumerHeartbeatResponse> consumerHeartbeat​(ConsumerHeartbeatRequest request,
                                                           AsyncHandler<ConsumerHeartbeatRequest,​ConsumerHeartbeatResponse> handler)
        Description copied from interface: StreamAsync
        Allows long-running processes to extend the timeout on partitions reserved by a consumer instance.
        Specified by:
        consumerHeartbeat in interface StreamAsync
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • createCursor

        public Future<CreateCursorResponse> createCursor​(CreateCursorRequest request,
                                                 AsyncHandler<CreateCursorRequest,​CreateCursorResponse> handler)
        Description copied from interface: StreamAsync
        Creates a cursor.

        Cursors are used to consume a stream, starting from a specific point in the partition and going forward from there. You can create a cursor based on an offset, a time, the trim horizon, or the most recent message in the stream. As the oldest message inside the retention period boundary, using the trim horizon effectively lets you consume all messages in the stream. A cursor based on the most recent message allows consumption of only messages that are added to the stream after you create the cursor. Cursors expire five minutes after you receive them from the service.

        Specified by:
        createCursor in interface StreamAsync
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • getGroup

        public Future<GetGroupResponse> getGroup​(GetGroupRequest request,
                                         AsyncHandler<GetGroupRequest,​GetGroupResponse> handler)
        Description copied from interface: StreamAsync
        Returns the current state of a consumer group.
        Specified by:
        getGroup in interface StreamAsync
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • getMessages

        public Future<GetMessagesResponse> getMessages​(GetMessagesRequest request,
                                               AsyncHandler<GetMessagesRequest,​GetMessagesResponse> handler)
        Description copied from interface: StreamAsync
        Returns messages from the specified stream using the specified cursor as the starting point for consumption.

        By default, the number of messages returned is undefined, but the service returns as many as possible. To get messages, you must first obtain a cursor using the createCursor operation. In the response, retrieve the value of the ‘opc-next-cursor’ header to pass as a parameter to get the next batch of messages in the stream.

        Specified by:
        getMessages in interface StreamAsync
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • putMessages

        public Future<PutMessagesResponse> putMessages​(PutMessagesRequest request,
                                               AsyncHandler<PutMessagesRequest,​PutMessagesResponse> handler)
        Description copied from interface: StreamAsync
        Emits messages to a stream.

        There’s no limit to the number of messages in a request, but the total size of a message or request must be 1 MiB or less. The service calculates the partition ID from the message key and stores messages that share a key on the same partition. If a message does not contain a key or if the key is null, the service generates a message key for you. The partition ID cannot be passed as a parameter.

        Specified by:
        putMessages in interface StreamAsync
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • updateGroup

        public Future<UpdateGroupResponse> updateGroup​(UpdateGroupRequest request,
                                               AsyncHandler<UpdateGroupRequest,​UpdateGroupResponse> handler)
        Description copied from interface: StreamAsync
        Forcefully changes the current location of a group as a whole; reseting processing location of all consumers to a particular location in the stream.
        Specified by:
        updateGroup in interface StreamAsync
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • useRealmSpecificEndpointTemplate

        public void useRealmSpecificEndpointTemplate​(boolean useOfRealmSpecificEndpointTemplateEnabled)
        This method should be used to enable or disable the use of realm-specific endpoint template.

        The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false

        Parameters:
        useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively

      • populateServiceParametersInEndpoint

        public final void populateServiceParametersInEndpoint​(String endpoint,
                                                      Map<String,​Object> requiredParametersMap)
        Populate the parameters in the endpoint with its corresponding value and update the base endpoint.

        The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.

        Parameters:
        endpoint - The endpoint template in use
        requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value

      • updateBaseEndpoint

        public final void updateBaseEndpoint​(String endpoint)
        This method should be used for parameterized endpoint templates only.

        This does not include {region} and {secondLevelDomain} parameters.

        Parameters:
        endpoint - The updated endpoint to use

      • setEndpoint

        public final void setEndpoint​(String endpoint)

      • getEndpoint

        public final String getEndpoint()

      • refreshClient

        public final void refreshClient()
        Rebuild the backing HttpClient.

        This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

      • setRegion

        protected void setRegion​(Region region)

      • setRegion

        protected void setRegion​(String regionId)

      • getClientCommonLibraryVersion

        public String getClientCommonLibraryVersion()

      • getMinimumClientCommonLibraryVersionFromClient

        public Optional<String> getMinimumClientCommonLibraryVersionFromClient()