com.microsoft.azure.eventhubs.ReceiverOptions Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-eventhubs Show documentation
Client library for talking to Microsoft Azure Event Hubs.
There is a newer version: 3.3.0
/*
 * Copyright (c) Microsoft. All rights reserved.
 * Licensed under the MIT license. See LICENSE file in the project root for full license information.
 */
package com.microsoft.azure.eventhubs;

import com.microsoft.azure.servicebus.ClientConstants;

/**
 * Represents various optional behaviors which can be turned on or off during the creation of a {@link PartitionReceiver}.
 */
public final class ReceiverOptions {

    private boolean receiverRuntimeMetricEnabled;
    private String identifier;

    /**
     * Knob to enable/disable runtime metric of the receiver. If this is set to true and is passed to {@link EventHubClient#createReceiver},
     * after the first {@link PartitionReceiver#receive(int)} call, {@link PartitionReceiver#getRuntimeInformation()} is populated.
     * 
     * Enabling this knob will add 3 additional properties to all {@link EventData}'s received on the {@link EventHubClient#createReceiver}.
     *
     * @return the {@link boolean} indicating, whether, the runtime metric of the receiver was enabled
     */
    public boolean getReceiverRuntimeMetricEnabled() {

        return this.receiverRuntimeMetricEnabled;
    }

    /**
     * Knob to enable/disable runtime metric of the receiver. If this is set to true and is passed to {@link EventHubClient#createReceiver},
     * after the first {@link PartitionReceiver#receive(int)} call, {@link PartitionReceiver#getRuntimeInformation()} is populated.
     * 

     * Enabling this knob will add 3 additional properties to all {@link EventData}'s received on the {@link EventHubClient#createReceiver}.
     *
     * @param value the {@link boolean} to indicate, whether, the runtime metric of the receiver should be enabled
     */
    public void setReceiverRuntimeMetricEnabled(boolean value) {

        this.receiverRuntimeMetricEnabled = value;
    }

    /**
     * Gets the identifier of the {@link PartitionReceiver}
     *
     * @return identifier of the {@link PartitionReceiver}; null if nothing was set
     */
    public String getIdentifier() {

        return this.identifier;
    }

    /**
     * Set an identifier to {@link PartitionReceiver}.
     * 

     *     This identifier will be used by EventHubs service when reporting any errors across receivers, and is caused by this receiver.
     * For example, when receiver quota limit is hit, while a user is trying to create New receiver,
     * EventHubs service will throw {@link com.microsoft.azure.servicebus.QuotaExceededException} and will include this identifier.
     * So, its very critical to choose a value, which can uniquely identify the whereabouts of {@link PartitionReceiver}.
     *
     * 
     * @param value string to identify {@link PartitionReceiver}
     */
    public void setIdentifier(final String value) {

        ReceiverOptions.validateReceiverIdentifier(value);
        this.identifier = value;
    }

    private static void validateReceiverIdentifier(final String receiverName) {

        if (receiverName != null &&
                receiverName.length() > ClientConstants.MAX_RECEIVER_NAME_LENGTH) {
            throw new IllegalArgumentException("receiverIdentifier length cannot exceed 64");
        }
    }
}