| Title: cdeploy |
| |
| |
| <P><TT>cdeploy</TT> is an Ant task that configures Cayenne connection information in existing jar files that contain Cayenne project information. It is useful for the automation of deployment of Cayenne-based frameworks in different environments.</P> |
| |
| <H3><A name="cdeploy-Parameters"></A>Parameters</H3> |
| <DIV class="table-wrap"> |
| <TABLE class="confluenceTable"><TBODY> |
| <TR> |
| <TH class="confluenceTh">Attribute</TH> |
| <TH class="confluenceTh">Description</TH> |
| <TH class="confluenceTh">Required</TH> |
| </TR> |
| <TR> |
| <TD class="confluenceTd">src</TD> |
| <TD class="confluenceTd">Source jar file that contains Cayenne project files among other things.</TD> |
| <TD class="confluenceTd">Yes</TD> |
| </TR> |
| <TR> |
| <TD class="confluenceTd">dest</TD> |
| <TD class="confluenceTd">Destination jar file that should be generated as a result of this task execution. If omitted, src is used.</TD> |
| <TD class="confluenceTd">No</TD> |
| </TR> |
| <TR> |
| <TD class="confluenceTd">altProjectFile</TD> |
| <TD class="confluenceTd">An alternative location of cayenne.xml file. User can specify an arbitrary file. This file will be used as the main project file, replacing any existing cayenne.xml in the source jar. This gives the users an ultimate flexibility in configuring deployment libraries. For instance this feature can be used to deploy standalone DataMaps.</TD> |
| <TD class="confluenceTd">No</TD> |
| </TR> |
| </TBODY></TABLE> |
| </DIV> |
| |
| |
| <H3><A name="cdeploy-NestedElements%3A"></A>Nested Elements:</H3> |
| |
| <H5><A name="cdeploy-node"></A>node</H5> |
| <P>One or more nested "node" elements specify connection information for the named nodes. All nested nodes must exist in the project, or otherwise they will be ignored.<BR> |
| Nested node Parameters:</P> |
| <DIV class="table-wrap"> |
| <TABLE class="confluenceTable"><TBODY> |
| <TR> |
| <TH class="confluenceTh">Attribute</TH> |
| <TH class="confluenceTh">Description</TH> |
| <TH class="confluenceTh">Required</TH> |
| </TR> |
| <TR> |
| <TD class="confluenceTd">name</TD> |
| <TD class="confluenceTd">DataNode name</TD> |
| <TD class="confluenceTd">Yes</TD> |
| </TR> |
| <TR> |
| <TD class="confluenceTd">domain</TD> |
| <TD class="confluenceTd">Parent DataDomain of this node. If omitted, project must have only a single domain (very common case).</TD> |
| <TD class="confluenceTd">No</TD> |
| </TR> |
| <TR> |
| <TD class="confluenceTd">adapter</TD> |
| <TD class="confluenceTd">DataNode adapter.</TD> |
| <TD class="confluenceTd">No</TD> |
| </TR> |
| <TR> |
| <TD class="confluenceTd">dataSource</TD> |
| <TD class="confluenceTd">DataSource name to use for this node.</TD> |
| <TD class="confluenceTd">No</TD> |
| </TR> |
| <TR> |
| <TD class="confluenceTd">driverFile</TD> |
| <TD class="confluenceTd">File that contains driver information.</TD> |
| <TD class="confluenceTd">No</TD> |
| </TR> |
| </TBODY></TABLE> |
| </DIV> |
| |
| |
| <P>"dataSource" and "driverFile" are mutually exclusive, but none of them are required.</P> |
| |
| <H3><A name="cdeploy-Examples"></A>Examples</H3> |
| |
| <P>Load the Ant task <EM>(note: if you already loaded all Cayenne tasks via an antlib taskdef <A href="ant-tasks.html" title="Ant Tasks">described before</A>, this step is not needed)</EM>: </P> |
| <DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> |
| <PRE class="code-xml"><SPAN class="code-tag"><taskdef name=<SPAN class="code-quote">"cdeploy"</SPAN> classname=<SPAN class="code-quote">"org.apache.cayenne.tools.DeploymentConfigurator"</SPAN>/></SPAN></PRE> |
| </DIV></DIV> |
| |
| <P>Here is an example of using <TT>cdeploy</TT> to regenerate a jar file called "business.jar" with connection info located in "alt.driver.xml":</P> |
| |
| <DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> |
| <PRE class="code-xml"><SPAN class="code-tag"><cdeploy src=<SPAN class="code-quote">"business.jar"</SPAN>></SPAN> |
| <SPAN class="code-tag"><node name=<SPAN class="code-quote">"main-node"</SPAN> driverFile=<SPAN class="code-quote">"alt.driver.xml"</SPAN>/></SPAN> |
| <SPAN class="code-tag"></cdeploy></SPAN> |
| </PRE> |
| </DIV></DIV> |
| |
| <P>An example of using <TT>cdeploy</TT> to redeploy a 3rd party library that contains DataMaps, but may not contain cayenne.xml:</P> |
| |
| <DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> |
| <PRE class="code-xml"><SPAN class="code-tag"><cdeploy src=<SPAN class="code-quote">"business.jar"</SPAN> altProjectFile=<SPAN class="code-quote">"my-cayenne.xml"</SPAN>/></SPAN> |
| </PRE> |
| </DIV></DIV> |
