< prev index next >

src/java.corba/share/classes/org/omg/PortableServer/package.html

Print this page 







  18  version 2 for more details (a copy is included in the LICENSE file that
  19  accompanied this code).
  20 
  21  You should have received a copy of the GNU General Public License version
  22  2 along with this work; if not, write to the Free Software Foundation,
  23  Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  24 
  25  Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  26  or visit www.oracle.com if you need additional information or have any
  27  questions.
  28 
  29 
  30 -->
  31 
  32 </head>
  33 <body bgcolor="white">
  34 Provides classes and interfaces for making the server side of your applications 
  35 portable across multivendor ORBs.
  36 
  37 <P>In Java, Portable Object Adaptor (POA)-based Dynamic Skeleton Interface (DSI) 
  38 servants inherit from the  standard <TT>DynamicImplementation</TT> class, which 
  39 inherits from the <TT>Servant</TT> class. The native <TT>Servant</TT> type is 
  40 defined by the <TT>PortableServer</TT> module for the POA. In Java, the 
  41   <TT>Servant</TT> type is mapped to the Java 
  42   <TT>org.omg.PortableServer.Servant</TT> class.
  43   It serves as the base class for all POA servant 
  44   implementations and provides a number of methods that may 
  45   be invoked by the application programmer, as well as methods 
  46   which are invoked by the POA itself and may be overridden by 
  47   the user to control aspects of servant behavior. 
  48   
  49 <H2>Package Specification</H2>
  50  
  51 <P>For a precise list of supported sections of official OMG specifications with which 
  52 the Java[tm] Platform, Standard Edition 6 complies, see <A 
  53 HREF="../CORBA/doc-files/compliance.html">Official Specifications for CORBA 
  54 support in Java[tm] SE 6</A>.
  55 
  56 <H2>POA-related Interfaces</H2>
  57 
  58 <P>The <TT>PortableServer</TT> module defines the following POA-related interfaces:
  59 <UL>
  60         <LI><TT>POA</TT>
  61         <LI><TT>POAManager</TT>
  62         <LI><TT>ServantManager</TT>
  63         <LI><TT>ServantActivator</TT>
  64         <LI><TT>ServantLocator</TT>
  65         <LI><TT>AdapterActivator</TT>
  66         <LI><TT>ThreadPolicy</TT>
  67         <LI><TT>LifespanPolicy</TT>
  68         <LI><TT>IdUniquenessPolicy</TT>
  69         <LI><TT>IdAssignmentPolicy</TT>
  70         <LI><TT>ImplicitActivationPolicy</TT>
  71         <LI><TT>ServantRetentionPolicy</TT>
  72         <LI><TT>RequestProcessingPolicy</TT>
  73         <LI><TT>Current</TT>
  74 </UL>
  75 
  76 <P>In addition, the POA defines the <TT>Servant</TT> native type.
  77 
  78 <H3>Operations classes</H3>
  79 
  80 <P>Each of the interfaces listed above has an associated <code>Operations</code> interface.
  81 The <code>Operations</code> interface is generated by the <code>idlj</code> compiler and
  82 contains the method signatures for methods defined in its associated interface.
  83 The <code>Operations</code> interface can be accessed by both the client and the server,
  84 while its associated interface can only be called by the client.
  85 
  86 <H3>Value Classes</H3>
  87 
  88 Classes ending in the suffix <code>PolicyValue</code> provide the values used
  89 for the <code>create_POA</code> call, which sets the policy for the POA. See
  90 the <a href="#sampleserver">sample code</a> below for a demonstration. 
  91 <code>PolicyValue</code> files include the following:
  92 <UL>
  93 <LI><code>IdAssignmentPolicyValue</code> 
  94 <LI><code>IdUniquenessPolicyValue</code>
  95 <LI><code>ImplicitActivationPolicyValue</code>
  96 <LI><code>LifespanPolicyValue</code>


 131 The remaining interfaces will be provided by the ORB implementation.
 132 The interfaces of interest to application programmers are the following:
 133 <ul>
 134   <LI><code>AdapterActivator</code>
 135   <P>Adapter activators are associated with POAs. 
 136   An adapter activator supplies a POA with the ability to create child POAs on demand,
 137   as a side-effect of receiving a request that names the child POA (or one of its children),
 138   or when <code>find_POA</code> is called with an activate parameter value of <code>TRUE</code>.
 139   An application server that creates all its needed POAs at the beginning of execution
 140   does not need to use or provide an adapter activator; it is necessary
 141   only for the case in which POAs need to be created during request processing.
 142   <LI><code>ServantLocator</code>
 143   <P>When the POA has the <code>NON_RETAIN</code> policy,
 144   it uses servant managers that are <code>ServantLocator</code>s.
 145   <LI><code>ServantActivator</code>
 146   <P>When the POA has the <code>RETAIN</code> policy,
 147   it uses servant managers that are <code>ServantActivator</code>s.
 148 </ul>
 149 
 150 
 151 <H2>Package <TT>org.omg.PortableServer.ServantLocatorPackage</TT></H2>
 152 
 153 <P>This package supplies a <TT>CookieHolder</TT> class for passing 
 154 the <TT>Cookie</TT> type as an <code>out</code> parameter. The <code>CookieHolder</code> class 
 155 follows exactly the same pattern as the other holder classes for basic types.
 156 
 157 <H2>Related Documentation</H2>
 158 
 159 <P>For an overview of Java IDL, please see:
 160 <A HREF="../../../../technotes/guides/idl/index.html">Java IDL home page</A>.
 161 
 162 <H2>Example Code</H2>
 163 <a name="sampleserver"></a>
 164 <H3>Example Server Code</H3>
 165 <PRE>
 166 import javax.naming.InitialContext;
 167 import javax.naming.Context;
 168 import javax.rmi.PortableRemoteObject ;
 169 import com.sun.corba.se.impl.poa.POAORB;
 170 import org.omg.PortableServer.*;
 171 import java.util.*;
 172 import org.omg.CORBA.*;
 173 import javax.rmi.CORBA.Stub;
 174 import javax.rmi.CORBA.Util;






  18  version 2 for more details (a copy is included in the LICENSE file that
  19  accompanied this code).
  20 
  21  You should have received a copy of the GNU General Public License version
  22  2 along with this work; if not, write to the Free Software Foundation,
  23  Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  24 
  25  Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  26  or visit www.oracle.com if you need additional information or have any
  27  questions.
  28 
  29 
  30 -->
  31 
  32 </head>
  33 <body bgcolor="white">
  34 Provides classes and interfaces for making the server side of your applications 
  35 portable across multivendor ORBs.
  36 
  37 <P>In Java, Portable Object Adaptor (POA)-based Dynamic Skeleton Interface (DSI)
  38 servants inherit from the  standard <code>DynamicImplementation</code> class, which
  39 inherits from the <code>Servant</code> class. The native <code>Servant</code> type is
  40 defined by the <code>PortableServer</code> module for the POA. In Java, the
  41   <code>Servant</code> type is mapped to the Java
  42   <code>org.omg.PortableServer.Servant</code> class.
  43   It serves as the base class for all POA servant
  44   implementations and provides a number of methods that may
  45   be invoked by the application programmer, as well as methods
  46   which are invoked by the POA itself and may be overridden by
  47   the user to control aspects of servant behavior.
  48   
  49 <H2>Package Specification</H2>
  50  
  51 <P>For a precise list of supported sections of official OMG specifications with which
  52 the Java[tm] Platform, Standard Edition 6 complies, see <A
  53 HREF="../CORBA/doc-files/compliance.html">Official Specifications for CORBA
  54 support in Java[tm] SE 6</A>.
  55 
  56 <H2>POA-related Interfaces</H2>
  57 
  58 <P>The <code>PortableServer</code> module defines the following POA-related interfaces:
  59 <UL>
  60         <LI><code>POA</code>
  61         <LI><code>POAManager</code>
  62         <LI><code>ServantManager</code>
  63         <LI><code>ServantActivator</code>
  64         <LI><code>ServantLocator</code>
  65         <LI><code>AdapterActivator</code>
  66         <LI><code>ThreadPolicy</code>
  67         <LI><code>LifespanPolicy</code>
  68         <LI><code>IdUniquenessPolicy</code>
  69         <LI><code>IdAssignmentPolicy</code>
  70         <LI><code>ImplicitActivationPolicy</code>
  71         <LI><code>ServantRetentionPolicy</code>
  72         <LI><code>RequestProcessingPolicy</code>
  73         <LI><code>Current</code>
  74 </UL>
  75 
  76 <P>In addition, the POA defines the <code>Servant</code> native type.
  77 
  78 <H3>Operations classes</H3>
  79 
  80 <P>Each of the interfaces listed above has an associated <code>Operations</code> interface.
  81 The <code>Operations</code> interface is generated by the <code>idlj</code> compiler and
  82 contains the method signatures for methods defined in its associated interface.
  83 The <code>Operations</code> interface can be accessed by both the client and the server,
  84 while its associated interface can only be called by the client.
  85 
  86 <H3>Value Classes</H3>
  87 
  88 Classes ending in the suffix <code>PolicyValue</code> provide the values used
  89 for the <code>create_POA</code> call, which sets the policy for the POA. See
  90 the <a href="#sampleserver">sample code</a> below for a demonstration.
  91 <code>PolicyValue</code> files include the following:
  92 <UL>
  93 <LI><code>IdAssignmentPolicyValue</code>
  94 <LI><code>IdUniquenessPolicyValue</code>
  95 <LI><code>ImplicitActivationPolicyValue</code>
  96 <LI><code>LifespanPolicyValue</code>


 131 The remaining interfaces will be provided by the ORB implementation.
 132 The interfaces of interest to application programmers are the following:
 133 <ul>
 134   <LI><code>AdapterActivator</code>
 135   <P>Adapter activators are associated with POAs.
 136   An adapter activator supplies a POA with the ability to create child POAs on demand,
 137   as a side-effect of receiving a request that names the child POA (or one of its children),
 138   or when <code>find_POA</code> is called with an activate parameter value of <code>TRUE</code>.
 139   An application server that creates all its needed POAs at the beginning of execution
 140   does not need to use or provide an adapter activator; it is necessary
 141   only for the case in which POAs need to be created during request processing.
 142   <LI><code>ServantLocator</code>
 143   <P>When the POA has the <code>NON_RETAIN</code> policy,
 144   it uses servant managers that are <code>ServantLocator</code>s.
 145   <LI><code>ServantActivator</code>
 146   <P>When the POA has the <code>RETAIN</code> policy,
 147   it uses servant managers that are <code>ServantActivator</code>s.
 148 </ul>
 149 
 150 
 151 <H2>Package <code>org.omg.PortableServer.ServantLocatorPackage</code></H2>
 152 
 153 <P>This package supplies a <code>CookieHolder</code> class for passing
 154 the <code>Cookie</code> type as an <code>out</code> parameter. The <code>CookieHolder</code> class
 155 follows exactly the same pattern as the other holder classes for basic types.
 156 
 157 <H2>Related Documentation</H2>
 158 
 159 <P>For an overview of Java IDL, please see:
 160 <A HREF="../../../../technotes/guides/idl/index.html">Java IDL home page</A>.
 161 
 162 <H2>Example Code</H2>
 163 <a name="sampleserver"></a>
 164 <H3>Example Server Code</H3>
 165 <PRE>
 166 import javax.naming.InitialContext;
 167 import javax.naming.Context;
 168 import javax.rmi.PortableRemoteObject ;
 169 import com.sun.corba.se.impl.poa.POAORB;
 170 import org.omg.PortableServer.*;
 171 import java.util.*;
 172 import org.omg.CORBA.*;
 173 import javax.rmi.CORBA.Stub;
 174 import javax.rmi.CORBA.Util;







< prev index next >