[teiid-commits] teiid SVN: r2221 - in trunk/documentation: client-developers-guide and 9 other directories.

Author: rareddy Date: 2010-06-11 12:44:33 -0400 (Fri, 11 Jun 2010) New Revision: 2221 Added: trunk/documentation/connector-developer-guide/src/main/docbook/en-US/content/appendix-b.xml trunk/documentation/connector-developer-guide/src/main/docbook/en-US/content/logging.xml trunk/documentation/connector-developer-guide/src/main/docbook/en-US/content/security.xml trunk/documentation/connector-developer-guide/src/main/docbook/en-US/main.xml Removed: trunk/documentation/connector-developer-guide/src/main/docbook/en-US/connector_developer_guide.xml trunk/documentation/server-extensions-guide/src/main/docbook/en-US/content/appendix-a.xml trunk/documentation/server-extensions-guide/src/main/docbook/en-US/content/logging.xml trunk/documentation/server-extensions-guide/src/main/docbook/en-US/content/security.xml Modified: trunk/documentation/admin-guide/pom.xml trunk/documentation/client-developers-guide/pom.xml trunk/documentation/connector-developer-guide/pom.xml trunk/documentation/quick-start-example/pom.xml trunk/documentation/reference/pom.xml trunk/documentation/salesforce-connector-guide/pom.xml trunk/documentation/server-extensions-guide/pom.xml trunk/documentation/server-extensions-guide/src/main/docbook/en-US/server_extensions_guide.xml Log: TEIID-1120: Single HTML Page Modified: trunk/documentation/admin-guide/pom.xml =================================================================== --- trunk/documentation/admin-guide/pom.xml 2010-06-11 00:22:28 UTC (rev 2220) +++ trunk/documentation/admin-guide/pom.xml 2010-06-11 16:44:33 UTC (rev 2221) @@ -19,6 +19,11 @@ <extensions>true</extensions> <dependencies> <dependency> + <groupId>net.sf.docbook</groupId> + <artifactId>docbook</artifactId> + <version>1.74.0</version> + </dependency> + <dependency> <groupId>org.jboss</groupId> <artifactId>jbossorg-docbook-xslt</artifactId> <version>1.1.0</version> @@ -47,11 +52,11 @@ <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource> <finalName>teiid_admin_guide.pdf</finalName> </format> - <!-- <format> + <format> <formatName>html_single</formatName> <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource> <finalName>index.html</finalName> - </format> --> + </format> <format> <formatName>html</formatName> <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource> @@ -60,6 +65,8 @@ </formats> <options> <xincludeSupported>true</xincludeSupported> + <xmlTransformerType>saxon</xmlTransformerType> + <docbookVersion>1.72.0</docbookVersion> <localeSeparator>-</localeSeparator> <useRelativeImageUris>false</useRelativeImageUris> </options> Modified: trunk/documentation/client-developers-guide/pom.xml =================================================================== --- trunk/documentation/client-developers-guide/pom.xml 2010-06-11 00:22:28 UTC (rev 2220) +++ trunk/documentation/client-developers-guide/pom.xml 2010-06-11 16:44:33 UTC (rev 2221) @@ -19,6 +19,11 @@ <extensions>true</extensions> <dependencies> <dependency> + <groupId>net.sf.docbook</groupId> + <artifactId>docbook</artifactId> + <version>1.74.0</version> + </dependency> + <dependency> <groupId>org.jboss</groupId> <artifactId>jbossorg-docbook-xslt</artifactId> <version>1.1.0</version> @@ -47,11 +52,11 @@ <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource> <finalName>client_developers_guide.pdf</finalName> </format> - <!-- <format> + <format> <formatName>html_single</formatName> <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource> <finalName>index.html</finalName> - </format> --> + </format> <format> <formatName>html</formatName> <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource> @@ -60,6 +65,8 @@ </formats> <options> <xincludeSupported>true</xincludeSupported> + <xmlTransformerType>saxon</xmlTransformerType> + <docbookVersion>1.72.0</docbookVersion> <localeSeparator>-</localeSeparator> <useRelativeImageUris>false</useRelativeImageUris> </options> Modified: trunk/documentation/connector-developer-guide/pom.xml =================================================================== --- trunk/documentation/connector-developer-guide/pom.xml 2010-06-11 00:22:28 UTC (rev 2220) +++ trunk/documentation/connector-developer-guide/pom.xml 2010-06-11 16:44:33 UTC (rev 2221) @@ -19,6 +19,11 @@ <extensions>true</extensions> <dependencies> <dependency> + <groupId>net.sf.docbook</groupId> + <artifactId>docbook</artifactId> + <version>1.74.0</version> + </dependency> + <dependency> <groupId>org.jboss</groupId> <artifactId>jbossorg-docbook-xslt</artifactId> <version>1.1.0</version> @@ -31,7 +36,7 @@ </dependency> </dependencies> <configuration> - <sourceDocumentName>connector_developer_guide.xml</sourceDocumentName> + <sourceDocumentName>main.xml</sourceDocumentName> <imageResource> <directory>${basedir}/src/main/docbook/en-US</directory> <excludes> @@ -47,11 +52,11 @@ <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource> <finalName>connector_developer_guide.pdf</finalName> </format> - <!-- <format> + <format> <formatName>html_single</formatName> <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource> <finalName>index.html</finalName> - </format> --> + </format> <format> <formatName>html</formatName> <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource> @@ -60,6 +65,8 @@ </formats> <options> <xincludeSupported>true</xincludeSupported> + <xmlTransformerType>saxon</xmlTransformerType> + <docbookVersion>1.72.0</docbookVersion> <localeSeparator>-</localeSeparator> <useRelativeImageUris>false</useRelativeImageUris> </options> Deleted: trunk/documentation/connector-developer-guide/src/main/docbook/en-US/connector_developer_guide.xml =================================================================== --- trunk/documentation/connector-developer-guide/src/main/docbook/en-US/connector_developer_guide.xml 2010-06-11 00:22:28 UTC (rev 2220) +++ trunk/documentation/connector-developer-guide/src/main/docbook/en-US/connector_developer_guide.xml 2010-06-11 16:44:33 UTC (rev 2221) @@ -1,58 +0,0 @@ -<?xml version='1.0' encoding="UTF-8"?> -<!-- - - JBoss, Home of Professional Open Source. - Copyright (C) 2008 Red Hat, Inc. - Licensed to Red Hat, Inc. under one or more contributor - license agreements. See the copyright.txt file in the - distribution for a full listing of individual contributors. - - This library is free software; you can redistribute it and/or - modify it under the terms of the GNU Lesser General Public - License as published by the Free Software Foundation; either - version 2.1 of the License, or (at your option) any later version. - - This library is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General Public - License along with this library; if not, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA - 02110-1301 USA. - ---> -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ -<!ENTITY % CustomDTD SYSTEM "../../../../../docbook/custom.dtd"> -%CustomDTD; -]> - -<book> - - <bookinfo> - <title>Teiid - Scalable Information Integration</title> - <subtitle>Teiid Translator and Resource Adapter Developer's Guide</subtitle> - <releaseinfo>&versionNumber;</releaseinfo> - <productnumber>&versionNumber;</productnumber> - <issuenum>1</issuenum> - <copyright> - <year>&copyrightYear;</year> - <holder>&copyrightHolder;</holder> - </copyright> - <xi:include href="../../../../../docbook/en-US/legal_notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - </bookinfo> - - <toc/> - - <xi:include href="content/introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="content/develop-adapter.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="content/connector-api.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="content/command-language.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="content/lob-support.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="content/extending-jdbc-connector.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="content/jdbc-translator-examples.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="content/appendix-a.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - -</book> - Copied: trunk/documentation/connector-developer-guide/src/main/docbook/en-US/content/appendix-b.xml (from rev 2217, trunk/documentation/server-extensions-guide/src/main/docbook/en-US/content/appendix-a.xml) =================================================================== --- trunk/documentation/connector-developer-guide/src/main/docbook/en-US/content/appendix-b.xml (rev 0) +++ trunk/documentation/connector-developer-guide/src/main/docbook/en-US/content/appendix-b.xml 2010-06-11 16:44:33 UTC (rev 2221) @@ -0,0 +1,23 @@ +<appendix id="advanced_topics"> + <title>Advanced Topics</title> + <sect1> + <title>Migration From Previous Versions</title> + <para>It is recommended that customers who have utilized the internal JDBC membership domain from releases + prior to MetaMatrix 5.5 migrate those users and groups to an LDAP compliant directory server.  Several free + and open source directory servers can be used including:</para> + <para> + The Fedora Directory Server + <ulink url="http://directory.fedoraproject.org/">http://directory.f... + </para> + <para> + Open LDAP + <ulink url="http://www.openldap.org/">http://www.openldap.org/</... + </para> + <para> + Apache Directory Server + <ulink url="http://directory.apache.org/">http://directory.apache.o... + </para> + <para>If there are additional questions or the need for guidance in the migration process, please contact + technical support.</para> + </sect1> +</appendix> \ No newline at end of file Copied: trunk/documentation/connector-developer-guide/src/main/docbook/en-US/content/logging.xml (from rev 2217, trunk/documentation/server-extensions-guide/src/main/docbook/en-US/content/logging.xml) =================================================================== --- trunk/documentation/connector-developer-guide/src/main/docbook/en-US/content/logging.xml (rev 0) +++ trunk/documentation/connector-developer-guide/src/main/docbook/en-US/content/logging.xml 2010-06-11 16:44:33 UTC (rev 2221) @@ -0,0 +1,278 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % CustomDTD SYSTEM "../../../../../../docbook/custom.dtd"> +%CustomDTD; +]> +<chapter id="logging"> + <title>Logging</title> + <sect1 id="general_logging"> + <title>General Logging</title> + <para> + The Teiid system provides a wealth of information via logging. To + control logging level, contexts, and log locations, you should be + familiar with + <ulink url="http://logging.apache.org/log4j/">log4j</ulink> + and the container's jboss-log4j.xml configuration file. + Teiid also provides a &lt;profile&gt;/conf/jboss-teiid-log4j.xml containing much of information from chapter. + </para> + <para> + All the logs + produced by Teiid are prefixed by org.teiid. This + makes it extremely + easy to control of of Teiid logging from a single + context. Note however that changes to the log configuration file + require a restart to take affect + </para> + <sect2> + <title>Logging Contexts</title> + <para>While all of Teiid's logs are prefixed with org.teiid, there + are more specific contexts depending on the functional area of the + system. Note that logs originating from third-party code, including + integrated org.jboss components, will be logged through their + respective contexts and not through org.teiid. See the table below for information on contexts + relevant to Teiid. See the container's jboss-log4j.xml for a more + complete listing of logging contexts used in the container. + </para> + <informaltable frame="all"> + <tgroup cols="2"> + <thead> + <row> + <entry> + <para>Context</para> + </entry> + <entry> + <para>Description</para> + </entry> + </row> + </thead> + <tbody> + <row> + <entry> + <para>com.arjuna</para> + </entry> + <entry> + <para>Third-party transaction manager. This will include + information about all transactions, not just those for Teiid. + </para> + </entry> + </row> + <row> + <entry> + <para>org.teiid</para> + </entry> + <entry> + <para>Root context for all Teiid logs. Note: there are + potentially other contexts used under org.teiid than are shown + in this table.</para> + </entry> + </row> + <row> + <entry> + <para>org.teiid.PROCESSOR</para> + </entry> + <entry> + <para>Query processing logs. See also org.teiid.PLANNER for + query planning logs.</para> + </entry> + </row> + <row> + <entry> + <para>org.teiid.PLANNER</para> + </entry> + <entry> + <para>Query planning logs.</para> + </entry> + </row> + <row> + <entry> + <para>org.teiid.SECURITY</para> + </entry> + <entry> + <para>Session/Authentication events - see also AUDIT logging</para> + </entry> + </row> + <row> + <entry> + <para>org.teiid.TRANSPORT</para> + </entry> + <entry> + <para>Events related to the socket transport.</para> + </entry> + </row> + <row> + <entry> + <para>org.teiid.RUNTIME</para> + </entry> + <entry> + <para>Events related to work management and system start/stop.</para> + </entry> + </row> + <row> + <entry> + <para>org.teiid.CONNECTOR</para> + </entry> + <entry> + <para>Connector logs.</para> + </entry> + </row> + <row> + <entry> + <para>org.teiid.BUFFER_MGR</para> + </entry> + <entry> + <para>Buffer and storage management logs.</para> + </entry> + </row> + <row> + <entry> + <para>org.teiid.TXN_LOG</para> + </entry> + <entry> + <para>Detail log of all transaction operations.</para> + </entry> + </row> + <row> + <entry> + <para>org.teiid.COMMAND_LOG</para> + </entry> + <entry> + <para> + See + <link linkend="command_logigng">command logging</link> + </para> + </entry> + </row> + <row> + <entry> + <para>org.teiid.AUDIT_LOG</para> + </entry> + <entry> + <para> + See + <link linkend="audit_logigng">audit logging</link> + </para> + </entry> + </row> + <row> + <entry> + <para>org.teiid.ADMIN_API</para> + </entry> + <entry> + <para>Admin API logs.</para> + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + </sect2> + <sect2> + <title>Command Logging API</title> + <para> + If the default log4j logging mechanisms are not sufficient for your + logging needs you may need a appender - see + <ulink url="http://logging.apache.org/log4j/1.2/apidocs/index.html">... log4j javadocs</ulink> + . Note that log4j already provides quite a few appenders including + JMS, RDBMS, and SMTP. + </para> + <para>If you develop a custom logging solution, the implementation + jar should be placed in the lib directory of the server profile + Teiid is installed in. + </para> + </sect2> + </sect1> + <sect1 id="command_logging"> + <title>Command Logging</title> + <para>Command logging captures executing commands in the + Teiid System. + Both user commands (that have been submitted + to Teiid) + and data source + commands (that are being executed by the + connectors) + are tracked + through command logging.</para> + <para>To enable command logging to the default log location, simply + enable the DETAIL level of logging for the org.teiid.COMMAND_LOG + context.</para> + <para> + To enable command logging to an alternative file location, + configure a + separate file appender for the DETAIL logging of the + org.teiid.COMMAND_LOG context. An example of this is shown below and + can also be found in the jboss-log4j.xml distributed with Teiid. + <programlisting><![CDATA[ + <appender name="COMMAND" class="org.apache.log4j.RollingFileAppender"> + <param name="File" value="log/command.log"/> + <param name="MaxFileSize" value="1000KB"/> + <param name="MaxBackupIndex" value="25"/> + <layout class="org.apache.log4j.PatternLayout"> + <param name="ConversionPattern" value="%d %p [%t] %c - %m%n"/> + </layout> + </appender> + + <category name="org.teiid.COMMAND_LOG"> + <priority value="INFO"/> + <appender-ref ref="COMMAND"/> + </category> + ]]> + </programlisting> + </para> + <sect2> + <title>Command Logging API</title> + <para> + If the default log4j logging mechanisms are not sufficient for + your + command logging needs, you may need a custom log4j appender. + The + custom appender will have access to log4j LoggingEvents to the + COMMAND_LOG context, which have a + message that is an instance of + org.teiid.logging.api.CommandLogMessage defined in the + teiid-connector-api-&versionNumber;.jar. + </para> + <para> + See + <link linkend="general_logging">General Logging</link> + for more information on utilizing log4j. + </para> + </sect2> + </sect1> + <sect1 id="audit_logging"> + <title>Audit Logging</title> + <para>Audit logging captures important security events. This includes + the enforcement of permissions, authentication success/failures, etc. + </para> + <para>To enable audit logging to the default log location, simply + enable the DETAIL level of logging for the org.teiid.AUDIT_LOG + context.</para> + <para>To enable audit logging to an alternative file location, + configure a separate file appender for the DETAIL logging of the + org.teiid.AUDIT_LOG context. An example of this is already in + the + log4j.xml distributed with Teiid.</para> + <sect2> + <title>Audit Logging API</title> + <para> + If the default log4j logging mechanisms are not sufficient for + your + audit logging needs, you may need a custom log4j appender. + The + custom + appender will have access to log4j LoggingEvents to the + AUDIT_LOG + context, which have a + message that is an instance of + org.teiid.logging.api.AuditMessage defined in the + teiid-connector-api-&versionNumber;.jar. + AuditMessages include + information about user, the action, and the + target(s) of the action. + </para> + <para> + See + <link linkend="general_logging">General Logging</link> + for more information on utilizing log4j. + </para> + </sect2> + </sect1> +</chapter> \ No newline at end of file Copied: trunk/documentation/connector-developer-guide/src/main/docbook/en-US/content/security.xml (from rev 2217, trunk/documentation/server-extensions-guide/src/main/docbook/en-US/content/security.xml) =================================================================== --- trunk/documentation/connector-developer-guide/src/main/docbook/en-US/content/security.xml (rev 0) +++ trunk/documentation/connector-developer-guide/src/main/docbook/en-US/content/security.xml 2010-06-11 16:44:33 UTC (rev 2221) @@ -0,0 +1,93 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> +<chapter id="custom_security"> + <title>Teiid Security</title> + <para>The Teiid system provides a range of built-in and extensible + security features to enable the + secure access of data.  </para> + <sect1> + <title>Authentication</title> + <para>JDBC clients may use simple passwords to authenticate a user. + </para> + <para>Typically a user name is required, however user names may be + considered optional if the + identity of the user can be discerned by + the password credential alone.  In + any case it is up + to the configured + security domain to determine whether a user can be + authenticated. + </para> + </sect1> + <sect1> + <title>Authorization</title> + <para>Authorization covers both administrative activities and + data + roles.  A data role is a collection of permissions (also referred to + as entitlements) and a + collection of entitled principals or groups. + With the deployment of a VDB + the deployer can choose which principals + and groups have which data roles.</para> + </sect1> + <sect1> + <title>Encryption</title> + <para>At a transport level Teiid provides built-in support for JDBC + over SSL or just sensitive message encryption when SSL is not in use. + </para> + <para> + Passwords in configuration files however are by default stored in + plain text. If you need these values to be encrypted, please see + <ulink + url="http://community.jboss.org/wiki/maskingpasswordsinjbossasxmlcon... passwords</ulink> + for instructions on encryption facilities provided by the container. + </para> + </sect1> + <sect1> + <title>LoginModules</title> + <para> + LoginModules are an essential part of the JAAS security + framework and provide Teiid customizable user authentication and the + ability to reuse existing LoginModules defined for JBossAS. See + <ulink + url="http://docs.jboss.org/jbossas/admindevel326/html/ch8.chapter.ht... Security</ulink> + for general information on configuring security in JBossAS.</para> + <para> + Teiid can be configured with multiple named application policies + that group together relevant LoginModules. Each of these application + policy (or domains) names can be used to fully + qualify user names to + authenticate only against that domain.  The format for a qualified + name is username@domainname. + </para> + <para>If a user name is not fully qualified, then the installed + domains will be consulted in order until a domain + successfully or unsuccessfully authenticates the + user. + </para> + <para>If no domain can authenticate the user, the logon + attempt will fail. + Details of the failed attempt including invalid users, which + domains were consulted, etc. will be in the server log with appropriate + levels of severity.</para> + <sect2> + <title>Built-in LoginModules</title> + <para>JBossAS provides several LoginModules for common authentication needs, such as authenticating from text files or LDAP.</para> + <para>The UsersRolesLoginModule, which utilizes simple text files + to authenticate users and to define + their groups.  The teiid-jboss-beans.xml configuration file contains an example of how to use UsersRolesLoginModule. + Note that this is typically not for production use. + </para> + <para>See <ulink url="http://community.jboss.org/docs/DOC-11253">LDAP LoginModule configuration</ulink> for utilizing LDAP based authentication. + </para> + </sect2> + <sect2> + <title>Custom LoginModules</title> + <para> + If your authentication needs go beyond the provided LoginModules, please consult the + <ulink url="http://java.sun.com/j2se/1.5.0/docs/guide/security/jaas/JAASLMD... development guide</ulink>. + There are also numerous guides available. + </para> + </sect2> + </sect1> +</chapter> \ No newline at end of file Copied: trunk/documentation/connector-developer-guide/src/main/docbook/en-US/main.xml (from rev 2220, trunk/documentation/connector-developer-guide/src/main/docbook/en-US/connector_developer_guide.xml) =================================================================== --- trunk/documentation/connector-developer-guide/src/main/docbook/en-US/main.xml (rev 0) +++ trunk/documentation/connector-developer-guide/src/main/docbook/en-US/main.xml 2010-06-11 16:44:33 UTC (rev 2221) @@ -0,0 +1,61 @@ +<?xml version='1.0' encoding="UTF-8"?> +<!-- + + JBoss, Home of Professional Open Source. + Copyright (C) 2008 Red Hat, Inc. + Licensed to Red Hat, Inc. under one or more contributor + license agreements. See the copyright.txt file in the + distribution for a full listing of individual contributors. + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA + 02110-1301 USA. + +--> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % CustomDTD SYSTEM "../../../../../docbook/custom.dtd"> +%CustomDTD; +]> + +<book> + + <bookinfo> + <title>Teiid - Scalable Information Integration</title> + <subtitle>Teiid Translator and Resource Adapter Developer's Guide</subtitle> + <releaseinfo>&versionNumber;</releaseinfo> + <productnumber>&versionNumber;</productnumber> + <issuenum>1</issuenum> + <copyright> + <year>&copyrightYear;</year> + <holder>&copyrightHolder;</holder> + </copyright> + <xi:include href="../../../../../docbook/en-US/legal_notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + </bookinfo> + + <toc/> + + <xi:include href="content/introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/develop-adapter.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/connector-api.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/command-language.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/lob-support.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/extending-jdbc-connector.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/jdbc-translator-examples.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/logging.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/security.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/appendix-a.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/appendix-b.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + +</book> + Modified: trunk/documentation/quick-start-example/pom.xml =================================================================== --- trunk/documentation/quick-start-example/pom.xml 2010-06-11 00:22:28 UTC (rev 2220) +++ trunk/documentation/quick-start-example/pom.xml 2010-06-11 16:44:33 UTC (rev 2221) @@ -19,6 +19,11 @@ <extensions>true</extensions> <dependencies> <dependency> + <groupId>net.sf.docbook</groupId> + <artifactId>docbook</artifactId> + <version>1.74.0</version> + </dependency> + <dependency> <groupId>org.jboss</groupId> <artifactId>jbossorg-docbook-xslt</artifactId> <version>1.1.0</version> @@ -47,11 +52,11 @@ <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource> <finalName>quick_start_example.pdf</finalName> </format> - <!-- <format> + <format> <formatName>html_single</formatName> <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource> <finalName>index.html</finalName> - </format> --> + </format> <format> <formatName>html</formatName> <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource> @@ -60,6 +65,8 @@ </formats> <options> <xincludeSupported>true</xincludeSupported> + <xmlTransformerType>saxon</xmlTransformerType> + <docbookVersion>1.72.0</docbookVersion> <localeSeparator>-</localeSeparator> <useRelativeImageUris>false</useRelativeImageUris> </options> Modified: trunk/documentation/reference/pom.xml =================================================================== --- trunk/documentation/reference/pom.xml 2010-06-11 00:22:28 UTC (rev 2220) +++ trunk/documentation/reference/pom.xml 2010-06-11 16:44:33 UTC (rev 2221) @@ -19,6 +19,11 @@ <extensions>true</extensions> <dependencies> <dependency> + <groupId>net.sf.docbook</groupId> + <artifactId>docbook</artifactId> + <version>1.74.0</version> + </dependency> + <dependency> <groupId>org.jboss</groupId> <artifactId>jbossorg-docbook-xslt</artifactId> <version>1.1.0</version> @@ -47,11 +52,11 @@ <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource> <finalName>teiid_reference.pdf</finalName> </format> - <!-- <format> + <format> <formatName>html_single</formatName> <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource> <finalName>index.html</finalName> - </format> --> + </format> <format> <formatName>html</formatName> <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource> @@ -59,6 +64,8 @@ </format> </formats> <options> + <xmlTransformerType>saxon</xmlTransformerType> + <docbookVersion>1.72.0</docbookVersion> <xincludeSupported>true</xincludeSupported> <localeSeparator>-</localeSeparator> <useRelativeImageUris>false</useRelativeImageUris> Modified: trunk/documentation/salesforce-connector-guide/pom.xml =================================================================== --- trunk/documentation/salesforce-connector-guide/pom.xml 2010-06-11 00:22:28 UTC (rev 2220) +++ trunk/documentation/salesforce-connector-guide/pom.xml 2010-06-11 16:44:33 UTC (rev 2221) @@ -19,6 +19,11 @@ <extensions>true</extensions> <dependencies> <dependency> + <groupId>net.sf.docbook</groupId> + <artifactId>docbook</artifactId> + <version>1.74.0</version> + </dependency> + <dependency> <groupId>org.jboss</groupId> <artifactId>jbossorg-docbook-xslt</artifactId> <version>1.1.0</version> @@ -47,11 +52,11 @@ <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource> <finalName>salesforce_connector_guide.pdf</finalName> </format> - <!-- <format> + <format> <formatName>html_single</formatName> <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource> <finalName>index.html</finalName> - </format> --> + </format> <format> <formatName>html</formatName> <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource> @@ -60,6 +65,8 @@ </formats> <options> <xincludeSupported>true</xincludeSupported> + <xmlTransformerType>saxon</xmlTransformerType> + <docbookVersion>1.72.0</docbookVersion> <localeSeparator>-</localeSeparator> <useRelativeImageUris>false</useRelativeImageUris> </options> Modified: trunk/documentation/server-extensions-guide/pom.xml =================================================================== --- trunk/documentation/server-extensions-guide/pom.xml 2010-06-11 00:22:28 UTC (rev 2220) +++ trunk/documentation/server-extensions-guide/pom.xml 2010-06-11 16:44:33 UTC (rev 2221) @@ -19,6 +19,11 @@ <extensions>true</extensions> <dependencies> <dependency> + <groupId>net.sf.docbook</groupId> + <artifactId>docbook</artifactId> + <version>1.74.0</version> + </dependency> + <dependency> <groupId>org.jboss</groupId> <artifactId>jbossorg-docbook-xslt</artifactId> <version>1.1.0</version> @@ -28,7 +33,7 @@ <artifactId>jbossorg-jdocbook-style</artifactId> <version>1.1.0</version> <type>jdocbook-style</type> - </dependency> + </dependency> </dependencies> <configuration> <sourceDocumentName>server_extensions_guide.xml</sourceDocumentName> @@ -47,11 +52,11 @@ <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource> <finalName>server_extensions_guide.pdf</finalName> </format> - <!-- <format> + <format> <formatName>html_single</formatName> <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource> <finalName>index.html</finalName> - </format> --> + </format> <format> <formatName>html</formatName> <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource> @@ -60,6 +65,8 @@ </formats> <options> <xincludeSupported>true</xincludeSupported> + <xmlTransformerType>saxon</xmlTransformerType> + <docbookVersion>1.72.0</docbookVersion> <localeSeparator>-</localeSeparator> <useRelativeImageUris>false</useRelativeImageUris> </options> Deleted: trunk/documentation/server-extensions-guide/src/main/docbook/en-US/content/appendix-a.xml =================================================================== --- trunk/documentation/server-extensions-guide/src/main/docbook/en-US/content/appendix-a.xml 2010-06-11 00:22:28 UTC (rev 2220) +++ trunk/documentation/server-extensions-guide/src/main/docbook/en-US/content/appendix-a.xml 2010-06-11 16:44:33 UTC (rev 2221) @@ -1,23 +0,0 @@ -<appendix id="advanced_topics"> - <title>Advanced Topics</title> - <sect1> - <title>Migration From Previous Versions</title> - <para>It is recommended that customers who have utilized the internal JDBC membership domain from releases - prior to MetaMatrix 5.5 migrate those users and groups to an LDAP compliant directory server.  Several free - and open source directory servers can be used including:</para> - <para> - The Fedora Directory Server - <ulink url="http://directory.fedoraproject.org/">http://directory.f... - </para> - <para> - Open LDAP - <ulink url="http://www.openldap.org/">http://www.openldap.org/</... - </para> - <para> - Apache Directory Server - <ulink url="http://directory.apache.org/">http://directory.apache.o... - </para> - <para>If there are additional questions or the need for guidance in the migration process, please contact - technical support.</para> - </sect1> -</appendix> \ No newline at end of file Deleted: trunk/documentation/server-extensions-guide/src/main/docbook/en-US/content/logging.xml =================================================================== --- trunk/documentation/server-extensions-guide/src/main/docbook/en-US/content/logging.xml 2010-06-11 00:22:28 UTC (rev 2220) +++ trunk/documentation/server-extensions-guide/src/main/docbook/en-US/content/logging.xml 2010-06-11 16:44:33 UTC (rev 2221) @@ -1,278 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ -<!ENTITY % CustomDTD SYSTEM "../../../../../../docbook/custom.dtd"> -%CustomDTD; -]> -<chapter id="logging"> - <title>Logging</title> - <sect1 id="general_logging"> - <title>General Logging</title> - <para> - The Teiid system provides a wealth of information via logging. To - control logging level, contexts, and log locations, you should be - familiar with - <ulink url="http://logging.apache.org/log4j/">log4j</ulink> - and the container's jboss-log4j.xml configuration file. - Teiid also provides a &lt;profile&gt;/conf/jboss-teiid-log4j.xml containing much of information from chapter. - </para> - <para> - All the logs - produced by Teiid are prefixed by org.teiid. This - makes it extremely - easy to control of of Teiid logging from a single - context. Note however that changes to the log configuration file - require a restart to take affect - </para> - <sect2> - <title>Logging Contexts</title> - <para>While all of Teiid's logs are prefixed with org.teiid, there - are more specific contexts depending on the functional area of the - system. Note that logs originating from third-party code, including - integrated org.jboss components, will be logged through their - respective contexts and not through org.teiid. See the table below for information on contexts - relevant to Teiid. See the container's jboss-log4j.xml for a more - complete listing of logging contexts used in the container. - </para> - <informaltable frame="all"> - <tgroup cols="2"> - <thead> - <row> - <entry> - <para>Context</para> - </entry> - <entry> - <para>Description</para> - </entry> - </row> - </thead> - <tbody> - <row> - <entry> - <para>com.arjuna</para> - </entry> - <entry> - <para>Third-party transaction manager. This will include - information about all transactions, not just those for Teiid. - </para> - </entry> - </row> - <row> - <entry> - <para>org.teiid</para> - </entry> - <entry> - <para>Root context for all Teiid logs. Note: there are - potentially other contexts used under org.teiid than are shown - in this table.</para> - </entry> - </row> - <row> - <entry> - <para>org.teiid.PROCESSOR</para> - </entry> - <entry> - <para>Query processing logs. See also org.teiid.PLANNER for - query planning logs.</para> - </entry> - </row> - <row> - <entry> - <para>org.teiid.PLANNER</para> - </entry> - <entry> - <para>Query planning logs.</para> - </entry> - </row> - <row> - <entry> - <para>org.teiid.SECURITY</para> - </entry> - <entry> - <para>Session/Authentication events - see also AUDIT logging</para> - </entry> - </row> - <row> - <entry> - <para>org.teiid.TRANSPORT</para> - </entry> - <entry> - <para>Events related to the socket transport.</para> - </entry> - </row> - <row> - <entry> - <para>org.teiid.RUNTIME</para> - </entry> - <entry> - <para>Events related to work management and system start/stop.</para> - </entry> - </row> - <row> - <entry> - <para>org.teiid.CONNECTOR</para> - </entry> - <entry> - <para>Connector logs.</para> - </entry> - </row> - <row> - <entry> - <para>org.teiid.BUFFER_MGR</para> - </entry> - <entry> - <para>Buffer and storage management logs.</para> - </entry> - </row> - <row> - <entry> - <para>org.teiid.TXN_LOG</para> - </entry> - <entry> - <para>Detail log of all transaction operations.</para> - </entry> - </row> - <row> - <entry> - <para>org.teiid.COMMAND_LOG</para> - </entry> - <entry> - <para> - See - <link linkend="command_logigng">command logging</link> - </para> - </entry> - </row> - <row> - <entry> - <para>org.teiid.AUDIT_LOG</para> - </entry> - <entry> - <para> - See - <link linkend="audit_logigng">audit logging</link> - </para> - </entry> - </row> - <row> - <entry> - <para>org.teiid.ADMIN_API</para> - </entry> - <entry> - <para>Admin API logs.</para> - </entry> - </row> - </tbody> - </tgroup> - </informaltable> - </sect2> - <sect2> - <title>Command Logging API</title> - <para> - If the default log4j logging mechanisms are not sufficient for your - logging needs you may need a appender - see - <ulink url="http://logging.apache.org/log4j/1.2/apidocs/index.html">... log4j javadocs</ulink> - . Note that log4j already provides quite a few appenders including - JMS, RDBMS, and SMTP. - </para> - <para>If you develop a custom logging solution, the implementation - jar should be placed in the lib directory of the server profile - Teiid is installed in. - </para> - </sect2> - </sect1> - <sect1 id="command_logging"> - <title>Command Logging</title> - <para>Command logging captures executing commands in the - Teiid System. - Both user commands (that have been submitted - to Teiid) - and data source - commands (that are being executed by the - connectors) - are tracked - through command logging.</para> - <para>To enable command logging to the default log location, simply - enable the DETAIL level of logging for the org.teiid.COMMAND_LOG - context.</para> - <para> - To enable command logging to an alternative file location, - configure a - separate file appender for the DETAIL logging of the - org.teiid.COMMAND_LOG context. An example of this is shown below and - can also be found in the jboss-log4j.xml distributed with Teiid. - <programlisting><![CDATA[ - <appender name="COMMAND" class="org.apache.log4j.RollingFileAppender"> - <param name="File" value="log/command.log"/> - <param name="MaxFileSize" value="1000KB"/> - <param name="MaxBackupIndex" value="25"/> - <layout class="org.apache.log4j.PatternLayout"> - <param name="ConversionPattern" value="%d %p [%t] %c - %m%n"/> - </layout> - </appender> - - <category name="org.teiid.COMMAND_LOG"> - <priority value="INFO"/> - <appender-ref ref="COMMAND"/> - </category> - ]]> - </programlisting> - </para> - <sect2> - <title>Command Logging API</title> - <para> - If the default log4j logging mechanisms are not sufficient for - your - command logging needs, you may need a custom log4j appender. - The - custom appender will have access to log4j LoggingEvents to the - COMMAND_LOG context, which have a - message that is an instance of - org.teiid.logging.api.CommandLogMessage defined in the - teiid-connector-api-&versionNumber;.jar. - </para> - <para> - See - <link linkend="general_logging">General Logging</link> - for more information on utilizing log4j. - </para> - </sect2> - </sect1> - <sect1 id="audit_logging"> - <title>Audit Logging</title> - <para>Audit logging captures important security events. This includes - the enforcement of permissions, authentication success/failures, etc. - </para> - <para>To enable audit logging to the default log location, simply - enable the DETAIL level of logging for the org.teiid.AUDIT_LOG - context.</para> - <para>To enable audit logging to an alternative file location, - configure a separate file appender for the DETAIL logging of the - org.teiid.AUDIT_LOG context. An example of this is already in - the - log4j.xml distributed with Teiid.</para> - <sect2> - <title>Audit Logging API</title> - <para> - If the default log4j logging mechanisms are not sufficient for - your - audit logging needs, you may need a custom log4j appender. - The - custom - appender will have access to log4j LoggingEvents to the - AUDIT_LOG - context, which have a - message that is an instance of - org.teiid.logging.api.AuditMessage defined in the - teiid-connector-api-&versionNumber;.jar. - AuditMessages include - information about user, the action, and the - target(s) of the action. - </para> - <para> - See - <link linkend="general_logging">General Logging</link> - for more information on utilizing log4j. - </para> - </sect2> - </sect1> -</chapter> \ No newline at end of file Deleted: trunk/documentation/server-extensions-guide/src/main/docbook/en-US/content/security.xml =================================================================== --- trunk/documentation/server-extensions-guide/src/main/docbook/en-US/content/security.xml 2010-06-11 00:22:28 UTC (rev 2220) +++ trunk/documentation/server-extensions-guide/src/main/docbook/en-US/content/security.xml 2010-06-11 16:44:33 UTC (rev 2221) @@ -1,93 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> -<chapter id="custom_security"> - <title>Teiid Security</title> - <para>The Teiid system provides a range of built-in and extensible - security features to enable the - secure access of data.  </para> - <sect1> - <title>Authentication</title> - <para>JDBC clients may use simple passwords to authenticate a user. - </para> - <para>Typically a user name is required, however user names may be - considered optional if the - identity of the user can be discerned by - the password credential alone.  In - any case it is up - to the configured - security domain to determine whether a user can be - authenticated. - </para> - </sect1> - <sect1> - <title>Authorization</title> - <para>Authorization covers both administrative activities and - data - roles.  A data role is a collection of permissions (also referred to - as entitlements) and a - collection of entitled principals or groups. - With the deployment of a VDB - the deployer can choose which principals - and groups have which data roles.</para> - </sect1> - <sect1> - <title>Encryption</title> - <para>At a transport level Teiid provides built-in support for JDBC - over SSL or just sensitive message encryption when SSL is not in use. - </para> - <para> - Passwords in configuration files however are by default stored in - plain text. If you need these values to be encrypted, please see - <ulink - url="http://community.jboss.org/wiki/maskingpasswordsinjbossasxmlcon... passwords</ulink> - for instructions on encryption facilities provided by the container. - </para> - </sect1> - <sect1> - <title>LoginModules</title> - <para> - LoginModules are an essential part of the JAAS security - framework and provide Teiid customizable user authentication and the - ability to reuse existing LoginModules defined for JBossAS. See - <ulink - url="http://docs.jboss.org/jbossas/admindevel326/html/ch8.chapter.ht... Security</ulink> - for general information on configuring security in JBossAS.</para> - <para> - Teiid can be configured with multiple named application policies - that group together relevant LoginModules. Each of these application - policy (or domains) names can be used to fully - qualify user names to - authenticate only against that domain.  The format for a qualified - name is username@domainname. - </para> - <para>If a user name is not fully qualified, then the installed - domains will be consulted in order until a domain - successfully or unsuccessfully authenticates the - user. - </para> - <para>If no domain can authenticate the user, the logon - attempt will fail. - Details of the failed attempt including invalid users, which - domains were consulted, etc. will be in the server log with appropriate - levels of severity.</para> - <sect2> - <title>Built-in LoginModules</title> - <para>JBossAS provides several LoginModules for common authentication needs, such as authenticating from text files or LDAP.</para> - <para>The UsersRolesLoginModule, which utilizes simple text files - to authenticate users and to define - their groups.  The teiid-jboss-beans.xml configuration file contains an example of how to use UsersRolesLoginModule. - Note that this is typically not for production use. - </para> - <para>See <ulink url="http://community.jboss.org/docs/DOC-11253">LDAP LoginModule configuration</ulink> for utilizing LDAP based authentication. - </para> - </sect2> - <sect2> - <title>Custom LoginModules</title> - <para> - If your authentication needs go beyond the provided LoginModules, please consult the - <ulink url="http://java.sun.com/j2se/1.5.0/docs/guide/security/jaas/JAASLMD... development guide</ulink>. - There are also numerous guides available. - </para> - </sect2> - </sect1> -</chapter> \ No newline at end of file Modified: trunk/documentation/server-extensions-guide/src/main/docbook/en-US/server_extensions_guide.xml =================================================================== --- trunk/documentation/server-extensions-guide/src/main/docbook/en-US/server_extensions_guide.xml 2010-06-11 00:22:28 UTC (rev 2220) +++ trunk/documentation/server-extensions-guide/src/main/docbook/en-US/server_extensions_guide.xml 2010-06-11 16:44:33 UTC (rev 2221) @@ -46,9 +46,6 @@ <toc/> <xi:include href="content/introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="content/logging.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="content/security.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="content/appendix-a.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> </book>