Whatever message this page gives is out now! Go check it out!

cfobject: web service object

Last update:
May 18, 2026

Description

Creates a web service proxy object.

Syntax

name = "local name">
webservice= "service identifier"
password = "string"
proxyPassword = "string"
proxyPort = "port number"
proxyServer = "URL or IP address"
proxyUser = "string"
refreshWSDL = "no|yes"
type = "webservice"
username = "string"
wsdl2javaArgs = "argument string"
wsportname = "port name"
wsversion = "version of the axis to be used" >
Note:
You can specify this tag's attributes in an attributeCollection attribute whose value is a structure. Specify the structure name in the attributeCollection attribute and use the tag's attribute names as structure keys.

Using NTLM attributes

Note:
The ntlmDomain is required when authType=NTLM.
When a user is part of a domain, the ntlmDomain attribute is mandatory. When a user is not part of a domain, the ntlmDomain attribute is not mandatory.

See also

cfcollection, cfexecute, cfindex, cfreport, cfsearch, cfwddx; Consuming web services in Using Web Services in the Developing ColdFusion Applications

History

See the History section of the main cfobject tag page.

Attributes

Attribute
Req/Opt
Default
Description
name
Required
Local name for the web service. String.
webservice
Required
One of the following:
  • The absolute URL of the web service.
  • The name (string) assigned in the ColdFusion Administrator to the web service.
password
Optional
Password set in the Administrator, if any
The password to use to access the web service. If the webservice attribute specifies a web service name configured in the ColdFusion Administrator, overrides any password specified in the Administrator entry.
proxyPassword
Optional
http.proxyPassword system property, if any
The user's password on the proxy server.
proxyPort
Optional
http.proxyPort system property, if any.
The port to use on the proxy server.
proxyServer
Optional
http.proxyHost system property, if any.
The proxy server required to access the web service URL.
proxyUser
Optional
http.proxyUser system property, if any
The user ID to send to the proxy server.
refreshWSDL
Optional
no
  • yes: reloads the WSDL file and regenerates the artifacts used to consume the web service
  • no
type
Optional
The object type. You can omit this attribute or specify webservice.
username
Optional
User name set in the Administrator, if any
The user name to use to access the web service. If the webservice attribute specifies a web service configured name in the ColdFusion Administrator, overrides any user name specified in the Administrator entry.
wsdl2javaArgs
Optional
A string that contains a space-delimited list of arguments to pass to the WSDL2Java tool that generates Java stubs for the web services. Useful arguments include the following:
  • W or -noWrapped: turns off the special treatment of wrapped document/literal style operations.
  • a or -all: generates code for all elements in the WSDL, even unreferenced ones.
  • w or -wrapArrays: prefers building beans to straight arrays for wrapped XML array types. This switch is not in included in the Axis documentation. For detailed information on valid arguments, see the Apache Axis WSDL2Java Reference.
wsportname
Optional
First port in the WSDL
The port name for the web service. This value is case sensitive and corresponds to the port element's name attribute under the service element.Specify this parameter if the web service contains multiple ports.
wsversion
Optional
Specifies version of the axis to be used. If the wsversion is specified as "1", then axis 1 will be used. If it is "2", then axis 2 will be used.

Usage

Instantiates a proxy object for a web service. You can enter the absolute URL in this tag, or refer to a web service that is entered in the ColdFusion Administrator. To minimize potential code maintenance, enter the web service in the Administrator, and then refer to that name in this tag.

Share this page

Was this page helpful?
We're glad. Tell us how this page helped.
We're sorry. Can you tell us what didn't work for you?
Thank you for your feedback. Your response will help improve this page.

On this page