View Javadoc

1   package org.codehaus.xfire.annotations;
2   
3   /***
4    * Represents a common representation of a handler chain annotation. Associates the Web Service with an externally
5    * defined handler chain. This annotation is typically used in scenarios where embedding the handler configuration
6    * directly in the Java source is not appropriate; for example, where the handler configuration needs to be shared
7    * across multiple Web Services, or where the handler chain consists of handlers for multiple transports.
8    * <p/>
9    * It is an error to combine this annotation with the {@link org.codehaus.xfire.annotations.soap.SOAPMessageHandler}.
10   *
11   * @author <a href="mailto:poutsma@mac.com">Arjen Poutsma</a>
12   */
13  public class HandlerChainAnnotation
14  {
15      private String file;
16      private String name;
17  
18      /***
19       * Initializes a new instance of the <code>HandlerChain</code> attribute with the given file and chain name.
20       *
21       * @param file the file name.
22       * @param name the handler name.
23       */
24      public HandlerChainAnnotation(String file, String name)
25      {
26          this.file = file;
27          this.name = name;
28      }
29  
30      /***
31       * Returns the location of the handler chain file. The location is a URL, which may be relative or absolute.
32       * Relative URLs are relative to the location of the service implementation bean at the time of processing.
33       *
34       * @return the location of the handler chain file.
35       */
36      public String getFile()
37      {
38          return file;
39      }
40  
41      /***
42       * Returns the name of the handler chain in the configuration file.
43       *
44       * @return the name of the handler chain.
45       */
46      public String getName()
47      {
48          return name;
49      }
50  }