Reference Elements (Sun Java System Web Server 7.0 Update 4 Developer's Guide to Java Web Applications)

Sun Java System Web Server 7.0 Update 4 Developer's Guide to Java Web Applications

Reference Elements

Reference elements are as follows:

`resource-env-ref` Element

This element maps the res-ref-name Element in the corresponding Java EE web.xml file resource-env-ref entry to the absolute jndi-name of a resource.

Subelements

The following table describes subelements for the resource-env-ref element.

Table A–20 resource-env-ref Subelements


Element	Required	Description
`resource-env-ref-name` Element	only one	Specifies the `res-ref-name` in the corresponding Java EE `web.xml` file `resource-env-ref` entry.
`jndi-name` Element	only one	Specifies the absolute `jndi-name` of a resource.

Attributes

none

`resource-env-ref-name` Element

Contains data that specifies the res-ref-name Element in the corresponding Java EE web.xml file resource-env-ref entry.

Subelements

none

Attributes

none

`service-ref` Element

This element specifies the runtime settings for a web service reference. Runtime information is only needed in the following cases:

To define the port used to resolve a container-managed port
To define the default Stub/Call property settings for Stub objects
To define the URL of a final WSDL document to be used instead of the one associated with service-ref in the standard Java EE deployment descriptor

Table A–21 service-ref Subelements


Element	Required	Description
`service-ref-name` Element	only one	Specifies the web service reference name relative to `java:comp/env`
`port-info` Element	zero or more	Specifies information for a port within a web service reference
`call-property` Element	zero or more	Specifies JAX-RPC property values that can be set on a `javax.xml.rpc`. `Call` object before it is returned to the web service client
`service-impl-class` Element	zero or more	Specifies the name of the generated service implementation class
`service-qname` Element	zero or one	Specifies the WSDL service element that is being referenced.

`service-ref-name` Element

This element specifies the web service reference name relative to java:comp/env.

Subelements

none

Attributes

none

`port-info` Element

Either a service-endpoint-interface or a wsdl-port or both ports must be specified. If both ports are specified, wsdl-port specifies the port that the container chooses for container-managed port selection. The same wsdl-port value must not appear in more than one port-info element within the same service-ref. If a service-endpoint-interface is using container-managed port selection, its value must not appear in more than one port-info element within the same service-ref.

Subelements

The following table describes subelements for the port-info element.

Table A–22 port-info Subelements


Element	Required	Description
`service-endpoint-interface` Element	zero or one	Specifies the web service reference name relative to `java:comp/env`.
`wsdl-port` Element	zero or one	Specifies the WSDL port.
`stub-property` Element	zero or one	Specifies JAX-RPC property values that are set on the`javax.xml.rpc.Stub` object before it is returned to the web service client.
`call-property` Element	zero or one	Specifies JAX-RPC property values that are set on the`javax.xml.rpc.Stub` object before it is returned to the web service client.
`message-security-binding` Element	zero or one	Specifies a custom authentication provider binding.

`service-endpoint-interface` Element

This element specifies the web service reference name relative to java:comp/env.

Subelements

none

Attributes

none

`wsdl-port` Element

Specifies the WSDL port.

Subelements

The following table describes subelements for the wsdl-port element

Table A–23 wsdl-port Subelements


Element	Required	Description
`namespaceURI` Element	only one	Specifies the namespace URI.
`localpart` Element	only one	Specifies the local part of a QNAME.

`namespaceURI` Element

This element specifies the namespace URI.

Subelements

none

Attributes

none

`localpart` Element

Specifies the local part of a QNAME.

Subelements

none

Attributes

none

`stub-property` Element

This element specifies JAX-RPC property values that are set on a javax.xml.rpc. Stub object before it is returned to the web service client. The property names can be any properties supported by the JAX-RPC Stub implementation.

Subelements

The following table describes subelements for the stub-property element.

Table A–24 stub-property subelements


Element	Required	Description
`name` Element	only one	Specifies the name of the entity.
value Element	only one	Specifies the value of the entity.

`call-property` Element

This element specifies JAX-RPC property values that can be set on a javax.xml.rpc call object before it is returned to the web service client. The property names can be any properties supported by the JAX-RPC Call implementation.

Table A–25 call-property Subelements


Element	Required	Description
`name` Element	only one	Specifies the name of the entity.
value Element	only one	Specifies the value of the entity.

`wsdl-override` Element

This element specifies a valid URL pointing to a final WSDL document. If not specified, the WSDL document associated with the service-ref in the standard J2EE deployment descriptor is used.

Subelements

none

Attributes

none

`service-impl-class` Element

Specifies the name of the generated service implementation class.

Subelements

none

Attributes

none

`service-qname` Element

This element specifies the WSDL service element that is being referred to

Subelements

The following table describes subelements for the service-qname element.

Table A–26 service-qname Subelements


Element	Required	Description
`namespaceURI` Element	only one	Specifies the namespace URI.
`localpart` Element	only one	Specifies the local part of a QNAME.

`resource-ref` Element

This element maps the res-ref-name Element in the corresponding Java EE web.xml file resource-ref entry to the absolute jndi-name Element of a resource.

Subelements

The following table describes subelements for the resource-ref element. The left column lists the subelement name, the middle column indicates the requirement rule, and the right column describes what the element does.

Table A–27 resource-ref Subelements


Element	Required	Description
`res-ref-name` Element	only one	Specifies the `res-ref-name` in the corresponding Java EE `web.xml` file `resource-ref` entry
`jndi-name` Element	only one	Specifies the absolute `jndi-name` of a resource
`default-resource-principal` Element	zero or one	Specifies the default principal (user) for the resource

Attributes

none

`res-ref-name` Element

This element contains data that specifies the res-ref-name in the corresponding Java EE web.xml file resource-ref entry.

Subelements

none

Attributes

none

`default-resource-principal` Element

This element specifies the default principal (user) for the resource.

If this element is used in conjunction with a JMS Connection Factory resource, the name and password subelements must be valid entries in Message Queue's broker user repository.

Subelements

The following table describes subelements for the default-resource-principal element.

Table A–28 default-resource-principal Subelements


Element	Required	Description
`name` Element	only one	Contains the name of the principal
`password` Element	only one	Contains the password for the principal

Attributes

none

`name` Element

This element contains data that specifies the name of the principal.

Subelements

none

Attributes

none

`password` Element

This element contains data that specifies the password for the principal.

Subelements

none

Attributes

none

`jndi-name` Element

This element contains data that specifies the absolute jndi-name of a URL resource or a resource in the server.xml file.

Note –

To avoid collisions with names of other enterprise resources in JNDI, and to avoid portability problems, all names in a Web Server application should begin with the string java:comp/env.

Subelements

none

Attributes

none