3:37 p.m.
Author: shawkins
Date: 2010-09-02 16:37:25 -0400 (Thu, 02 Sep 2010)
New Revision: 2523
Modified:
branches/7.1.x/build/kits/jboss-container/teiid-releasenotes.html
branches/7.1.x/connectors/connector-ws/src/main/java/org/teiid/resource/adapter/ws/WSManagedConnectionFactory.java
branches/7.1.x/connectors/connector-ws/src/main/rar/META-INF/ra.xml
branches/7.1.x/documentation/admin-guide/src/main/docbook/en-US/content/vdb-deployment.xml
Log:
TEIID-1238 TEIID-1103 adding docs on using cxf to configure the http transport and
renaming ws resource adapter properties.
Modified: branches/7.1.x/build/kits/jboss-container/teiid-releasenotes.html
===================================================================
--- branches/7.1.x/build/kits/jboss-container/teiid-releasenotes.html 2010-09-02 19:54:14
UTC (rev 2522)
+++ branches/7.1.x/build/kits/jboss-container/teiid-releasenotes.html 2010-09-02 20:37:25
UTC (rev 2523)
@@ -71,12 +71,15 @@
<h2><a name="Configuration">Configuration
Issues</a></h2>
-See the See the <a href="teiid-docs/teiid_admin_guide.pdf">Admin
Guide</a> for more on configuration and installation.
+See the <a href="teiid-docs/teiid_admin_guide.pdf">Admin Guide</a>
for more on configuration and installation.
<h4>from 7.1</h4>
<ul>
<li>Apache CXF is now expected to be used as the web services stack provider
through JBossWS-CXF. See the Admin Guide for instructions on
- installing CXF for use with Teiid's Salesforce and web service connectors.
+ installing CXF for use with Teiid's Salesforce and web service connectors. The WS
Resource Adapter's -ds.xml files should no longer use
+ WSSecurityConfigURL and WSSecurityConfigName, rather they should be ConfigFile and
ConfigName respectively. The property values should no longer
+ refer to jboss-wsse-client.xml, but instead they should reference a CXF Spring
configuration file and particular port configuration. See the Admin Guide
+ for more on using CXF configuration files.
<li>The default for data role checking is now "true". However only VDBs
with data roles will have roles enforced.
<li>The default prepared plan cache size was increased to 512, since it is
targeted by internal plans as well.
</ul>
Modified:
branches/7.1.x/connectors/connector-ws/src/main/java/org/teiid/resource/adapter/ws/WSManagedConnectionFactory.java
===================================================================
---
branches/7.1.x/connectors/connector-ws/src/main/java/org/teiid/resource/adapter/ws/WSManagedConnectionFactory.java 2010-09-02
19:54:14 UTC (rev 2522)
+++
branches/7.1.x/connectors/connector-ws/src/main/java/org/teiid/resource/adapter/ws/WSManagedConnectionFactory.java 2010-09-02
20:37:25 UTC (rev 2523)
@@ -46,8 +46,8 @@
private String endPoint;
private String securityType = SecurityType.None.name(); // None, HTTPBasic, WS-Security
- private String wsSecurityConfigURL; // path to the "jboss-wsse-client.xml"
file
- private String wsSecurityConfigName; // ws-security config name in the above file
+ private String configFile; // path to the "jbossws-cxf.xml" file
+ private String configName; // config name in the above file
private String authPassword; // httpbasic - password
private String authUserName; // httpbasic - username
@@ -57,13 +57,13 @@
@Override
public BasicConnectionFactory createConnectionFactory() throws ResourceException {
- String configName = getWsSecurityConfigName();
+ String configName = getConfigName();
if (configName == null) {
configName = WSConnectionImpl.DEFAULT_LOCAL_NAME;
}
this.portQName = new QName(WSConnectionImpl.DEFAULT_NAMESPACE_URI, configName);
- if (wsSecurityConfigURL != null) {
- bus = new SpringBusFactory().createBus(wsSecurityConfigURL);
+ if (configFile != null) {
+ bus = new SpringBusFactory().createBus(configFile);
JaxWsClientFactoryBean instance = new JaxWsClientFactoryBean();
Configurer configurer = bus.getExtension(Configurer.class);
if (null != configurer) {
@@ -111,20 +111,20 @@
this.securityType = securityType;
}
- public String getWsSecurityConfigURL() {
- return wsSecurityConfigURL;
+ public String getConfigFile() {
+ return configFile;
}
- public void setWsSecurityConfigURL(String wsSecurityConfigURL) {
- this.wsSecurityConfigURL = wsSecurityConfigURL;
+ public void setConfigFile(String config) {
+ this.configFile = config;
}
- public String getWsSecurityConfigName() {
- return wsSecurityConfigName;
+ public String getConfigName() {
+ return configName;
}
- public void setWsSecurityConfigName(String wsSecurityConfigName) {
- this.wsSecurityConfigName = wsSecurityConfigName;
+ public void setConfigName(String configName) {
+ this.configName = configName;
}
public Bus getBus() {
Modified: branches/7.1.x/connectors/connector-ws/src/main/rar/META-INF/ra.xml
===================================================================
--- branches/7.1.x/connectors/connector-ws/src/main/rar/META-INF/ra.xml 2010-09-02
19:54:14 UTC (rev 2522)
+++ branches/7.1.x/connectors/connector-ws/src/main/rar/META-INF/ra.xml 2010-09-02
20:37:25 UTC (rev 2523)
@@ -66,14 +66,14 @@
</config-property>
<config-property>
- <description>{$display:"URL to the WS-Security Configuration
File(typically jbossws-cxf.xml)",$description:"CXF client configuration
File"}</description>
-
<config-property-name>WsSecurityConfigURL</config-property-name>
+ <description>{$display:"CXF Configuration
File",$description:"CXF client configuration File or
URL"}</description>
+ <config-property-name>ConfigFile</config-property-name>
<config-property-type>java.lang.String</config-property-type>
</config-property>
<config-property>
- <description>{$display:"WS-Security Configuration
Name",$description:"Local name of the QName of the port configuration to use
with this connection. The port namespace URI should be
http://teiid.org"}</description>
-
<config-property-name>WsSecurityConfigName</config-property-name>
+ <description>{$display:"Configuration
Name",$description:"Local name of the QName of the port configuration to use
with this connection. The port namespace URI should be
http://teiid.org"}</description>
+ <config-property-name>ConfigName</config-property-name>
<config-property-type>java.lang.String</config-property-type>
</config-property>
Modified:
branches/7.1.x/documentation/admin-guide/src/main/docbook/en-US/content/vdb-deployment.xml
===================================================================
---
branches/7.1.x/documentation/admin-guide/src/main/docbook/en-US/content/vdb-deployment.xml 2010-09-02
19:54:14 UTC (rev 2522)
+++
branches/7.1.x/documentation/admin-guide/src/main/docbook/en-US/content/vdb-deployment.xml 2010-09-02
20:37:25 UTC (rev 2523)
@@ -145,16 +145,25 @@
</no-tx-connection-factory>
</connection-factories>]]></programlisting></example>
<section>
- <title>WS-Security</title>
+ <title>CXF Configuration</title>
+ <para>Each web service data source may choose a particular CXF config file and
port configuration.
+ The <code>ConfigFile</code> config property specifies the Spring XML
configuration
+ file for the CXF Bus and port configuration to be used by connections.
+ If no config file is specified then the system default configuration will be
used.</para>
- <para>To enable the use of WS-Security, the
<code>SecurityType</code> should be set to WSSecurity.
- The <code>WsSecurityConfigURL</code> config property may then be used to
supply the Spring XML configuration
- file for the CXF Bus and port configuration to be used by these connections. At this
time however, Teiid does not expect or use
- a WSDL to describe the service being used. Thus the Spring XML configuration file is
not an adjunct
- to policy information in the WSDL, it must instead contain all of the relevant policy
configuration. It is also expected that only
- 1 port configuration will be used by this data source. You may explicitly set the
local name of the port QName to use via the
- <code>WsSecurityConfigName</code>. The namespace URI for the QName
should be http://teiid.org.</para>
+ <para>Only 1 port configuration can be used by this data source. You may
explicitly set the local name of the port QName to use via the
+ <code>ConfigName</code> property. The namespace URI for the QName in
your config file should be http://teiid.org.
+ See the sections on WS-Security, Logging, etc. for examples of using the CXF
configuration file.</para>
+ <para>See the <ulink url="http://cxf.apache.org/docs/">CXF
documentation</ulink> for all possible configuration options.</para>
+ <note><para>The CXF configuration is currently only applicable to
non-binary web service calls.</para></note>
+ </section>
+ <section>
+ <title>WS-Security</title>
+ <para>To enable the use of WS-Security, the
<code>SecurityType</code> should be set to WSSecurity.
+ At this time Teiid does not expect a WSDL to describe the service being used.
+ Thus a Spring XML configuration file is not only required, it must instead contain
all of the relevant policy configuration.
+ And just as with the general configuration, each data source is limited to specifing
only a single port configration to use.</para>
<example>
<title>Example WS-Security enabled data source</title>
<programlisting><![CDATA[<?xml version="1.0"
encoding="UTF-8"?>
@@ -164,8 +173,8 @@
<rar-name>teiid-connector-ws.rar</rar-name>
<connection-definition>javax.resource.cci.ConnectionFactory</connection-definition>
<config-property
name="EndPoint">http://somewhere.com</config-property>
- <config-property
name="WsSecurityConfigURL">${jboss.server.home.dir}/server/default/conf/xxx-jbossws-cxf.xml</config-property>
- <config-property
name="WsSecurityConfigName">port_x</config-property>
+ <config-property
name="ConfigFile">${jboss.server.home.dir}/server/default/conf/xxx-jbossws-cxf.xml</config-property>
+ <config-property name="ConfigName">port_x</config-property>
<config-property
name="SecurityType">WSSecurity</config-property>
</no-tx-connection-factory>
</connection-factories>]]></programlisting>
@@ -206,10 +215,7 @@
</section>
<section>
<title>Logging</title>
- <para>Even when not using WS-Security, the
<code>WsSecurityConfigURL</code> config property may then be used to supply
the Spring XML configuration
- file. Logging of requests and responses may be enabled for the entire bus or for
specific port configurations.
- If a specific port configuration is used, just as with WS-Security, the local name of
the port
- QName should match <code>WsSecurityConfigName</code> and the namespace
URI should be http://teiid.org.</para>
+ <para>The CXF config property may also be used to control the logging of
requests and responses for specific or all ports. Logging, when enabled, will be
performed at an INFO level to the org.apache.cxf.interceptor context.</para>
<example>
<title>Example logging data source</title>
<programlisting><![CDATA[<?xml version="1.0"
encoding="UTF-8"?>
@@ -219,8 +225,8 @@
<rar-name>teiid-connector-ws.rar</rar-name>
<connection-definition>javax.resource.cci.ConnectionFactory</connection-definition>
<config-property
name="EndPoint">http://somewhere.com</config-property>
- <config-property
name="WsSecurityConfigURL">${jboss.server.home.dir}/server/default/conf/xxx-jbossws-cxf.xml</config-property>
- <config-property
name="WsSecurityConfigName">port_y</config-property>
+ <config-property
name="ConfigFile">${jboss.server.home.dir}/server/default/conf/xxx-jbossws-cxf.xml</config-property>
+ <config-property name="ConfigName">port_y</config-property>
</no-tx-connection-factory>
</connection-factories>]]></programlisting>
<para>Corresponding xxx-jbossws-cxf.xml</para>
@@ -241,8 +247,29 @@
</beans>]]></programlisting>
</example>
- <para>Logging is then performed at an INFO level to the
org.apache.cxf.interceptor context. Logging is only performed for non-binary web service
calls.</para>
</section>
+ <section>
+ <title>Transport Settings</title>
+ <para>The CXF config property may also be used to control low level aspects of
the HTTP transport. See the <ulink
url="http://cxf.apache.org/docs/client-http-transport-including-ssl-...
documentation</ulink> for all possible options.</para>
+ <example>
+ <title>Example Disabling Hostname Verification</title>
+<programlisting><![CDATA[<beans
xmlns="http://www.springframework.org/schema/beans"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xmlns:http-conf="http://cxf.apache.org/transports/http/configuration...
+ xsi:schemaLocation="http://cxf.apache.org/transports/http/configuration
+ http://cxf.apache.org/schemas/configuration/http-conf.xsd
+ http://www.springframework.org/schema/beans
+
http://www.springframework.org/schema/beans/spring-beans.xsd">
+
+ <http-conf:conduit name="{http://teiid.org}port_z.http-conduit">
+ <!-- WARNING ! disableCNcheck=true should NOT be used in production -->
+ <http-conf:tlsClientParameters disableCNcheck="true" />
+
+ </http-conf:conduit>
+</beans>
+]]></programlisting>
+</example>
+ </section>
</section>
<section>