Package org.jboss.ws.api.annotation

Annotation Interface WebContext

@Retention(RUNTIME) @Target(TYPE) public @interface WebContext
Provides web context specific meta data to EJB based web service endpoints.
Since:
26-Apr-2005
Author:
Thomas Diesler

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    authMethod
    The authMethod is used to configure the authentication mechanism for the web service.
    String
    contextRoot
    The contextRoot element specifies the context root that the web service endpoint is deployed to.
    String
    realmName
    Description of the resource being accessed
    boolean
    secureWSDLAccess
    A secure endpoint does not secure wsdl access by default.
    String
    transportGuarantee
    The transportGuarantee specifies that the communication between client and server should be NONE, INTEGRAL, or CONFIDENTIAL.
    String
    urlPattern
    Relative path that is appended to the contextRoot to form fully qualified endpoint address for the web service endpoint.
    String
    virtualHost
    The virtual host that the web service endpoint is deployed to.

  • Element Details

    • contextRoot

      String contextRoot
      The contextRoot element specifies the context root that the web service endpoint is deployed to. If it is not specified it will be derived from the deployment short name. Applies to server side port components only
      Returns:
      string
      Default:
      ""

    • virtualHost

      String virtualHost
      The virtual host that the web service endpoint is deployed to. Applies to server side port components only.
      Returns:
      string
      Default:
      ""

    • urlPattern

      String urlPattern
      Relative path that is appended to the contextRoot to form fully qualified endpoint address for the web service endpoint. Applies to server side port components only.
      Returns:
      string
      Default:
      ""

    • authMethod

      String authMethod
      The authMethod is used to configure the authentication mechanism for the web service. As a prerequisite to gaining access to any web service which are protected by an authorization constraint, a user must have authenticated using the configured mechanism. Standard values for this element are "BASIC", or "CLIENT-CERT", custom authMethods may also be specified.
      Returns:
      string
      See Also:
      Default:
      ""

    • transportGuarantee

      String transportGuarantee
      The transportGuarantee specifies that the communication between client and server should be NONE, INTEGRAL, or CONFIDENTIAL. NONE means that the application does not require any transport guarantees. A value of INTEGRAL means that the application requires that the data sent between the client and server be sent in such a way that it can't be changed in transit. CONFIDENTIAL means that the application requires that the data be transmitted in a fashion that prevents other entities from observing the contents of the transmission. In most cases, the presence of the INTEGRAL or CONFIDENTIAL flag will indicate that the use of SSL is required.
      Returns:
      string
      See Also:
      Default:
      ""

    • secureWSDLAccess

      boolean secureWSDLAccess
      A secure endpoint does not secure wsdl access by default. Explicitly setting secureWSDLAccess overrides this behaviour. Protect access to WSDL. See http://jira.jboss.org/jira/browse/JBWS-723
      Returns:
      boolean
      Default:
      false

    • realmName

      String realmName
      Description of the resource being accessed
      Returns:
      string
      Default:
      ""