org.jboss.ws.api.annotation
Annotation Type WebContext
@Retention(value=RUNTIME)
@Target(value=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 |
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. |
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. |
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.
- Default:
- ""
virtualHost
public abstract String virtualHost
- The virtual host that the web service endpoint is deployed to.
Applies to server side port components only.
- 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.
- 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.
- 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.
- 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
- Default:
- false
Copyright © 2012 JBoss, by Red Hat. All Rights Reserved.