/**************************************************************************
* Copyright (c) 2001 by Punch Telematix. All rights reserved. *
* *
* Redistribution and use in source and binary forms, with or without *
* modification, are permitted provided that the following conditions *
* are met: *
* 1. Redistributions of source code must retain the above copyright *
* notice, this list of conditions and the following disclaimer. *
* 2. Redistributions in binary form must reproduce the above copyright *
* notice, this list of conditions and the following disclaimer in the *
* documentation and/or other materials provided with the distribution. *
* 3. Neither the name of Punch Telematix nor the names of *
* other contributors may be used to endorse or promote products *
* derived from this software without specific prior written permission.*
* *
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED *
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF *
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. *
* IN NO EVENT SHALL PUNCH TELEMATIX OR OTHER CONTRIBUTORS BE LIABLE *
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR *
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF *
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR *
* BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, *
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE *
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN *
* IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
**************************************************************************/
package wonka.rmi;
import java.io.IOException;
import java.io.ObjectInput;
import java.io.ObjectOutput;
import java.lang.reflect.Method;
import java.net.Socket;
import java.rmi.Remote;
import java.rmi.RemoteException;
import java.rmi.server.ObjID;
import java.rmi.server.Operation;
import java.rmi.server.RMIClientSocketFactory;
import java.rmi.server.RemoteCall;
import java.rmi.server.RemoteObject;
import java.rmi.server.RemoteRef;
/**
* Implementation class for rmi unicast references with custom client socket factories.
*/
public class UnicastRef2 implements RemoteRef {
static final String REF_TYPE = "UnicastRef2";
private String address;
private int port;
private ObjID id;
private RMIClientSocketFactory csf;
/**
* Default non-arg constructor.
*/
public UnicastRef2(){
csf = DefaultRMISocketFactory.theDefault;
}
/**
* Constructor.
*
* @param address Host address
* @param port Portnumber
* @param id Object identifier
* @param csf Client socket factory
*/
public UnicastRef2(String address, int port, ObjID id, RMIClientSocketFactory csf){
this.address = address;
this.port = port;
this.id = id;
this.csf = (csf != null ? csf : DefaultRMISocketFactory.theDefault);
}
/**
* Returns the class name of the ref type to be serialized onto the stream 'out'.
*
* @param out the output stream to which the reference will be serialized
* @return the class name (without package qualification) of the reference type
*/
public String getRefClass(ObjectOutput out) {
return REF_TYPE;
}
/**
* Invoke a method. This form of delegating method invocation to the reference allows
* the reference to take care of setting up the connection to the remote host, marshaling
* some representation for the method and parameters, then communicating the method invocation
* to the remote host. This method either returns the result of a method invocation on the remote
* object which resides on the remote host or throws a RemoteException if the call failed or an
* application-level exception if the remote invocation throws an exception.
*
* @param obj the object that contains the RemoteRef (e.g., the RemoteStub for the object.
* @param method the method to be invoked
* @param params the parameter list
* @param opnum a hash that may be used to represent the method
* @return result of remote method invocation
* @exception Exception if any exception occurs during remote method invocation
*/
public Object invoke(Remote obj, Method method, Object[] params, long opnum) throws Exception {
if(RMIConnection.DEBUG < 6) {System.out.println("creating socket to "+address+" @ "+port+" using "+csf);}
Socket s = csf.createSocket(address, port);
if(RMIConnection.DEBUG < 6) {System.out.println("invoking "+method);}
Object o;
Class ret = method.getReturnType();
boolean type = (ret != Void.TYPE);
if(type && ret.isPrimitive()){
o = RMIConnection.requestPrimitive(s, opnum, -1, id, new ParameterSet(method,params), ret);
}
else {
o = RMIConnection.requestObject(s, opnum, -1, id, new ParameterSet(method,params),type);
}
if(RMIConnection.DEBUG < 6) {System.out.println("Done invoking "+method+" got "+o);}
return o;
}
/**
* Compares two remote objects for equality. Returns a boolean that indicates whether this remote object is
* equivalent to the specified Object. This method is used when a remote object is stored in a hashtable.
*
* @param obj the Object to compare with
* @return true if these Objects are equal; false otherwise.
*/
public boolean remoteEquals(RemoteRef obj) {
if (obj instanceof UnicastRef2) {
UnicastRef2 ref = (UnicastRef2)obj;
return ( address.equals(ref.address) && (port == ref.port) && id.equals(ref.id) );
}
return false;
}
/**
* Returns a hashcode for a remote object. Two remote object stubs that refer to the same remote object will
* have the same hash code (in order to support remote objects as keys in hash tables).
*
* @return remote object hashcode
*/
public int remoteHashCode(){
return hashCode();
}
/**
* Returns a String that represents the reference of this remote object.
*/
public String remoteToString(){
return toString();
}
/**
* The object implements the <code>readExternal</code> method to restore its contents by calling the methods
* of <code>DataInput</code> for primitive types and <code>readObject</code> for objects, strings and arrays.
* The <code>readExternal</code> method must read the values in the same sequence and with the same types as
* were written by <code>writeExternal</code>.
*
* @param in the stream to read data from in order to restore the object
* @exception IOException if I/O errors occur
* @exception ClassNotFoundException If the class for an object being restored cannot be found
*/
public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException {
final byte useClientSocket = in.readByte();
address = in.readUTF();
port = in.readInt();
if (useClientSocket == 0x01) {
csf = (RMIClientSocketFactory)in.readObject();
}
id = ObjID.read(in);
//final boolean bool =
in.readBoolean();
}
/**
* The object implements the <code>writeExternal</code> method to save its contents by calling the methods of
* <code>DataOutput</code> for its primitive values or calling the <code>writeObject</code> method of
* <code>ObjectOutput</code> for objects, strings, and arrays.
*
* @param out the stream to write the object to
* @exception IOException Includes any I/O exceptions that may occur
*/
public void writeExternal(ObjectOutput out) throws IOException {
boolean writeFactory = false;
if ( csf.equals(DefaultRMISocketFactory.theDefault) ) {
out.writeByte(0x00);
}
else {
out.writeByte(0x01);
writeFactory = true;
}
out.writeUTF(address);
out.writeInt(port);
if (writeFactory) {
out.writeObject(csf);
}
id.write(out);
out.writeBoolean(false);
}
/**
* Returns a string representation of this object.
*/
public String toString() {
StringBuffer str = new StringBuffer( super.toString() );
// TBD: Conform SUN toString
return str.toString();
}
/**
** @deprecated
*/
public void invoke(RemoteCall call) throws Exception {
throw new RemoteException("UnsupportedOperation -- deprecated method");
}
/**
** @deprecated
*/
public void done(RemoteCall call) throws RemoteException {
throw new RemoteException("UnsupportedOperation -- deprecated method");
}
/**
* @deprecated
*/
public RemoteCall newCall(RemoteObject obj, Operation[] op, int opnum, long hash) throws RemoteException {
throw new RemoteException("UnsupportedOperation -- deprecated method");
}
}