summaryrefslogtreecommitdiffstats
path: root/site/branches/site-20060730-mvnbased/src/site/resources/javadoc/tuscany-core/org/apache/tuscany/core/builder/WireBuilder.html
diff options
context:
space:
mode:
Diffstat (limited to 'site/branches/site-20060730-mvnbased/src/site/resources/javadoc/tuscany-core/org/apache/tuscany/core/builder/WireBuilder.html')
-rw-r--r--site/branches/site-20060730-mvnbased/src/site/resources/javadoc/tuscany-core/org/apache/tuscany/core/builder/WireBuilder.html279
1 files changed, 279 insertions, 0 deletions
diff --git a/site/branches/site-20060730-mvnbased/src/site/resources/javadoc/tuscany-core/org/apache/tuscany/core/builder/WireBuilder.html b/site/branches/site-20060730-mvnbased/src/site/resources/javadoc/tuscany-core/org/apache/tuscany/core/builder/WireBuilder.html
new file mode 100644
index 0000000000..ac28982cc4
--- /dev/null
+++ b/site/branches/site-20060730-mvnbased/src/site/resources/javadoc/tuscany-core/org/apache/tuscany/core/builder/WireBuilder.html
@@ -0,0 +1,279 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!--NewPage-->
+<HTML>
+<HEAD>
+<!-- Generated by javadoc (build 1.5.0_06) on Mon May 15 07:33:03 EDT 2006 -->
+<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<TITLE>
+WireBuilder (Tuscany Core incubating-M1 API)
+</TITLE>
+
+<META NAME="keywords" CONTENT="org.apache.tuscany.core.builder.WireBuilder interface">
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
+
+<SCRIPT type="text/javascript">
+function windowTitle()
+{
+ parent.document.title="WireBuilder (Tuscany Core incubating-M1 API)";
+}
+</SCRIPT>
+<NOSCRIPT>
+</NOSCRIPT>
+
+</HEAD>
+
+<BODY BGCOLOR="white" onload="windowTitle();">
+
+
+<!-- ========= START OF TOP NAVBAR ======= -->
+<A NAME="navbar_top"><!-- --></A>
+<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_top_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/WireBuilder.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+Tuscany Core</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+&nbsp;<A HREF="../../../../../org/apache/tuscany/core/builder/UnknownTypeException.html" title="class in org.apache.tuscany.core.builder"><B>PREV CLASS</B></A>&nbsp;
+&nbsp;NEXT CLASS</FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../../index.html?org/apache/tuscany/core/builder/WireBuilder.html" target="_top"><B>FRAMES</B></A> &nbsp;
+&nbsp;<A HREF="WireBuilder.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
+&nbsp;<SCRIPT type="text/javascript">
+ <!--
+ if(window==top) {
+ document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
+ }
+ //-->
+</SCRIPT>
+<NOSCRIPT>
+ <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
+</NOSCRIPT>
+
+
+</FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_top"></A>
+<!-- ========= END OF TOP NAVBAR ========= -->
+
+<HR>
+<!-- ======== START OF CLASS DATA ======== -->
+<H2>
+<FONT SIZE="-1">
+org.apache.tuscany.core.builder</FONT>
+<BR>
+Interface WireBuilder</H2>
+<DL>
+<DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../../../../org/apache/tuscany/core/context/ConfigurationContext.html" title="interface in org.apache.tuscany.core.context">ConfigurationContext</A>, <A HREF="../../../../../org/apache/tuscany/core/builder/HierarchicalWireBuilder.html" title="interface in org.apache.tuscany.core.builder">HierarchicalWireBuilder</A>, <A HREF="../../../../../org/apache/tuscany/core/runtime/RuntimeContext.html" title="interface in org.apache.tuscany.core.runtime">RuntimeContext</A>, <A HREF="../../../../../org/apache/tuscany/core/context/SystemCompositeContext.html" title="interface in org.apache.tuscany.core.context">SystemCompositeContext</A></DD>
+</DL>
+<DL>
+<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../org/apache/tuscany/core/context/impl/AbstractCompositeContext.html" title="class in org.apache.tuscany.core.context.impl">AbstractCompositeContext</A>, <A HREF="../../../../../org/apache/tuscany/core/context/impl/CompositeContextImpl.html" title="class in org.apache.tuscany.core.context.impl">CompositeContextImpl</A>, <A HREF="../../../../../org/apache/tuscany/core/builder/impl/DefaultWireBuilder.html" title="class in org.apache.tuscany.core.builder.impl">DefaultWireBuilder</A>, <A HREF="../../../../../org/apache/tuscany/core/runtime/RuntimeContextImpl.html" title="class in org.apache.tuscany.core.runtime">RuntimeContextImpl</A>, <A HREF="../../../../../org/apache/tuscany/core/system/context/SystemCompositeContextImpl.html" title="class in org.apache.tuscany.core.system.context">SystemCompositeContextImpl</A>, <A HREF="../../../../../org/apache/tuscany/core/extension/WireBuilderSupport.html" title="class in org.apache.tuscany.core.extension">WireBuilderSupport</A></DD>
+</DL>
+<HR>
+<DL>
+<DT><PRE>public interface <B>WireBuilder</B></DL>
+</PRE>
+
+<P>
+Implementations perform the second phase of converting a logical model representing an assembly into a series of
+ runtime or executable artifacts. Specifically, they are responsible for finalizing target-side proxy factories and
+ bridging <A HREF="../../../../../org/apache/tuscany/core/wire/InvocationConfiguration.html" title="class in org.apache.tuscany.core.wire"><CODE>InvocationConfiguration</CODE></A>s held by source- and target-side proxy
+ factories. <code>WireBuilder</code>s generally operate by target implementation type. In other words, for a wire
+ from a Java source to a JavaScript target, the Javascript <code>WireBuilder</code> will complete the wire. This is
+ necessary as a <code>WireBuilder</code> must set a <A HREF="../../../../../org/apache/tuscany/core/wire/TargetInvoker.html" title="interface in org.apache.tuscany.core.wire"><CODE>TargetInvoker</CODE></A> that is
+ responsible for dispatching to an implementation on the source side of the wire.
+ <p>
+ Runtimes are generally configured with a <A HREF="../../../../../org/apache/tuscany/core/builder/impl/DefaultWireBuilder.html" title="class in org.apache.tuscany.core.builder.impl"><CODE>DefaultWireBuilder</CODE></A> as a
+ top-most wire builder, which delegates to other builders wired to it as part of a system configuration.
+ <p>
+ Wire builders may optimize the wire chains based on certain characteristics of th wire, such as source and
+ target scopes.
+<P>
+
+<P>
+<DL>
+<DT><B>Version:</B></DT>
+ <DD>$Rev$ $Date$</DD>
+<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/tuscany/core/builder/ContextFactoryBuilder.html" title="interface in org.apache.tuscany.core.builder"><CODE>ContextFactoryBuilder</CODE></A>,
+<A HREF="../../../../../org/apache/tuscany/core/builder/impl/DefaultWireBuilder.html" title="class in org.apache.tuscany.core.builder.impl"><CODE>DefaultWireBuilder</CODE></A></DL>
+<HR>
+
+<P>
+
+<!-- ========== METHOD SUMMARY =========== -->
+
+<A NAME="method_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Method Summary</B></FONT></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/tuscany/core/builder/WireBuilder.html#completeTargetChain(org.apache.tuscany.core.wire.TargetWireFactory, java.lang.Class, org.apache.tuscany.core.context.ScopeContext)">completeTargetChain</A></B>(<A HREF="../../../../../org/apache/tuscany/core/wire/TargetWireFactory.html" title="interface in org.apache.tuscany.core.wire">TargetWireFactory</A>&lt;?&gt;&nbsp;targetFactory,
+ java.lang.Class&nbsp;targetType,
+ <A HREF="../../../../../org/apache/tuscany/core/context/ScopeContext.html" title="interface in org.apache.tuscany.core.context">ScopeContext</A>&nbsp;targetScopeContext)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Finishes processing the target side wire chain.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/tuscany/core/builder/WireBuilder.html#connect(org.apache.tuscany.core.wire.SourceWireFactory, org.apache.tuscany.core.wire.TargetWireFactory, java.lang.Class, boolean, org.apache.tuscany.core.context.ScopeContext)">connect</A></B>(<A HREF="../../../../../org/apache/tuscany/core/wire/SourceWireFactory.html" title="interface in org.apache.tuscany.core.wire">SourceWireFactory</A>&lt;?&gt;&nbsp;sourceFactory,
+ <A HREF="../../../../../org/apache/tuscany/core/wire/TargetWireFactory.html" title="interface in org.apache.tuscany.core.wire">TargetWireFactory</A>&lt;?&gt;&nbsp;targetFactory,
+ java.lang.Class&nbsp;targetType,
+ boolean&nbsp;downScope,
+ <A HREF="../../../../../org/apache/tuscany/core/context/ScopeContext.html" title="interface in org.apache.tuscany.core.context">ScopeContext</A>&nbsp;targetScopeContext)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Connects wire configurations of the source proxy factory to corresponding ones in the target proxy to
+ factory</TD>
+</TR>
+</TABLE>
+&nbsp;
+<P>
+
+<!-- ============ METHOD DETAIL ========== -->
+
+<A NAME="method_detail"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Method Detail</B></FONT></TH>
+</TR>
+</TABLE>
+
+<A NAME="connect(org.apache.tuscany.core.wire.SourceWireFactory, org.apache.tuscany.core.wire.TargetWireFactory, java.lang.Class, boolean, org.apache.tuscany.core.context.ScopeContext)"><!-- --></A><H3>
+connect</H3>
+<PRE>
+void <B>connect</B>(<A HREF="../../../../../org/apache/tuscany/core/wire/SourceWireFactory.html" title="interface in org.apache.tuscany.core.wire">SourceWireFactory</A>&lt;?&gt;&nbsp;sourceFactory,
+ <A HREF="../../../../../org/apache/tuscany/core/wire/TargetWireFactory.html" title="interface in org.apache.tuscany.core.wire">TargetWireFactory</A>&lt;?&gt;&nbsp;targetFactory,
+ java.lang.Class&nbsp;targetType,
+ boolean&nbsp;downScope,
+ <A HREF="../../../../../org/apache/tuscany/core/context/ScopeContext.html" title="interface in org.apache.tuscany.core.context">ScopeContext</A>&nbsp;targetScopeContext)
+ throws <A HREF="../../../../../org/apache/tuscany/core/builder/BuilderConfigException.html" title="class in org.apache.tuscany.core.builder">BuilderConfigException</A></PRE>
+<DL>
+<DD>Connects wire configurations of the source proxy factory to corresponding ones in the target proxy to
+ factory
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>sourceFactory</CODE> - the proxy factory used in constructing the source side of the wire chain<DD><CODE>targetFactory</CODE> - the proxy factory used in constructing the target side of the wire chain<DD><CODE>targetType</CODE> - the context type of the target. Used to determine if a paricular wire builder should construct
+ the wire<DD><CODE>downScope</CODE> - true if the component containing the reference (source side) is of a lesser scope than the
+ target service<DD><CODE>targetScopeContext</CODE> - the scope context responsible for managing intance contexts of the target component
+ type
+<DT><B>Throws:</B>
+<DD><CODE><A HREF="../../../../../org/apache/tuscany/core/builder/BuilderConfigException.html" title="class in org.apache.tuscany.core.builder">BuilderConfigException</A></CODE> - if an error occurs during the wire buildSource process</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="completeTargetChain(org.apache.tuscany.core.wire.TargetWireFactory, java.lang.Class, org.apache.tuscany.core.context.ScopeContext)"><!-- --></A><H3>
+completeTargetChain</H3>
+<PRE>
+void <B>completeTargetChain</B>(<A HREF="../../../../../org/apache/tuscany/core/wire/TargetWireFactory.html" title="interface in org.apache.tuscany.core.wire">TargetWireFactory</A>&lt;?&gt;&nbsp;targetFactory,
+ java.lang.Class&nbsp;targetType,
+ <A HREF="../../../../../org/apache/tuscany/core/context/ScopeContext.html" title="interface in org.apache.tuscany.core.context">ScopeContext</A>&nbsp;targetScopeContext)
+ throws <A HREF="../../../../../org/apache/tuscany/core/builder/BuilderConfigException.html" title="class in org.apache.tuscany.core.builder">BuilderConfigException</A></PRE>
+<DL>
+<DD>Finishes processing the target side wire chain. For example, a
+ <A HREF="../../../../../org/apache/tuscany/core/wire/TargetInvoker.html" title="interface in org.apache.tuscany.core.wire"><CODE>TargetInvoker</CODE></A> used by target-side proxies is usually set during this
+ phase.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>targetFactory</CODE> - the target-side proxy factory<DD><CODE>targetType</CODE> - the target context type<DD><CODE>targetScopeContext</CODE> - the target scope
+<DT><B>Throws:</B>
+<DD><CODE><A HREF="../../../../../org/apache/tuscany/core/builder/BuilderConfigException.html" title="class in org.apache.tuscany.core.builder">BuilderConfigException</A></CODE> - if an error occurs during the wire buildSource process</DL>
+</DD>
+</DL>
+<!-- ========= END OF CLASS DATA ========= -->
+<HR>
+
+
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<A NAME="navbar_bottom"><!-- --></A>
+<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_bottom_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/WireBuilder.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+Tuscany Core</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+&nbsp;<A HREF="../../../../../org/apache/tuscany/core/builder/UnknownTypeException.html" title="class in org.apache.tuscany.core.builder"><B>PREV CLASS</B></A>&nbsp;
+&nbsp;NEXT CLASS</FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../../index.html?org/apache/tuscany/core/builder/WireBuilder.html" target="_top"><B>FRAMES</B></A> &nbsp;
+&nbsp;<A HREF="WireBuilder.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
+&nbsp;<SCRIPT type="text/javascript">
+ <!--
+ if(window==top) {
+ document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
+ }
+ //-->
+</SCRIPT>
+<NOSCRIPT>
+ <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
+</NOSCRIPT>
+
+
+</FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_bottom"></A>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+
+<HR>
+-
+</BODY>
+</HTML>