Builder

public static final class MethodTransferProperties.Builder

saker.rmi.connection.MethodTransferProperties.Builder

java.lang.Object

Builder class for custom construction of method properties.

Constructors

public	Builder(Method method) Creates a properties builder for the given method.

Methods

public MethodTransferProperties	build() Creates the transfer properties specified by this builder.
public Builder	cacheResult(boolean cache) Sets if the result of an RMI method call should be cached for future reuse.
public Builder	defaultOnFailure(boolean defaultonfailure) Sets if the default implementation should be called for the method in case of RMI error.
public Builder	forbidden(boolean forbidden) Sets if this method is callable through RMI.
public Builder	parameterWriter(int index, RMIObjectWriteHandler writer) Sets the write handler for the parameter at the specified index.
public Builder	parameterWriters(RMIObjectWriteHandler[] writers) Sets all of write handlers for every parameter.
public Builder	redirect(Method method) Sets the method to redirect RMI calls to.
public Builder	returnWriter(RMIObjectWriteHandler writer) Sets the writer for the return value.
public Builder	rmiExceptionRethrow(Class<? extends Throwable> rethrowclass) Sets the class which to use to rethrow RMI errors.
public Builder	rmiExceptionRethrow(Constructor<? extends Throwable> rethrowconstructor) Sets the exception constructor which to use to rethrow RMI errors.

Inherited methods
From: Object clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

public Builder(Method method)

Creates a properties builder for the given method.

The annotations on the method are not taken into account.

methodThe method to create the builder for.

public MethodTransferProperties build()

Creates the transfer properties specified by this builder.

The constructed transfer properties.

public Builder cacheResult(boolean cache) throws RMIInvalidConfigurationException

Sets if the result of an RMI method call should be cached for future reuse.

cachetrue if the result should be cached.

this

RMIInvalidConfigurationExceptionIn case of invalid configuration.

RMICacheResult

public Builder defaultOnFailure(boolean defaultonfailure) throws RMIInvalidConfigurationException

Sets if the default implementation should be called for the method in case of RMI error.

defaultonfailuretrue if the default implementation should be called.

this

RMIInvalidConfigurationExceptionIn case of invalid configuration.

RMIDefaultOnFailure

public Builder forbidden(boolean forbidden) throws RMIInvalidConfigurationException

Sets if this method is callable through RMI.

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

forbiddentrue if it may not be called.

this

RMIInvalidConfigurationExceptionIn case of invalid configuration.

RMIForbidden

public Builder parameterWriter(int index, RMIObjectWriteHandler writer)

Sets the write handler for the parameter at the specified index.

indexThe index of the parameter.

writerThe write handler.

this

public Builder parameterWriters(RMIObjectWriteHandler[] writers) throws IndexOutOfBoundsException, NullPointerException

Sets all of write handlers for every parameter.

The parameter array can contain null, in which case the default write handler will be used.