org.mule.api.annotations.param.OutboundHeaders Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) MuleSoft, Inc.  All rights reserved.  http://www.mulesoft.com
 * The software in this package is published under the terms of the CPAL v1.0
 * license, a copy of which has been included with this distribution in the
 * LICENSE.txt file.
 */
package org.mule.api.annotations.param;

import org.mule.api.annotations.meta.Evaluator;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.util.Map;

/**
 * 
 * Used on Components that have an outbound endpoint configured or a response being
 * sent back, and enables users to set outbound/response headers via {@link Map}
 * without needing to use the Mule API (other than using the annotation) on the
 * method argument). This parameter annotation passes in a reference to a {@link Map}
 * that can be used to populate outbound headers that will be set with the outgoing
 * message. For example, when sending an email message, you may want to set
 * properties such as "from" or "subject" as a sender header.
 * 
 * 
 * This annotation must only be defined on a parameter of type {@link Map}.
 * 
 */
@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Evaluator("outboundHeaders")
public @interface OutboundHeaders
{
    // no custom methods
}