MethodTransferProperties

package saker.build.thirdparty.saker.rmi.connection

public final class MethodTransferProperties extends ExecutableTransferProperties<Method>

saker.build.thirdparty.saker.rmi.connection.MethodTransferProperties

saker.build.thirdparty.saker.rmi.connection.ExecutableTransferProperties<Method>

java.lang.Object

Describes the properties for a method for use with RMI.

This class describes the serialization of the parameters, result and also specifies how the method will be called.

The Builder should be used for construction, or the constructor MethodTransferProperties(Method) for annotation based properties parsing.

Nested types

public static final class	Builder Builder class for custom construction of method properties.

Constructors

public	MethodTransferProperties(Method method) Creates an instance by examining the provided annotations on the given method.

Methods

public static Builder	builder(Method method) Creates a new builder instance for this class.
public static RMIObjectWriteHandler	createWriteHandlerForMethod(Method method) Creates a return value write handler for the given method.
public Constructor<? extends Throwable>	getRMIExceptionRethrowConstructor() Returns the constructor of the exception which should be used to rethrown RMI errors.
public Method	getRedirectMethod() Returns non-`null` if the RMI method calls should be redirected to a specified method.
public Class<?>	getReturnType() Gets the return type of the method.
public RMIObjectWriteHandler	getReturnValueWriter() Gets the write handler for the return value of the method.
public boolean	isCacheResult() Returns if the method result should be cached for future calls.
public boolean	isDefaultOnFailure() Returns if the default method should be called in case of RMI failure.
public boolean	isForbidden() Returns if the method is not allowed to be called through RMI.
public boolean	propertiesEquals(ExecutableTransferProperties<?> other) Checks if the properties defined by this instance equals to the ones specified by the parameter.

Inherited methods
From: ExecutableTransferProperties<Method> getExecutable, getParameterWriter
From: Object clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

public MethodTransferProperties(Method method) throws RMIInvalidConfigurationException

Creates an instance by examining the provided annotations on the given method.

The annotations of the given method is examined and a configuration is parsed for use.

See the possible method and parameter annotations for more information. (package saker.rmi.annot.invoke and package saker.rmi.annot.transfer)

methodThe method for this properties.

RMIInvalidConfigurationExceptionIf the configuration is invalid.

public static Builder builder(Method method)

Creates a new builder instance for this class.

methodThe method to create the builder for.

The builder instance.

public static RMIObjectWriteHandler createWriteHandlerForMethod(Method method) throws RMIInvalidConfigurationException

Creates a return value write handler for the given method.

The annotations on the method is parsed and the write handler is determined.

methodThe method to create the return value write handler for.

The write handler.

RMIInvalidConfigurationExceptionIn case of invalid configuration.

public Constructor<? extends Throwable> getRMIExceptionRethrowConstructor()

Returns the constructor of the exception which should be used to rethrown RMI errors.

Non-null if an exception rethrow type was specified.

RMIExceptionRethrow

public Method getRedirectMethod()

Returns non-null if the RMI method calls should be redirected to a specified method.

The method to redirect the calls to or null.

RMIRedirect

public Class<?> getReturnType()

Gets the return type of the method.

The return type.

public RMIObjectWriteHandler getReturnValueWriter()

Gets the write handler for the return value of the method.

The returned writer will be used when the method is invoked by a remote client.

The write handler.

public boolean isCacheResult()

Returns if the method result should be cached for future calls.

true if the result should be cached.

RMICacheResult

public boolean isDefaultOnFailure()

Returns if the default method should be called in case of RMI failure.

true if the default method should be called.

RMIDefaultOnFailure

public boolean isForbidden()

Returns if the method is not allowed to be called through RMI.

When designing security sensitive applications, if this method returns true on the server side, it doesn't protect against remote calls issued by the client. I.e. The forbidden method may still be called by a malicious client.

true if the method may not be called.

RMIForbidden

public boolean propertiesEquals(ExecutableTransferProperties<?> other)

Overridden from: ExecutableTransferProperties

Checks if the properties defined by this instance equals to the ones specified by the parameter.

Equality is not checked for the enclosed executable. Two properties can equal regardless off the executable they are defined for.

otherThe other properties.

true if the two properties equal.