Skip navigation links

oracle.webservices
Interface ClientConstants

All Known Subinterfaces:

OracleCall, OracleStub

public interface ClientConstants

A class that holds all the constants used by Calls, Stubs, and ServiceFactory to set and get client side properties.

Field Summary

static String	ACCEPT_ENCODING This property can be used for Stubs and Calls to specify the value of http 'ACCEPT_ENCODING' header for SOAP messages send over HTTP.
static String	ALL_OPERATIONS_ONE_WAY This property can be used by Stubs to determine if all the operations in a port are one-way
static String	CHARACTER_SET_ENCODING This property can be used for Stubs and Calls to get and set the character encoding which will be used to serialize the request soap message.
static String	CHUNK_SIZE This property can be used for Stubs and Calls to get and set the chunk size for SOAP messages sent over HTTP.
static String	CLIENT_CONFIG This property can be used for Stubs and Calls to get and set the Web Service Management configuration and other properties.
static String	COOKIE_MAP This property can be used for Stubs and Calls to get and set the Map of cookies used in a session.
static String	DIME_ENCODE_MESSAGES_WITH_ATTACHMENTS This property can be used for Stubs and Calls to specify whether DIME should be used to encode any attachments that are present instead of MIME.
static String	DISABLE_MUST_UNDERSTAND disable must understand checking for client inbound messages true: disable must understand check false (default): not disable must understand check Type: java.lang.Boolean
static String	DO_NOT_CHUNK This property can be used for Stubs and Calls to specify whether chunking should be used for SOAP messages sent over HTTP.
static String	HTTP_CONN_TIMEOUT This property can be used for Stubs and Calls to specify the connection timeout value of http soap connection in miliseconds.
static String	HTTP_READ_TIMEOUT This property can be used for Stubs and Calls to specify the read timeout value of http soap connection * in miliseconds.
static String	JAXRPC_STUB_INSTANCE This property can be used to get the Stub instance from the message context during Stub based client runtime
static String	JMS_TARGET_CORRELATION_ID This property can be used for Stubs and Call to get and set the Correlation Identifier for JMS endpoints.
static String	JMS_TARGET_MESSAGE_ID This property can be used for Stubs and Calls to get the Message Identifier for JMS endpoints.
static String	JMS_TARGET_REPLY_TO_FACTORY_NAME This property can be used for Stubs and Calls to get and set the ReplyTo factory name for JMS endpoints.
static String	JMS_TARGET_REPLY_TO_QUEUE_NAME This property can be used for Stubs and Calls to get and set the ReplyTo queue name for JMS endpoints.
static String	JMS_TARGET_REPLY_TO_TOPIC_NAME This property can be used for Stubs and Calls to get and set the ReplyTo topic name for JMS endpoints.
static String	JMS_TRANSPORT_REPLY_TO_FACTORY_NAME This property can be used for Stubs and Calls to get and set the ReplyTo factory name for a JMS transport.
static String	JMS_TRANSPORT_REPLY_TO_QUEUE_NAME This property can be used for Stubs and Calls to get and set the ReplyTo queue name for a JMS transport.
static String	MTOM_DOTNET_HEADER_STYLE This property can be used together with "MTOM_SUPPORT" on Stubs to improve interoperability with Microsoft .Net web services with MTOM enabled.
static String	MTOM_SUPPORT This property can be used for Stubs to specify whether the request, when relavant content exists, will be packaged as per MTOM/XOP.
static String	PREEMPTIVE_BASIC_AUTH This property can be used for Stubs to specify whether the request should include http basic authentication header without getting a challenge from the http server.
static String	PROVIDER_MSG_CONTEXT_PROPS This property can be used by dispatch clients to specify a map<String,Object> of properties to be conveyed to the provider implementation during a colocation invocation.
static String	PROXY_AUTH_TYPE This property can be used for Stubs and Calls to specify the type for proxy authentication Examples of the type of authentication are basic, digest, NTLM.
static String	PROXY_HOST This property can be used for Stubs and Calls to specify the host name of the Proxy server Type: java.lang.String
static String	PROXY_PASSWORD This property can be used for Stubs and Calls to specify the password for proxy authentication Type: java.lang.String
static String	PROXY_PORT This property can be used for Stubs and Calls to specify the port of the proxy server Type: java.lang.Integer
static String	PROXY_REALM This property can be used for Stubs and Calls to specify the realm for proxy authentication Type: java.lang.String
static String	PROXY_USERNAME This property can be used for Stubs and Calls to specify the username for proxy authentication Type: java.lang.String
static String	SERVICEIMPL_NAME A property to be set in the Properties parameter to indicate the service implementation class name when ServiceFactory.loadService() method is called.
static String	SOAP_VERSION This property can be used for Stubs and Calls to get and set SOAP version.
static String	SOAP_XML_RESPONSE This property can be set on Stubs and Calls to direct client-side OraSAAJ to use Scalable DOM (SDOM) when it creates a response soap message.
static String	STREAMING_INCOMING_ATTACHMENTS This property can be set on the RequestContext of a Dispatch object and the response SOAPMessage will have streamed attachments Type: java.lang.Boolean
static String	STREAMING_OUTGOING_ATTACHMENTS This property can be set on the RequestContext of a Dispatch object and the attachments in the request SOAPMessage will be streamed to the service Type: java.lang.Boolean
static String	TRANSACTIONAL This property can be used to enable WS-AtomicTransactions context outflow (for JAX-WS clients only)
static String	TRUST_MANAGER_ARRAY This property can be set on the RequestContext of a Dispatch object to specify a TrustManager array to use when making https connections The value of the property must be an array of type javax.net.ssl.TrustManager This can be used to specify custom implementations of TrustManager
static String	WALLET_KEYSTORE_PROVIDER The provider for this wallet - defaults to "OraclePKI" - for other providers, the caller will be required to register the provider using Security.addProvider(...)
static String	WALLET_KEYSTORE_TYPE The type of keystore for this wallet - "SSO", "PKCS12", "TEXT" are valid values If not provided, defaults to "SSO"
static String	WALLET_LOCATION
static String	WALLET_PASSWORD
static String	WSA_ACTION This property can be used by Stubs and Calls to dynamically set the wsa action used in the next invocation
static String	WSA_FAULT_TO This property can be used by Stubs and Calls to dynamically set the faultTo address used in the next invocation
static String	WSA_MESSAGE_ID This property can be used by Stubs and Calls to dynamically set the wsa message id used in the next invocation
static String	WSA_RELATES_TO This property can be used by Stubs and Calls to dynmaically set the relatesTo address used in the next invocation
static String	WSA_REPLY_TO This property can be used by Stubs and Calls to dynamically set the replyTo address used in the next invocation
static String	WSDL_DEFINITION This property can be set on the RequestContext of a Dispatch object in order to provide the WSDL Definition (this circumvents the inability to specify a Definition object instead of a wsdl location using the standard JAX-WS API)
static String	WSM_INTERCEPTOR_PIPELINE_CONFIG Deprecated. This property has been deprecated, please use oracle.webservices.ClientConstants.CLIENT_CONFIG.
static String	WSM_SUBJECT_PRECEDENCE This property will be set to false in case the client wants that while creating the SAML token we should not use the SUBJECT that has been formed and instead they want to use the username first that has been sent by the client.
static String	WSSEC_ENC_KEY_ALIAS This property can be used for Stubs and Calls to dynamically set the alias of the key within the the keystore that will be used for encryption.
static String	WSSEC_ENC_KEY_PASSWORD This property can be used for Stubs and Calls to dynamically set the password for the key within the keystore that will be used for encryption.
static String	WSSEC_KERBEROS_SERVICE_PRINCIPAL This property can be used by Stubs and Calls to dynamically set the service principal name when trying access a service that is protected using Kerberos mechanism.
static String	WSSEC_KEYSTORE_LOCATION This property can be used for Stubs and Calls to dynamically set the location of the keystore file.
static String	WSSEC_KEYSTORE_PASSWORD This property can be used for Stubs and Calls to dynamically set the password of the keystore file.
static String	WSSEC_KEYSTORE_TYPE This property can be used for Stubs and Call to dynamically set the type keystore file.
static String	WSSEC_RECIPIENT_KEY_ALIAS This property can be used by Stubs and Calls to dynamically set the alias for key within the keystore used to encrypt type outbound message.
static String	WSSEC_SAML_ISSUER_NAME This property can be used by Stubs and Calls to dynamically set the SAML issuer name when trying access a service that is protected using SAML mechanism.
static String	WSSEC_SIG_KEY_ALIAS This property can be used by Stubs and Calls to dynamically set the alias of the key within the keystore that will be used for digital signatures.
static String	WSSEC_SIG_KEY_PASSWORD This property can be used by Stubs and Calls to dynamically set the password of the key within the keystore that will be used for digital signatures.

Field Detail

SERVICEIMPL_NAME

static final String SERVICEIMPL_NAME

A property to be set in the Properties parameter to indicate the service implementation class name when ServiceFactory.loadService() method is called.

Type: java.lang.String

See Also:

Constant Field Values

JMS_TARGET_MESSAGE_ID

static final String JMS_TARGET_MESSAGE_ID

This property can be used for Stubs and Calls to get the Message Identifier for JMS endpoints.

Type: java.lang.String

See Also:

Constant Field Values

JMS_TARGET_CORRELATION_ID

static final String JMS_TARGET_CORRELATION_ID

This property can be used for Stubs and Call to get and set the Correlation Identifier for JMS endpoints.

Type: java.lang.String

See Also:

Constant Field Values

JMS_TARGET_REPLY_TO_TOPIC_NAME

static final String JMS_TARGET_REPLY_TO_TOPIC_NAME

This property can be used for Stubs and Calls to get and set the ReplyTo topic name for JMS endpoints.

Type: java.lang.String

See Also:

Constant Field Values

JMS_TARGET_REPLY_TO_QUEUE_NAME

static final String JMS_TARGET_REPLY_TO_QUEUE_NAME

This property can be used for Stubs and Calls to get and set the ReplyTo queue name for JMS endpoints.

Type: java.lang.String

See Also:

Constant Field Values

JMS_TARGET_REPLY_TO_FACTORY_NAME

static final String JMS_TARGET_REPLY_TO_FACTORY_NAME

This property can be used for Stubs and Calls to get and set the ReplyTo factory name for JMS endpoints.

Type: java.lang.String

See Also:

Constant Field Values

JMS_TRANSPORT_REPLY_TO_QUEUE_NAME

static final String JMS_TRANSPORT_REPLY_TO_QUEUE_NAME

This property can be used for Stubs and Calls to get and set the ReplyTo queue name for a JMS transport.

Type: java.lang.String

See Also:

Constant Field Values

JMS_TRANSPORT_REPLY_TO_FACTORY_NAME

static final String JMS_TRANSPORT_REPLY_TO_FACTORY_NAME

This property can be used for Stubs and Calls to get and set the ReplyTo factory name for a JMS transport.

Type: java.lang.String

See Also:

Constant Field Values

WSM_INTERCEPTOR_PIPELINE_CONFIG

static final String WSM_INTERCEPTOR_PIPELINE_CONFIG

Deprecated. This property has been deprecated, please use oracle.webservices.ClientConstants.CLIENT_CONFIG.

Since:

10.1.3.1.0

See Also:

oracle.webservices.ClientConstants.CLIENT_CONFIG, Constant Field Values

CLIENT_CONFIG

static final String CLIENT_CONFIG

This property can be used for Stubs and Calls to get and set the Web Service Management configuration and other properties.

Type: org.w3c.Element or java.io.File

See Also:

Constant Field Values

DIME_ENCODE_MESSAGES_WITH_ATTACHMENTS

static final String DIME_ENCODE_MESSAGES_WITH_ATTACHMENTS

This property can be used for Stubs and Calls to specify whether DIME should be used to encode any attachments that are present instead of MIME. The default value is false.

Type: java.lang.Boolean

See Also:

Constant Field Values

SOAP_VERSION

static final String SOAP_VERSION

This property can be used for Stubs and Calls to get and set SOAP version. The values are defind in SOAPVersion. If not set, the default value is SOAPVersion.SOAP_1_1.

Type: java.lang.String

See Also:

Constant Field Values

DO_NOT_CHUNK

static final String DO_NOT_CHUNK

This property can be used for Stubs and Calls to specify whether chunking should be used for SOAP messages sent over HTTP. Default value is true.

Type: java.lang.Boolean

See Also:

Constant Field Values

CHUNK_SIZE

static final String CHUNK_SIZE

This property can be used for Stubs and Calls to get and set the chunk size for SOAP messages sent over HTTP. The default chunk size is 4096.

Type: java.lang.Integer

See Also:

Constant Field Values

COOKIE_MAP

static final String COOKIE_MAP

This property can be used for Stubs and Calls to get and set the Map of cookies used in a session. The key and value for entries in the map must be instances of HTTPClient.Cookie

Type: java.util.Map

See Also:

Constant Field Values

CHARACTER_SET_ENCODING

static final String CHARACTER_SET_ENCODING

This property can be used for Stubs and Calls to get and set the character encoding which will be used to serialize the request soap message. See java.nio.charset.Charset for more information about character set encoding. UTF-8 is the default when this property is not set.

Type: java.lang.String

See Also:

Constant Field Values

MTOM_SUPPORT

static final String MTOM_SUPPORT

This property can be used for Stubs to specify whether the request, when relavant content exists, will be packaged as per MTOM/XOP. Relavant content means xsd:base64Binary type. A 'true' value will cause such a request message to be packaged as per MTOM/XOP specifications. A request without relavant content will not be packaged as per MTOM/XOP even if this property has a value of 'true'. A 'false' value will have the same effect as if this is not set. The request will not be packaged as per MTOM/XOP. The default value is false.

Type: java.lang.Boolean

See Also:

Constant Field Values

PREEMPTIVE_BASIC_AUTH

static final String PREEMPTIVE_BASIC_AUTH

This property can be used for Stubs to specify whether the request should include http basic authentication header without getting a challenge from the http server. A 'true' value will cause the request message to include the basic authentication header. A 'false' value will only send the authentication header if the http server challenges for it. The default value is false.

Type: java.lang.Boolean

See Also:

Constant Field Values

MTOM_DOTNET_HEADER_STYLE

static final String MTOM_DOTNET_HEADER_STYLE

This property can be used together with "MTOM_SUPPORT" on Stubs to improve interoperability with Microsoft .Net web services with MTOM enabled. The default value is false.

Type: java.lang.Boolean

See Also:

Constant Field Values

PROXY_HOST

static final String PROXY_HOST

This property can be used for Stubs and Calls to specify the host name of the Proxy server

Type: java.lang.String

See Also:

Constant Field Values

PROXY_PORT

static final String PROXY_PORT

This property can be used for Stubs and Calls to specify the port of the proxy server

Type: java.lang.Integer

See Also:

Constant Field Values

PROXY_USERNAME

static final String PROXY_USERNAME

This property can be used for Stubs and Calls to specify the username for proxy authentication

Type: java.lang.String

See Also:

Constant Field Values

PROXY_PASSWORD

static final String PROXY_PASSWORD

This property can be used for Stubs and Calls to specify the password for proxy authentication

Type: java.lang.String

See Also:

Constant Field Values

PROXY_REALM

static final String PROXY_REALM

This property can be used for Stubs and Calls to specify the realm for proxy authentication

Type: java.lang.String

See Also:

Constant Field Values

PROXY_AUTH_TYPE

static final String PROXY_AUTH_TYPE

This property can be used for Stubs and Calls to specify the type for proxy authentication Examples of the type of authentication are basic, digest, NTLM.

Type: java.lang.String

See Also:

Constant Field Values

HTTP_READ_TIMEOUT

static final String HTTP_READ_TIMEOUT

This property can be used for Stubs and Calls to specify the read timeout value of http soap connection * in miliseconds. If a socket read operation takes longer than the specified value then an exception will be thrown. The value for this property will also used as a value for the HTTP_CONN_TIMEOUT if HTTP_CONN_TIMEOUT has not been set by the user.

Type: java.lang.Integer

See Also:

Constant Field Values

HTTP_CONN_TIMEOUT

static final String HTTP_CONN_TIMEOUT

This property can be used for Stubs and Calls to specify the connection timeout value of http soap connection in miliseconds. If a connection operatoin takes longer than the specified value then an exception will be thrown *

Type: java.lang.Integer

See Also:

Constant Field Values

DISABLE_MUST_UNDERSTAND

static final String DISABLE_MUST_UNDERSTAND

disable must understand checking for client inbound messages true: disable must understand check false (default): not disable must understand check

Type: java.lang.Boolean

See Also:

Constant Field Values

ACCEPT_ENCODING

static final String ACCEPT_ENCODING

This property can be used for Stubs and Calls to specify the value of http 'ACCEPT_ENCODING' header for SOAP messages send over HTTP. 'gzip, x-gzip, compress, x-compress' is default when this property is not set.

Type: java.lang.String

See Also:

Constant Field Values

WSSEC_KEYSTORE_TYPE

static final String WSSEC_KEYSTORE_TYPE

This property can be used for Stubs and Call to dynamically set the type keystore file. If provided, this value will override any statically configured value. Allowed Values are : "JKS", "PKCS12", "OWALLET" & "PKCS11". Default is JKS

See Also:

Constant Field Values

WSSEC_KEYSTORE_LOCATION

static final String WSSEC_KEYSTORE_LOCATION

This property can be used for Stubs and Calls to dynamically set the location of the keystore file. If provided, this value will override any statically configured value.

Type: java.lang.String

See Also:

Constant Field Values

WSSEC_KEYSTORE_PASSWORD

static final String WSSEC_KEYSTORE_PASSWORD

This property can be used for Stubs and Calls to dynamically set the password of the keystore file. If provided, this value will override any statically configured value.

Type: java.lang.String

See Also:

Constant Field Values

WSSEC_ENC_KEY_ALIAS

static final String WSSEC_ENC_KEY_ALIAS

This property can be used for Stubs and Calls to dynamically set the alias of the key within the the keystore that will be used for encryption. If provided, this value will override any statically configured value.

Type: java.lang.String

See Also:

Constant Field Values

WSSEC_ENC_KEY_PASSWORD

static final String WSSEC_ENC_KEY_PASSWORD

This property can be used for Stubs and Calls to dynamically set the password for the key within the keystore that will be used for encryption. If provided, this value will override any statically configured value.

Type: java.lang.String

See Also:

Constant Field Values

WSSEC_SIG_KEY_ALIAS

static final String WSSEC_SIG_KEY_ALIAS

This property can be used by Stubs and Calls to dynamically set the alias of the key within the keystore that will be used for digital signatures. If provided, this value will override any statically configured value.

Type: java.lang.String

See Also:

Constant Field Values

WSSEC_SIG_KEY_PASSWORD

static final String WSSEC_SIG_KEY_PASSWORD

This property can be used by Stubs and Calls to dynamically set the password of the key within the keystore that will be used for digital signatures. If provided, this value will override any statically configured value.

Type: java.lang.String

See Also:

Constant Field Values

WSSEC_RECIPIENT_KEY_ALIAS

static final String WSSEC_RECIPIENT_KEY_ALIAS

This property can be used by Stubs and Calls to dynamically set the alias for key within the keystore used to encrypt type outbound message. If provided this value will override any static configuration value.

Type: java.lang.String

See Also:

Constant Field Values

WSSEC_KERBEROS_SERVICE_PRINCIPAL

static final String WSSEC_KERBEROS_SERVICE_PRINCIPAL

This property can be used by Stubs and Calls to dynamically set the service principal name when trying access a service that is protected using Kerberos mechanism. If provided this value will override any static configuration value.

Type: java.lang.String

See Also:

Constant Field Values

WSSEC_SAML_ISSUER_NAME

static final String WSSEC_SAML_ISSUER_NAME

This property can be used by Stubs and Calls to dynamically set the SAML issuer name when trying access a service that is protected using SAML mechanism. If provided this value will override any static configuration value.

Type: java.lang.String

See Also:

Constant Field Values

PROVIDER_MSG_CONTEXT_PROPS

static final String PROVIDER_MSG_CONTEXT_PROPS

This property can be used by dispatch clients to specify a map<String,Object> of properties to be conveyed to the provider implementation during a colocation invocation.

Type: java.util.Map<String,Object>

See Also:

Constant Field Values

STREAMING_OUTGOING_ATTACHMENTS

static final String STREAMING_OUTGOING_ATTACHMENTS

This property can be set on the RequestContext of a Dispatch object and the attachments in the request SOAPMessage will be streamed to the service

Type: java.lang.Boolean

See Also:

Constant Field Values

STREAMING_INCOMING_ATTACHMENTS

static final String STREAMING_INCOMING_ATTACHMENTS

This property can be set on the RequestContext of a Dispatch object and the response SOAPMessage will have streamed attachments

Type: java.lang.Boolean

See Also:

Constant Field Values

SOAP_XML_RESPONSE

static final String SOAP_XML_RESPONSE

This property can be set on Stubs and Calls to direct client-side OraSAAJ to use Scalable DOM (SDOM) when it creates a response soap message.

See Also:

Constant Field Values

WSDL_DEFINITION

static final String WSDL_DEFINITION

This property can be set on the RequestContext of a Dispatch object in order to provide the WSDL Definition (this circumvents the inability to specify a Definition object instead of a wsdl location using the standard JAX-WS API)

See Also:

Constant Field Values

TRUST_MANAGER_ARRAY

static final String TRUST_MANAGER_ARRAY

This property can be set on the RequestContext of a Dispatch object to specify a TrustManager array to use when making https connections The value of the property must be an array of type javax.net.ssl.TrustManager This can be used to specify custom implementations of TrustManager

See Also:

Constant Field Values

WALLET_LOCATION

static final String WALLET_LOCATION

See Also:

Constant Field Values

WALLET_PASSWORD

static final String WALLET_PASSWORD

See Also:

Constant Field Values

WALLET_KEYSTORE_TYPE

static final String WALLET_KEYSTORE_TYPE

The type of keystore for this wallet - "SSO", "PKCS12", "TEXT" are valid values If not provided, defaults to "SSO"

See Also:

Constant Field Values

WALLET_KEYSTORE_PROVIDER

static final String WALLET_KEYSTORE_PROVIDER

The provider for this wallet - defaults to "OraclePKI" - for other providers, the caller will be required to register the provider using Security.addProvider(...)

See Also:

Constant Field Values

WSA_ACTION

static final String WSA_ACTION

This property can be used by Stubs and Calls to dynamically set the wsa action used in the next invocation

See Also:

Constant Field Values

WSA_MESSAGE_ID

static final String WSA_MESSAGE_ID

This property can be used by Stubs and Calls to dynamically set the wsa message id used in the next invocation

See Also:

Constant Field Values

WSA_REPLY_TO

static final String WSA_REPLY_TO

This property can be used by Stubs and Calls to dynamically set the replyTo address used in the next invocation

See Also:

Constant Field Values

WSA_FAULT_TO

static final String WSA_FAULT_TO

This property can be used by Stubs and Calls to dynamically set the faultTo address used in the next invocation

See Also:

Constant Field Values

WSA_RELATES_TO

static final String WSA_RELATES_TO

This property can be used by Stubs and Calls to dynmaically set the relatesTo address used in the next invocation

See Also:

Constant Field Values

TRANSACTIONAL

static final String TRANSACTIONAL

This property can be used to enable WS-AtomicTransactions context outflow (for JAX-WS clients only)

See Also:

Constant Field Values

ALL_OPERATIONS_ONE_WAY

static final String ALL_OPERATIONS_ONE_WAY

This property can be used by Stubs to determine if all the operations in a port are one-way

See Also:

Constant Field Values

JAXRPC_STUB_INSTANCE

static final String JAXRPC_STUB_INSTANCE

This property can be used to get the Stub instance from the message context during Stub based client runtime

See Also:

Constant Field Values

WSM_SUBJECT_PRECEDENCE

static final String WSM_SUBJECT_PRECEDENCE

This property will be set to false in case the client wants that while creating the SAML token we should not use the SUBJECT that has been formed and instead they want to use the username first that has been sent by the client.

See Also:

Constant Field Values

Skip navigation links