org.acplt.oncrpc.XdrDynamicOpaque Maven / Gradle / Ivy
/*
* $Header: /cvsroot/remotetea/remotetea/src/org/acplt/oncrpc/XdrDynamicOpaque.java,v 1.1.1.1 2003/08/13 12:03:44 haraldalbrecht Exp $
*
* Copyright (c) 1999, 2000
* Lehrstuhl fuer Prozessleittechnik (PLT), RWTH Aachen
* D-52064 Aachen, Germany.
* All rights reserved.
*
* This library is free software; you can redistribute it and/or modify
* it under the terms of the GNU Library General Public License as
* published by the Free Software Foundation; either version 2 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 Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this program (see the file COPYING.LIB for more
* details); if not, write to the Free Software Foundation, Inc.,
* 675 Mass Ave, Cambridge, MA 02139, USA.
*/
package org.acplt.oncrpc;
import java.io.IOException;
/**
* Instances of the class XdrDynamicOpaque represent (de-)serializeable
* dynamic-size opaque values, which are especially useful in cases where a result with only a
* single opaque value is expected from a remote function call or only a single
* opaque value parameter needs to be supplied.
*
* Please note that this class is somewhat modelled after Java's primitive
* data type wrappers. As for these classes, the XDR data type wrapper classes
* follow the concept of values with no identity, so you are not allowed to
* change the value after you've created a value object.
*
* @version $Revision: 1.1.1.1 $ $Date: 2003/08/13 12:03:44 $ $State: Exp $ $Locker: $
* @author Harald Albrecht
*/
public class XdrDynamicOpaque implements XdrAble {
/**
* Constructs and initializes a new XdrDynamicOpaque object.
*/
public XdrDynamicOpaque() {
this.value = null;
}
/**
* Constructs and initializes a new XdrDynamicOpaque object.
*/
public XdrDynamicOpaque(byte [] value) {
this.value = value;
}
/**
* Returns the value of this XdrDynamicOpaque object as a byte
* vector.
*
* @return The primitive byte[] value of this object.
*/
public byte [] dynamicOpaqueValue() {
return this.value;
}
/**
* Encodes -- that is: serializes -- a XDR opaque into a XDR stream in
* compliance to RFC 1832.
*
* @throws OncRpcException if an ONC/RPC error occurs.
* @throws IOException if an I/O error occurs.
*/
public void xdrEncode(XdrEncodingStream xdr)
throws OncRpcException, IOException
{
xdr.xdrEncodeDynamicOpaque(value);
}
/**
* Decodes -- that is: deserializes -- a XDR opaque from a XDR stream in
* compliance to RFC 1832.
*
* @throws OncRpcException if an ONC/RPC error occurs.
* @throws IOException if an I/O error occurs.
*/
public void xdrDecode(XdrDecodingStream xdr)
throws OncRpcException, IOException
{
value = xdr.xdrDecodeDynamicOpaque();
}
/**
* The encapsulated opaque value itself.
*/
private byte [] value;
}
// End of XdrDynamicOpaque.java