org.apache.flink.runtime.rpc.messages.RemoteRpcInvocation Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.flink.runtime.rpc.messages;
import org.apache.flink.util.Preconditions;
import org.apache.flink.util.SerializedValue;
import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.io.Serializable;
/**
* Remote rpc invocation message which is used when the actor communication is remote and, thus, the
* message has to be serialized.
*
* In order to fail fast and report an appropriate error message to the user, the method name, the
* parameter types and the arguments are eagerly serialized. In case the invocation call
* contains a non-serializable object, then an {@link IOException} is thrown.
*/
public class RemoteRpcInvocation implements RpcInvocation, Serializable {
private static final long serialVersionUID = 6179354390913843809L;
// Serialized invocation data
private SerializedValue serializedMethodInvocation;
// Transient field which is lazily initialized upon first access to the invocation data
private transient RemoteRpcInvocation.MethodInvocation methodInvocation;
private transient String toString;
public RemoteRpcInvocation(
final String methodName,
final Class[] parameterTypes,
final Object[] args) throws IOException {
serializedMethodInvocation = new SerializedValue<>(new RemoteRpcInvocation.MethodInvocation(methodName, parameterTypes, args));
methodInvocation = null;
}
@Override
public String getMethodName() throws IOException, ClassNotFoundException {
deserializeMethodInvocation();
return methodInvocation.getMethodName();
}
@Override
public Class[] getParameterTypes() throws IOException, ClassNotFoundException {
deserializeMethodInvocation();
return methodInvocation.getParameterTypes();
}
@Override
public Object[] getArgs() throws IOException, ClassNotFoundException {
deserializeMethodInvocation();
return methodInvocation.getArgs();
}
@Override
public String toString() {
if (toString == null) {
try {
Class[] parameterTypes = getParameterTypes();
String methodName = getMethodName();
StringBuilder paramTypeStringBuilder = new StringBuilder(parameterTypes.length * 5);
if (parameterTypes.length > 0) {
paramTypeStringBuilder.append(parameterTypes[0].getSimpleName());
for (int i = 1; i < parameterTypes.length; i++) {
paramTypeStringBuilder
.append(", ")
.append(parameterTypes[i].getSimpleName());
}
}
toString = "RemoteRpcInvocation(" + methodName + '(' + paramTypeStringBuilder + "))";
} catch (IOException | ClassNotFoundException e) {
toString = "Could not deserialize RemoteRpcInvocation: " + e.getMessage();
}
}
return toString;
}
/**
* Size (#bytes of the serialized data) of the rpc invocation message.
*
* @return Size of the remote rpc invocation message
*/
public long getSize() {
return serializedMethodInvocation.getByteArray().length;
}
private void deserializeMethodInvocation() throws IOException, ClassNotFoundException {
if (methodInvocation == null) {
methodInvocation = serializedMethodInvocation.deserializeValue(ClassLoader.getSystemClassLoader());
}
}
// -------------------------------------------------------------------
// Serialization methods
// -------------------------------------------------------------------
private void writeObject(ObjectOutputStream oos) throws IOException {
oos.writeObject(serializedMethodInvocation);
}
@SuppressWarnings("unchecked")
private void readObject(ObjectInputStream ois) throws IOException, ClassNotFoundException {
serializedMethodInvocation = (SerializedValue) ois.readObject();
methodInvocation = null;
}
// -------------------------------------------------------------------
// Utility classes
// -------------------------------------------------------------------
/**
* Wrapper class for the method invocation information
*/
private static final class MethodInvocation implements Serializable {
private static final long serialVersionUID = 9187962608946082519L;
private String methodName;
private Class[] parameterTypes;
private Object[] args;
private MethodInvocation(final String methodName, final Class[] parameterTypes, final Object[] args) {
this.methodName = methodName;
this.parameterTypes = Preconditions.checkNotNull(parameterTypes);
this.args = args;
}
String getMethodName() {
return methodName;
}
Class[] getParameterTypes() {
return parameterTypes;
}
Object[] getArgs() {
return args;
}
private void writeObject(ObjectOutputStream oos) throws IOException {
oos.writeUTF(methodName);
oos.writeInt(parameterTypes.length);
for (Class parameterType : parameterTypes) {
oos.writeObject(parameterType);
}
if (args != null) {
oos.writeBoolean(true);
for (int i = 0; i < args.length; i++) {
try {
oos.writeObject(args[i]);
} catch (IOException e) {
throw new IOException("Could not serialize " + i + "th argument of method " +
methodName + ". This indicates that the argument type " +
args.getClass().getName() + " is not serializable. Arguments have to " +
"be serializable for remote rpc calls.", e);
}
}
} else {
oos.writeBoolean(false);
}
}
private void readObject(ObjectInputStream ois) throws IOException, ClassNotFoundException {
methodName = ois.readUTF();
int length = ois.readInt();
parameterTypes = new Class[length];
for (int i = 0; i < length; i++) {
try {
parameterTypes[i] = (Class) ois.readObject();
} catch (IOException e) {
throw new IOException("Could not deserialize " + i + "th parameter type of method " +
methodName + '.', e);
} catch (ClassNotFoundException e) {
throw new ClassNotFoundException("Could not deserialize " + i + "th " +
"parameter type of method " + methodName + ". This indicates that the parameter " +
"type is not part of the system class loader.", e);
}
}
boolean hasArgs = ois.readBoolean();
if (hasArgs) {
args = new Object[length];
for (int i = 0; i < length; i++) {
try {
args[i] = ois.readObject();
} catch (IOException e) {
throw new IOException("Could not deserialize " + i + "th argument of method " +
methodName + '.', e);
} catch (ClassNotFoundException e) {
throw new ClassNotFoundException("Could not deserialize " + i + "th " +
"argument of method " + methodName + ". This indicates that the argument " +
"type is not part of the system class loader.", e);
}
}
} else {
args = null;
}
}
}
}