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 * <h5 class='section'>See Also:</h5><ul>
030 * </ul>
031 */
032@Target({TYPE,METHOD})
033@Retention(RUNTIME)
034@Inherited
035@ContextApply(SoapXmlConfigAnnotation.SerializerApply.class)
036public @interface SoapXmlConfig {
037
038   /**
039    * Optional rank for this config.
040    *
041    * <p>
042    * Can be used to override default ordering and application of config annotations.
043    *
044    * @return The annotation value.
045    */
046   int rank() default 0;
047
048   //-------------------------------------------------------------------------------------------------------------------
049   // SoapXmlCommon
050   //-------------------------------------------------------------------------------------------------------------------
051
052   //-------------------------------------------------------------------------------------------------------------------
053   // SoapXmlSerializer
054   //-------------------------------------------------------------------------------------------------------------------
055
056   /**
057    * The <c>SOAPAction</c> HTTP header value to set on responses.
058    *
059    * <h5 class='section'>See Also:</h5><ul>
060    *    <li class='jm'>{@link org.apache.juneau.soap.SoapXmlSerializer.Builder#soapAction(String)}
061    * </ul>
062    *
063    * @return The annotation value.
064    */
065   String soapAction() default "";
066
067   //-------------------------------------------------------------------------------------------------------------------
068   // SoapXmlParser
069   //-------------------------------------------------------------------------------------------------------------------
070}