001// ***************************************************************************************************************************
002// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file *
003// * distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file        *
004// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance            *
005// * with the License.  You may obtain a copy of the License at                                                              *
006// *                                                                                                                         *
007// *  http://www.apache.org/licenses/LICENSE-2.0                                                                             *
008// *                                                                                                                         *
009// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an  *
010// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the        *
011// * specific language governing permissions and limitations under the License.                                              *
012// ***************************************************************************************************************************
013package org.apache.juneau.soap.annotation;
014
015import static java.lang.annotation.ElementType.*;
016import static java.lang.annotation.RetentionPolicy.*;
017
018import java.lang.annotation.*;
019
020import org.apache.juneau.annotation.*;
021import org.apache.juneau.soap.*;
022
023/**
024 * Annotation for specifying config properties defined in {@link SoapXmlSerializer}.
025 *
026 * <p>
027 * Used primarily for specifying bean configuration properties on REST classes and methods.
028 */
029@Documented
030@Target({TYPE,METHOD})
031@Retention(RUNTIME)
032@Inherited
033@PropertyStoreApply(SoapXmlConfigApply.class)
034public @interface SoapXmlConfig {
035
036   /**
037    * Optional rank for this config.
038    *
039    * <p>
040    * Can be used to override default ordering and application of config annotations.
041    */
042   int rank() default 0;
043
044   //-------------------------------------------------------------------------------------------------------------------
045   // SoapXmlSerializer
046   //-------------------------------------------------------------------------------------------------------------------
047
048   /**
049    * Configuration property:  The <c>SOAPAction</c> HTTP header value to set on responses.
050    *
051    * <ul class='seealso'>
052    *    <li class='jf'>{@link SoapXmlSerializer#SOAPXML_SOAPAction}
053    * </ul>
054    */
055   String soapAction() default "";
056}