1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266
/* * @(#)RemoteObjectInvocationHandler.java 1.5 05/11/17 * * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package java.rmi.server; import java.io.InvalidObjectException; import java.lang.reflect.InvocationHandler; import java.lang.reflect.Method; import java.lang.reflect.Proxy; import java.rmi.Remote; import java.rmi.UnexpectedException; import java.rmi.activation.Activatable; import java.util.Map; import java.util.WeakHashMap; import sun.rmi.server.Util; import sun.rmi.server.WeakClassHashMap; /** * An implementation of the <code>InvocationHandler</code> interface for * use with Java Remote Method Invocation (Java RMI). This invocation * handler can be used in conjunction with a dynamic proxy instance as a * replacement for a pregenerated stub class. * * <p>Applications are not expected to use this class directly. A remote * object exported to use a dynamic proxy with {@link UnicastRemoteObject} * or {@link Activatable} has an instance of this class as that proxy's * invocation handler. * * @version 1.5, 05/11/17 * @author Ann Wollrath * @since 1.5 **/ public class RemoteObjectInvocationHandler extends RemoteObject implements InvocationHandler { private static final long serialVersionUID = 2L; /** * A weak hash map, mapping classes to weak hash maps that map * method objects to method hashes. **/ private static final MethodToHash_Maps methodToHash_Maps = new MethodToHash_Maps(); /** * Creates a new <code>RemoteObjectInvocationHandler</code> constructed * with the specified <code>RemoteRef</code>. * * @param ref the remote ref * * @throws NullPointerException if <code>ref</code> is <code>null</code> **/ public RemoteObjectInvocationHandler(RemoteRef ref) { super(ref); if (ref == null) { throw new NullPointerException(); } } /** * Processes a method invocation made on the encapsulating * proxy instance, <code>proxy</code>, and returns the result. * * <p><code>RemoteObjectInvocationHandler</code> implements this method * as follows: * * <p>If <code>method</code> is one of the following methods, it * is processed as described below: * * <ul> * * <li>{@link Object#hashCode Object.hashCode}: Returns the hash * code value for the proxy. * * <li>{@link Object#equals Object.equals}: Returns <code>true</code> * if the argument (<code>args[0]</code>) is an instance of a dynamic * proxy class and this invocation handler is equal to the invocation * handler of that argument, and returns <code>false</code> otherwise. * * <li>{@link Object#toString Object.toString}: Returns a string * representation of the proxy. * </ul> * * <p>Otherwise, a remote call is made as follows: * * <ul> * <li>If <code>proxy</code> is not an instance of the interface * {@link Remote}, then an {@link IllegalArgumentException} is thrown. * * <li>Otherwise, the {@link RemoteRef#invoke invoke} method is invoked * on this invocation handler's <code>RemoteRef</code>, passing * <code>proxy</code>, <code>method</code>, <code>args</code>, and the * method hash (defined in section 8.3 of the "Java Remote Method * Invocation (RMI) Specification") for <code>method</code>, and the * result is returned. * * <li>If an exception is thrown by <code>RemoteRef.invoke</code> and * that exception is a checked exception that is not assignable to any * exception in the <code>throws</code> clause of the method * implemented by the <code>proxy</code>'s class, then that exception * is wrapped in an {@link UnexpectedException} and the wrapped * exception is thrown. Otherwise, the exception thrown by * <code>invoke</code> is thrown by this method. * </ul> * * <p>The semantics of this method are unspecified if the * arguments could not have been produced by an instance of some * valid dynamic proxy class containing this invocation handler. * * @param proxy the proxy instance that the method was invoked on * @param method the <code>Method</code> instance corresponding to the * interface method invoked on the proxy instance * @param args an array of objects containing the values of the * arguments passed in the method invocation on the proxy instance, or * <code>null</code> if the method takes no arguments * @return the value to return from the method invocation on the proxy * instance * @throws Throwable the exception to throw from the method invocation * on the proxy instance * @see **/ public Object invoke(Object proxy, Method method, Object[] args) throws Throwable { if (method.getDeclaringClass() == Object.class) { return invokeObjectMethod(proxy, method, args); } else { return invokeRemoteMethod(proxy, method, args); } } /** * Handles java.lang.Object methods. **/ private Object invokeObjectMethod(Object proxy, Method method, Object[] args) { String name = method.getName(); if (name.equals("hashCode")) { return hashCode(); } else if (name.equals("equals")) { Object obj = args[0]; return proxy == obj || (obj != null && Proxy.isProxyClass(obj.getClass()) && equals(Proxy.getInvocationHandler(obj))); } else if (name.equals("toString")) { return proxyToString(proxy); } else { throw new IllegalArgumentException( "unexpected Object method: " + method); } } /** * Handles remote methods. **/ private Object invokeRemoteMethod(Object proxy, Method method, Object[] args) throws Exception { try { if (!(proxy instanceof Remote)) { throw new IllegalArgumentException( "proxy not Remote instance"); } return ref.invoke((Remote) proxy, method, args, getMethodHash(method)); } catch (Exception e) { if (!(e instanceof RuntimeException)) { Class<?> cl = proxy.getClass(); try { method = cl.getMethod(method.getName(), method.getParameterTypes()); } catch (NoSuchMethodException nsme) { throw (IllegalArgumentException) new IllegalArgumentException().initCause(nsme); } Class<?> thrownType = e.getClass(); for (Class<?> declaredType : method.getExceptionTypes()) { if (declaredType.isAssignableFrom(thrownType)) { throw e; } } e = new UnexpectedException("unexpected exception", e); } throw e; } } /** * Returns a string representation for a proxy that uses this invocation * handler. **/ private String proxyToString(Object proxy) { Class<?>[] interfaces = proxy.getClass().getInterfaces(); if (interfaces.length == 0) { return "Proxy[" + this + "]"; } String iface = interfaces[0].getName(); if (iface.equals("java.rmi.Remote") && interfaces.length > 1) { iface = interfaces[1].getName(); } int dot = iface.lastIndexOf('.'); if (dot >= 0) { iface = iface.substring(dot + 1); } return "Proxy[" + iface + "," + this + "]"; } /** * @throws InvalidObjectException unconditionally **/ private void readObjectNoData() throws InvalidObjectException { throw new InvalidObjectException("no data in stream; class: " + this.getClass().getName()); } /** * Returns the method hash for the specified method. Subsequent calls * to "getMethodHash" passing the same method argument should be faster * since this method caches internally the result of the method to * method hash mapping. The method hash is calculated using the * "computeMethodHash" method. * * @param method the remote method * @return the method hash for the specified method */ private static long getMethodHash(Method method) { return methodToHash_Maps.get(method.getDeclaringClass()).get(method); } /** * A weak hash map, mapping classes to weak hash maps that map * method objects to method hashes. **/ private static class MethodToHash_Maps extends WeakClassHashMap<Map<Method,Long>> { MethodToHash_Maps() {} protected Map<Method,Long> computeValue(Class<?> remoteClass) { return new WeakHashMap<Method,Long>() { public synchronized Long get(Object key) { Long hash = super.get(key); if (hash == null) { Method method = (Method) key; hash = Util.computeMethodHash(method); put(method, hash); } return hash; } }; } } }