com.scaleout.client.ighosting

Class InvocationWorkerBuilder

java.lang.Object

com.scaleout.client.ighosting.InvocationWorkerBuilder

public class InvocationWorkerBuilder
extends java.lang.Object

InvocationWorkerBuilder is used to instantiate an InvocationWorker.

Constructor Summary

Constructors

Constructor and Description
InvocationWorkerBuilder() Begin constructing the InvocationWorker.
InvocationWorkerBuilder(InvocationGridStartup startup) Begin constructing the InvocationWorker.
InvocationWorkerBuilder(java.util.Properties properties) Begin constructing the InvocationWorker.
InvocationWorkerBuilder(java.lang.String additionalConnectionStringProperties) Begin constructing the InvocationWorker.
InvocationWorkerBuilder(java.lang.String additionalConnectionStringProperties, InvocationGridStartup startup) Begin constructing the InvocationWorker.

Method Summary

Modifier and Type	Method and Description
InvocationWorker	build() Builds the InvocationWorker as specified by the constructor and optional changes.
GridConnection	getGridConnection() Retrieve the GridConnection used by this builder.
int	getInvocationGridId() Retrieve the InvocationGrid ID used by this builder.
InvocationWorkerBuilder	withInvocationGridSignalHandler(InvocationGridSignal signal, InvocationGridSignalHandler handler) Adds an extra user defined InvocationGridSignalHandler for the defined InvocationGridSignal.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InvocationWorkerBuilder

public InvocationWorkerBuilder()

Begin constructing the InvocationWorker. Default connection string used: "bootstrapGateways=127.0.0.1:721;maxPoolSize=4" Will attempt to load default configuration from "ig.properties", if found in resources of executing JAR.

InvocationWorkerBuilder

public InvocationWorkerBuilder(java.lang.String additionalConnectionStringProperties)

Begin constructing the InvocationWorker. Connection string used will append parameter additional properties: "bootstrapGateways=127.0.0.1:721;%s"

Parameters:

additionalConnectionStringProperties - additional connection string properties.

InvocationWorkerBuilder

public InvocationWorkerBuilder(InvocationGridStartup startup)

Begin constructing the InvocationWorker. Parameter InvocationGridStartup will be called once InvocationWorker is built and InvocationWorker.waitForEvents() is called. Default connection string used: "bootstrapGateways=127.0.0.1:721;maxPoolSize=4"

Parameters:

startup - a user defined InvocationGridStartup callback.

InvocationWorkerBuilder

public InvocationWorkerBuilder(java.lang.String additionalConnectionStringProperties,
                               InvocationGridStartup startup)

Begin constructing the InvocationWorker. Parameter InvocationGridStartup will be called once InvocationWorker is built and InvocationWorker.waitForEvents() is called. Connection string used will append parameter additional properties: "bootstrapGateways=127.0.0.1:721;%s"

Parameters:

additionalConnectionStringProperties - additional connection string properties.

startup - a user defined InvocationGridStartup callback.

InvocationWorkerBuilder

public InvocationWorkerBuilder(java.util.Properties properties)

Begin constructing the InvocationWorker. Builder will attempt to create connection string from properties if the "ig.connectionstring" property is defined. The value of this property should be a formated string with the form: "bootstrapGateways=127.0.0.1:%s;maxPoolSize=4;" If the property is not found then the default connection string will be used. Builder will attempt to load a startup call from properties if the "ig.startup" property is defined. If found, the InvocationGridStartup will be called once InvocationWorker is built and InvocationWorker.waitForEvents() is called. Connection string used will append parameter additional properties: "bootstrapGateways=127.0.0.1:721;%s"

Parameters:

properties - properties file that should load the invocation grid configuration.

Method Detail

withInvocationGridSignalHandler

public InvocationWorkerBuilder withInvocationGridSignalHandler(InvocationGridSignal signal,
                                                               InvocationGridSignalHandler handler)

Adds an extra user defined InvocationGridSignalHandler for the defined InvocationGridSignal.

Parameters:

signal - the signal type.

handler - the handler type.

Returns:

this builder.

getGridConnection

public GridConnection getGridConnection()

Retrieve the GridConnection used by this builder.

Returns:

the GridConnection.

getInvocationGridId

public int getInvocationGridId()

Retrieve the InvocationGrid ID used by this builder.

Returns:

the invocation grid id.

build

public InvocationWorker build()
                       throws GridConnectException

Builds the InvocationWorker as specified by the constructor and optional changes.

Returns:

the InvocationWorker

Throws:

GridConnectException - if the builder is unable to connect to the ScaleOut StateServer service.