cCXF – Docs for ESB 5.x

Component Family

Messaging

Function

cCXF provides integration with
Apache CXF for connecting to JAX-WS services.

Purpose

cCXF is used to provide or consume
Web services.

Basic settings

Service/Address

The service endpoint URL where the Web service is provided.

In case cCXF is used to consume a
Web service and the endpoint lookup shall use the Service Locator
(the Use Service Locator check box
is selected), the URL needs to be
"locator://anyAddress/".

Service/Type

Select which type you want to use to provide Web service. Either
wsdlURL or serviceClass.

wsdlURL: Select this type to
provide the Web service from a WSDL file. Choose Repository or File to provide the Web service from a Route
Resource or the file system.

serviceClass: Select this type to
provide the Web service from an SEI (Service Endpoint Interface)
Java class.

Service/WSDL File

This field appears when the wsdlURL service type is selected. If the WSDL file
is from the file system, browse to or enter the path to the WSDL
file. If the WSDL file is from a Route Resource, click […] and select the one you want from
the Resources tree view. The Version list appears allowing you to choose from all
the versions of the Route Resource.

Service/Service configuration

This option appears when wsdlURL
is selected in the Type list. It
allows you to configure the service endpoint information
conveniently. Click […] to open
the service configuration wizard.

The WSDL field in the wizard is
filled in with the WSDL file defined in the WSDL File field automatically. You can also set the
WSDL file directly in the service configuration wizard in one of the
following ways:

After setting the WSDL file, click to show the port(s) and operation(s) available
in the Port Name and Operation boxes respectively. Select the
one you want to use and click Finish. The Operation box only shows when the cCXF component is used to consume a Web
service.

Service/Service Class

This field appears when the serviceClass service type is selected. Enter the
name of the service class to be used to provide the Web service.

Service/Dataformat

The exchange data style. POJO,
PAYLOAD, RAW, or CXF_MESSAGE.

POJOs (Plain Old Java Objects)
are the Java parameters to the method being invoked on the target
server.

PAYLOAD is the message payload,
the contents of the soap:body.

RAW is the raw message that is
received from the transport layer without SAM (Service Activity
Monitor) support.

CXF_MESSAGE is the raw message
that is received from the transport layer with SAM support.

Operation Name

The operation name this service is implementing. It maps to the
wsdl:operation@name, in the format of
ns:OPERATION_NAME where ns is a
namespace prefix valid at this scope. This option appears when the
cCXF component is used consume
a Web service. This field gets filled in automatically upon
completion of the Service
configuration.

Use Service Registry

This option is only available if you subscribed to Talend Enterprise
ESB solutions.

Select this check box to enable the service registry. It provides
dynamic endpoint lookup and allows services to be redirected based
upon information retrieved from the registry. It works in Runtime
only.

When the cCXF component is used
to provide a Web service, the service deployed in Runtime will work
with the service registry.

When the cCXF component is used
to consume a Web service:

In the Correlation Value field,
specify a correlation ID or leave this field empty. For more
information, see the Use Business
Correlation option.

In the Username and the Password fields, enter the authentication
credentials. To enter the password, click the […] button next to the password field, and then in
the pop-up dialog box enter the password between double quotes and
click OK to save the
settings.

If SAML token is registered in the service registry, you need to
specify the client’s role in the Role field. You can also select the Propagate Credentials check box to make
the call on behalf of an already authenticated user by propagating
the existing credentials. You can enter the username and the
password to authenticate with STS to propagate credentials using
username and password, or provide the alias, username and the
password to propagate using certificate. For more information, see
the Use Authentication
option.

For more information about how to set up and use the Service
Registry, see the Talend Administration Center User Guide and Talend ESB Infrastructure
Services Configuration Guide.

Provides service consumers with a mechanism to discover service
endpoints at runtime without specifying the physical location of the
endpoint. Additionally, it allows service providers to automatically
register and unregister their service endpoints at the Service
Locator.

The Custom Properties table
appears when the Use Service
Locator check box is selected. Click to add as many properties as needed to the
table. Enter the name and the value of each property in the
Property Name field and the
Property Value field
respectively to identify the service. For more information, see
Talend ESB Infrastructure
Services Configuration Guide for how to install and
configure the Service Locator.

Captures events and stores this information to facilitate in-depth
analysis of service activity and track-and-trace of messages
throughout a business transaction. This can be used to analyze
service response times, identify traffic patterns, perform root
cause analysis and more.

This feature is not supported when MESSAGE is used as the processing mode. When
MESSAGE is selected in the
Dataformat field, the Use Service Activity Monitor check box is
disabled.

This option is also disabled when the Use
Service Registry check box is selected if you
subscribed to Talend Enterprise ESB solutions.

Select this check box to enable the authentication option. Select
from Username Token, SAML Token (ESB runtime only), HTTP Basic, and HTTP Digest.

When the cCXF component is used
to produce a Web service, authentication with the Username Token, SAML token, and HTTP
Basic work in runtime only. HTTP Digest is not supported. When SAML Token (ESB runtime only) is
selected, cCXF will get the SAML
Token from the request header for further use in the message
routing.

When the cCXF component is used
to consume a Web service, authentication with the Username Token, HTTP Basic, and HTTP
Digest work in both the studio and runtime.
Authentication with the SAML token
works in runtime only. Enter a username and a password in the
corresponding fields as required. To enter the password, click the
[…] button next to the
password field, and then in the pop-up dialog box enter the password
between double quotes and click OK
to save the settings.

When SAML Token (ESB runtime
only) is selected, you can either provide the user
credentials to send the request or make the call on behalf of an
already authenticated user by propagating the existing credentials.
Select from:

–: Enter the username and the
password in the corresponding fields to access the service.

Propagate using U/P: Enter the
user name and the password used to authenticate via STS.

Propagate using Certificate:
Enter the alias and the password used to authenticate via
STS.

This check box disappears when the Use
Service Registry check box is selected.

Use Authorization

This option is only available if you subscribed to Talend Enterprise
ESB solutions. It appears when SAML Token (ESB
runtime only) is selected in the Use Authentication list.

When the cCXF component is used
to provide a Web service, select this check box to enable
authorization.

When the cCXF component is used
to consume a Web service, select this check box to invoke authorized
call and specify the client’s role in the Role field.

For more information about the management of user roles and
rights, see the Talend Administration Center User Guide and Talend ESB Infrastructure Services Configuration
Guide.

Use Business Correlation

Select this check box to enable the correlation option so that
chained service calls will be grouped under the same correlation
ID.

When cCXF is used to provide a
Web service:

cCXF will extract the correlation
ID from the request message.

If the request message does not contain a correlation ID, the
provider will create a correlation ID automatically in the SOAP
header.

When cCXF is used to consume a
Web service:

You can specify a correlation ID in the Correlation Value field using a string or a simple
expression. If you leave this field empty, this value will be
generated automatically at runtime. The correlation ID will be
created in the custom SOAP header of the request message and passed
on to the service it calls.

This check box disappears when the Use
Service Registry check box is selected or RAW is selected in the Dataformat list.

Usage

cCXF can be a start, middle or
end component in a Route.

Limitation

Due to the license incompatibility, one or more JAR files required to use this component are
not provided. You can install these missing JAR files by clicking the Install button in the Basic settings view
of the Component tab. For more information, see the section
about how to configure the Studio of the Talend Installation and Upgrade Guide.

 Multiple cCXF components with
the same label in a Route is not supported.

When cCXF is used to consume a
Web service, if you use the CXF_MESSAGE data format, the request body type need
to be javax.xml.transform.Source.class, or the request
body will be empty.

For simple proxy use cases, for example, from cCXF to cProcessor to cCXF,
if you use the RAW data format, the
request body will be reset. If it is printed by cProcessor, the output request body will
be empty.

When cCXF is used to consume a
Web service and the data format is POJO, PAYLOAD, or
CXF_MESSAGE, if fault response
is returned the message routing will stop. In this case, it is
recommended to use the cErrorHandler component to catch the fault message.
For more information about cErrorHandler, see cErrorHandler.