Home All Groups
jbossws-api / org / jboss / ws / api / annotation / WebContext.html /
org.jboss.ws.api.annotation

Annotation Type WebContext

    • Optional Element Summary

      Optional Elements 
      Modifier and TypeOptional Element and Description
      StringauthMethod
      The authMethod is used to configure the authentication mechanism for the web service.
      StringcontextRoot
      The contextRoot element specifies the context root that the web service endpoint is deployed to.
      StringrealmName
      Description of the resource being accessed
      booleansecureWSDLAccess
      A secure endpoint does not secure wsdl access by default.
      StringtransportGuarantee
      The transportGuarantee specifies that the communication between client and server should be NONE, INTEGRAL, or CONFIDENTIAL.
      StringurlPattern
      Relative path that is appended to the contextRoot to form fully qualified endpoint address for the web service endpoint.
      StringvirtualHost
      The virtual host that the web service endpoint is deployed to.
    • Element Detail

      • contextRoot

        public abstract 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

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

        public abstract 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

        public abstract 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:
        AuthMethod
        Default:
        ""
      • transportGuarantee

        public abstract 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:
        TransportGuarantee
        Default:
        ""
      • secureWSDLAccess

        public abstract 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

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

Copyright © 2018 JBoss, by Red Hat. All rights reserved.