JAX-RS Client Properties (webTarget)

Configuration properties to be applied to JAX-RS WebTargets that match the specified URI when they are constructed. A property specified programmatically after object construction takes precedence over a property declared in xml.

Name	Type	Description
authnToken	string	The type of authorization token to use. This must be ltpa, saml, or oauth. This is equivalent to specifying one of the com.ibm.ws.jaxrs.client.ltpa.handler, com.ibm.ws.jaxrs.client.saml.sendToken, or com.ibm.ws.jaxrs.client.oauth.sendToken programmatic properties.
connectionTimeout	long	The amount of time to wait in milliseconds for a connection to be made. This is equivalent to the com.ibm.ws.jaxrs.client.timeout programmatic property.
disableCNCheck	boolean	Disables the Common Name Check. Valid values are true or false. This is equivalent to the com.ibm.ws.jaxrs.client.disableCNCheck programmatic property .
id	string	A unique configuration ID.
other	string	Any other variables can also be specified and will be passed to the WebTarget intact.
proxyHost	string	The host name of the proxy server. This is equivalent to the com.ibm.ws.jaxrs.client.proxy.host programmatic property.
proxyPort	int	The port of the proxy server. This is equivalent to the com.ibm.ws.jaxrs.client.proxy.port programmatic property .
proxyType	string	The port of the proxy server. This is equivalent to the com.ibm.ws.jaxrs.client.proxy.port programmatic property .
receiveTimeout	long	The amount of time to wait in milliseconds for a response after a connection is established. This is equivalent to the com.ibm.ws.jaxrs.client.receive.timeout programmatic property.
sslConfig	string	An id of an ssl reference found in server.xml. That ssl configuration specified by that reference is used.
uri	string Required	The URI specified in application code. If the URI matches the URI in code, the properties are applied to that WebTarget. If the URI ends with , then its properties are applied to any WebTarget having a URI that begins with the specified URI. If more than one URI ending with matches a WebTarget URI, all are applied in sorted order of URI.

Name

Type

Default

Description

authnToken

string

The type of authorization token to use. This must be ltpa, saml, or oauth. This is equivalent to specifying one of the com.ibm.ws.jaxrs.client.ltpa.handler, com.ibm.ws.jaxrs.client.saml.sendToken, or com.ibm.ws.jaxrs.client.oauth.sendToken programmatic properties.

connectionTimeout

long

The amount of time to wait in milliseconds for a connection to be made. This is equivalent to the com.ibm.ws.jaxrs.client.timeout programmatic property.

disableCNCheck

boolean

Disables the Common Name Check. Valid values are true or false. This is equivalent to the com.ibm.ws.jaxrs.client.disableCNCheck programmatic property .

string

A unique configuration ID.

other

string

Any other variables can also be specified and will be passed to the WebTarget intact.

proxyHost

string

The host name of the proxy server. This is equivalent to the com.ibm.ws.jaxrs.client.proxy.host programmatic property.

proxyPort

int

The port of the proxy server. This is equivalent to the com.ibm.ws.jaxrs.client.proxy.port programmatic property .

proxyType

string

The port of the proxy server. This is equivalent to the com.ibm.ws.jaxrs.client.proxy.port programmatic property .

receiveTimeout

long

The amount of time to wait in milliseconds for a response after a connection is established. This is equivalent to the com.ibm.ws.jaxrs.client.receive.timeout programmatic property.

sslConfig

string

An id of an ssl reference found in server.xml. That ssl configuration specified by that reference is used.

uri

string
Required

The URI specified in application code. If the URI matches the URI in code, the properties are applied to that WebTarget. If the URI ends with *, then its properties are applied to any WebTarget having a URI that begins with the specified URI. If more than one URI ending with * matches a WebTarget URI, all are applied in sorted order of URI.