com.microsoft.azure.functions.rabbitmq.annotation.RabbitMQOutput Maven / Gradle / Ivy

Go to download
/**
 * Copyright (c) Microsoft Corporation. All rights reserved.
 * Licensed under the MIT License. See License.txt in the project root for
 * license information.
 */
 
package com.microsoft.azure.functions.rabbitmq.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import com.microsoft.azure.functions.annotation.CustomBinding;

/**
 * Place this on a parameter whose value should be set in order for an event to be enqueued to a rabbitMQ queue.
 * The parameter can be one of the following
 *
 * 
 *     Any native Java types such as int, String, byte[]
 *     Any POJO type
 * 
 * The following example is a Java function that uses a RabbitMQ trigger and output binding.
 *
 * {@literal @}FunctionName("RabbitMQExample")
 * public void run(
 *    {@literal @}@RabbitMQTrigger(
 *               connectionStringSetting = "ConnectionString",
 *               queueName = "TestQueue"
 *           ) String input,
 *    {@literal@}@RabbitMQOutput(
 *               connectionStringSetting = "ConnectionString",
 *               queueName = "hello"
 *           ) OutputBinding output,
 *     final ExecutionContext context
 * ) {
 *     context.getLogger().info("Java RabbitMQ trigger processed a request." + input);
 *     output.setValue(input);
 * }
 *
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.PARAMETER, ElementType.METHOD})
@CustomBinding(direction = "out", name = "outputMessage", type = "rabbitMq")
public @interface RabbitMQOutput {

    /**
     * The setting name of connection string.
     * @return The connection string setting name from app settings.
     */
    String connectionStringSetting() default "";

    /**
     * The host name to connect to.
     * @return The host name.
     */
    String hostName() default "";

    /**
     * The name of queue to connect to.
     * @return The name of queue to connect to.
     */
    String queueName() default "";

    /**
     * The username to authenticate with.
     * @return The username to authenticate with.
     */
    String userName() default "";

    /**
     * The password to authenticate with.
     * @return The password to authenticate with.
     */
    String password() default "";

    /**
     * The port to attach.
     * @return The port to attach.
     */
    int port() default 0;
}