View Javadoc

    1   package org.codehaus.xfire.annotations.soap;
    2
    3   /***
    4    * Represents a common implementation of the SOAP message handler. Specifies a single SOAP message handler.
    5    *
    6    * @author <a href="mailto:poutsma@mac.com">Arjen Poutsma</a>
    7    */
    8   public class SOAPMessageHandler
    9   {
    10      private String className;
    11      private String name;
    12      private InitParam[] initParams = new InitParam[0];
    13      private String[] roles = new String[0];
    14      private String[] headers = new String[0];
    15
    16      /***
    17       * Initializes a new instance of the <code>SOAPMessageHandler</code>.
    18       *
    19       * @param className the name of the handler class.
    20       */
    21      public SOAPMessageHandler(String className)
    22      {
    23          this.className = className;
    24      }
    25
    26      /***
    27       * Returns the name of the handler class.
    28       *
    29       * @return the name of the handler class.
    30       */
    31      public String getClassName()
    32      {
    33          return className;
    34      }
    35
    36      /***
    37       * Returns the name of the handler. Defaults to the name of the handler class.
    38       *
    39       * @return the name of the handler
    40       */
    41      public String getName()
    42      {
    43          return name;
    44      }
    45
    46      /***
    47       * Sets the name of the handler.
    48       *
    49       * @param name the name of the handler
    50       */
    51      public void setName(String name)
    52      {
    53          this.name = name;
    54      }
    55
    56      /***
    57       * Returns the array of name/value pairs that should be passed to the handler during initialization.
    58       *
    59       * @return the initialization array
    60       */
    61      public InitParam[] getInitParams()
    62      {
    63          return initParams;
    64      }
    65
    66      /***
    67       * Sets the array of name/value pairs that should be passed to the handler during initialization.
    68       *
    69       * @param initParams the initialization array
    70       */
    71      public void setInitParams(InitParam[] initParams)
    72      {
    73          this.initParams = initParams;
    74      }
    75
    76      /***
    77       * Returns the list of SOAP roles/actors implemented by the handler
    78       *
    79       * @return the list of SOAP roles/actors
    80       */
    81      public String[] getRoles()
    82      {
    83          return roles;
    84      }
    85
    86      /***
    87       * Sets the list of SOAP roles/actors implemented by the handler
    88       *
    89       * @param roles the list of SOAP roles/actors
    90       */
    91      public void setRoles(String[] roles)
    92      {
    93          this.roles = roles;
    94      }
    95
    96      /***
    97       * Returns the list of SOAP headers processed by the handler. Each element in this array contains a {@link
    98       * javax.xml.namespace.QName} which defines the header element processed by the handler. The QNames are specified
    99       * using the string notation described in the documentation for {@link javax.xml.namespace.QName#valueOf(String)}.
    100      *
    101      * @return the list of SOAP headers
    102      */
    103     public String[] getHeaders()
    104     {
    105         return headers;
    106     }
    107
    108     /***
    109      * Sets the list of SOAP headers processed by the handler. Each element in this array contains a {@link
    110      * javax.xml.namespace.QName} which defines the header element processed by the handler. The QNames are specified
    111      * using the string notation described in the documentation for {@link javax.xml.namespace.QName#valueOf(String)}.
    112      *
    113      * @param headers the list of SOAP headers
    114      */
    115     public void setHeaders(String[] headers)
    116     {
    117         this.headers = headers;
    118     }
    119
    120
    121 }