1 /*
   2  * Copyright (c) 1996, 2004, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package org.omg.CORBA;
  27 
  28 import org.omg.CORBA.portable.Streamable;
  29 import org.omg.CORBA.portable.InputStream;
  30 import org.omg.CORBA.portable.OutputStream;
  31 
  32 
  33 /**
  34  * The Holder for <tt>Principal</tt>.  For more information on
  35  * Holder files, see <a href="doc-files/generatedfiles.html#holder">
  36  * "Generated Files: Holder Files"</a>.<P>
  37  * A container class for values of type <code>Principal</code>
  38  * that is used to store "out" and "inout" parameters in IDL methods.
  39  * If an IDL method signature has an IDL <code>Principal</code> as an "out"
  40  * or "inout" parameter, the programmer must pass an instance of
  41  * <code>PrincipalHolder</code> as the corresponding
  42  * parameter in the method invocation; for "inout" parameters, the programmer
  43  * must also fill the "in" value to be sent to the server.
  44  * Before the method invocation returns, the ORB will fill in the
  45  * value corresponding to the "out" value returned from the server.
  46  * <P>
  47  * If <code>myPrincipalHolder</code> is an instance of <code>PrincipalHolder</code>,
  48  * the value stored in its <code>value</code> field can be accessed with
  49  * <code>myPrincipalHolder.value</code>.
  50  *
  51  * @since       JDK1.2
  52  * @deprecated Deprecated by CORBA 2.2.
  53  */
  54 @Deprecated
  55 public final class PrincipalHolder implements Streamable {
  56     /**
  57      * The <code>Principal</code> value held by this <code>PrincipalHolder</code>
  58      * object.
  59      */
  60     public Principal value;
  61 
  62     /**
  63      * Constructs a new <code>PrincipalHolder</code> object with its
  64      * <code>value</code> field initialized to <code>null</code>.
  65      */
  66     public PrincipalHolder() {
  67     }
  68 
  69     /**
  70      * Constructs a new <code>PrincipalHolder</code> object with its
  71      * <code>value</code> field initialized to the given
  72      * <code>Principal</code> object.
  73      * @param initial the <code>Principal</code> with which to initialize
  74      *                the <code>value</code> field of the newly-created
  75      *                <code>PrincipalHolder</code> object
  76      */
  77     public PrincipalHolder(Principal initial) {
  78         value = initial;
  79     }
  80 
  81     public void _read(InputStream input) {
  82         value = input.read_Principal();
  83     }
  84 
  85     public void _write(OutputStream output) {
  86         output.write_Principal(value);
  87     }
  88 
  89     public org.omg.CORBA.TypeCode _type() {
  90         return ORB.init().get_primitive_tc(TCKind.tk_Principal);
  91     }
  92 
  93 }