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