Package jakarta.jws

Annotation Type WebMethod

  • @Retention(RUNTIME)
@Target(METHOD)
public @interface WebMethod
    Customizes a method that is exposed as a Web Service operation. The associated method must be public and its parameters return value, and exceptions must follow the rules defined in Jakarta XML Web Services Specification, section 5. The method is not required to throw java.rmi.RemoteException.
    Since:
    1.6

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      String action
      The action for this operation.
      boolean exclude
      Marks a method to NOT be exposed as a web method.
      String operationName
      Name of the wsdl:operation matching this method.

    • Element Detail

      • operationName

        String operationName
        Name of the wsdl:operation matching this method.
        Returns:
        the name of the wsdl:operation
        Default:
        ""

      • action

        String action
        The action for this operation.

        For SOAP bindings, this determines the value of the soap action.

        Returns:
        the action
        Default:
        ""

      • exclude

        boolean exclude
        Marks a method to NOT be exposed as a web method.

        Used to stop an inherited method from being exposed as part of this web service. If this element is specified, other elements MUST NOT be specified for the @WebMethod.

        This member-value is not allowed on endpoint interfaces.

        Returns:
        value of true to mark the method to not be exposed or false otherwise
        Since:
        2.0
        Default:
        false