View Javadoc

1   /*
2    * $Id: OutboundHeaders.java 20321 2010-11-24 15:21:24Z dfeist $
3    * --------------------------------------------------------------------------------------
4    * Copyright (c) MuleSoft, Inc.  All rights reserved.  http://www.mulesoft.com
5    *
6    * The software in this package is published under the terms of the CPAL v1.0
7    * license, a copy of which has been included with this distribution in the
8    * LICENSE.txt file.
9    */
10  
11  package org.mule.api.annotations.param;
12  
13  import org.mule.api.annotations.meta.Evaluator;
14  
15  import java.lang.annotation.Documented;
16  import java.lang.annotation.ElementType;
17  import java.lang.annotation.Retention;
18  import java.lang.annotation.RetentionPolicy;
19  import java.lang.annotation.Target;
20  
21  /**
22   * Used on Components that have an outbound endpoint configured or a response being sent back, and enables users
23   * to set outbound/response headers via {@link Map} without needing to use the Mule API (other than using the annotation)
24   * on the method argument).
25   * This parameter annotation passes in a reference to a {@link java.util.Map} that can be used to populate 
26   * outbound headers that will be set with the outgoing message. For example, when sending an email message, 
27   * you may want to set properties such as "from" or "subject" as a sender header.
28   * <p/>
29   * This annotation must only be defined on a parameter of type {@link java.util.Map}.
30   */
31  @Target(ElementType.PARAMETER)
32  @Retention(RetentionPolicy.RUNTIME)
33  @Documented
34  @Evaluator("outboundHeaders")
35  public @interface OutboundHeaders
36  {
37  }