1 /*
2 * Copyright 2007 the original author or authors.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 package org.springframework.ws.server.endpoint.annotation;
18
19 import java.lang.annotation.Documented;
20 import java.lang.annotation.ElementType;
21 import java.lang.annotation.Retention;
22 import java.lang.annotation.RetentionPolicy;
23 import java.lang.annotation.Target;
24
25 /**
26 * Marks an endpoint method as the handler for an incoming request. The annotation values signify the the request
27 * payload root element that is handled by the method.
28 *
29 * @author Arjen Poutsma
30 * @see org.springframework.ws.server.endpoint.mapping.PayloadRootAnnotationMethodEndpointMapping
31 * @since 1.0.0
32 */
33 @Target(ElementType.METHOD)
34 @Retention(RetentionPolicy.RUNTIME)
35 @Documented
36 public @interface PayloadRoot {
37
38 /**
39 * Signifies the local part of the payload root element handled by the annotated method.
40 *
41 * @see #namespace()
42 */
43 String localPart();
44
45 /**
46 * Signifies the namespace of the payload root element handled by the annotated method.
47 *
48 * @see #localPart()
49 */
50 String namespace() default "";
51
52 }