Worker

java.lang.Object
- fabric.worker.Worker

```
public final class Worker
extends java.lang.Object
```
This is the main interface to the Fabric API. Applications wishing to use Fabric must first initialize it by calling one of the initialize methods, and can then use the singleton Worker instance to access Stores and Objects.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Worker.Code<T>

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Worker.Code<T>`

Field Summary

Fields
Modifier and Type	Field and Description
`SubServerSocketFactory`	`authFromAll` The subserversocket factory
`SubSocketFactory<RemoteStore>`	`authToStore` A subsocket factory for authenticated connections to stores.
`SubSocketFactory<RemoteWorker>`	`authToWorker` A subsocket factory for authenticated connections to workers
`java.lang.String`	`bootcp` The path for Fabric runtime classes
`java.lang.String`	`codeCache` The directory for dynamically compiled mobile code
`ConfigProperties`	`config`
`protected FetchManager`	`fetchManager` The manager to use for fetching objects from stores.
`java.lang.String`	`filsigcp` The path for FabIL signatures
`InProcessRemoteWorker`	`inProcessRemoteWorker`
`protected static Worker`	`instance` The singleton Worker instance.
`LabelCache`	`labelCache` The global label cache.
`FabricClassLoader`	`loader` The loader used by this worker for loading classes from fabric
`protected LocalStore`	`localStore`
`boolean`	`outputToLocalFS` Flag for indicating if worker needs to cache compiled code in local file system
`protected NodePrincipal`	`principal`
`static java.util.Random`	`RAND`
`java.lang.String`	`sigcp` The path for Fabric signatures
`protected java.util.concurrent.ConcurrentMap<java.lang.String,RemoteStore>`	`stores` A map from store hostnames to Store objects
`SubSocketFactory<RemoteStore>`	`unauthToStore` A subsocket factory for unauthenticated connections to stores.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clearCache()` Clears out the worker cache (but leaves dissemination cache intact).
`FetchManager`	`fetchManager()` Returns the fetch manager.
`java.util.List<java.lang.Long>`	`findOnumsInCache(RemoteStore store, java.util.List<java.lang.Long> onums)` Detemines which of a given set of onums are resident in cache.
`FabricClassLoader`	`getClassLoader()`
`LocalStore`	`getLocalStore()`
`RemoteWorker`	`getLocalWorker()`
`java.lang.String`	`getName()` convenience method for getting the node's name
`NodePrincipal`	`getPrincipal()`
`RemoteStore`	`getStore(java.lang.String name)` Returns a `Store` object representing the given store.
`static Worker`	`getWorker()` Returns the Singleton Worker instance.
`RemoteWorker`	`getWorker(java.lang.String name)`
`static void`	`initialize(ConfigProperties props)`
`static void`	`initialize(java.lang.String name)`
`static void`	`initializeForStore(java.lang.String name, java.util.Map<java.lang.String,RemoteStore> initStoreSet)`
`static boolean`	`isInitialized()`
`static void`	`main(java.lang.String[] args)`
`void`	`runFabricApp(java.lang.String mainClassName, java.lang.String[] args)` Runs the given Fabric program.
`static <T> T`	`runInSubTransaction(Worker.Code<T> code)` Executes the given code from within a Fabric subtransaction of the current transaction.
`static <T> T`	`runInTopLevelTransaction(Worker.Code<T> code, boolean autoRetry)` Executes the given code from within a new top-level Fabric transaction.
`static <T> T`	`runInTransaction(TransactionID tid, Worker.Code<T> code)` Executes the given code from within a Fabric transaction.
`void`	`runJavaApp(java.lang.String mainClassName, java.lang.String[] args)` Runs the given Java program.
`void`	`shutdown()` Shuts down and cleans up the worker.
`boolean`	`updateCache(RemoteStore store, ObjectGroup group)` Updates the worker cache with the given object group, as follows: If the cache contains a deserialized copy of an old version of any object in the group, then that old version is replaced with a serialized copy of the new version.
`boolean`	`updateCaches(RemoteStore store, long onum, AbstractGlob<?> update)` Updates the dissemination and worker caches with the given glob.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - config
```
public final ConfigProperties config
```
  - bootcp
```
public java.lang.String bootcp
```
    The path for Fabric runtime classes
  - sigcp
```
public java.lang.String sigcp
```
    The path for Fabric signatures
  - filsigcp
```
public java.lang.String filsigcp
```
    The path for FabIL signatures
  - codeCache
```
public java.lang.String codeCache
```
    The directory for dynamically compiled mobile code
  - outputToLocalFS
```
public boolean outputToLocalFS
```
    Flag for indicating if worker needs to cache compiled code in local file system
  - loader
```
public FabricClassLoader loader
```
    The loader used by this worker for loading classes from fabric
  - stores
```
protected final java.util.concurrent.ConcurrentMap<java.lang.String,RemoteStore> stores
```
    A map from store hostnames to Store objects
  - localStore
```
protected final LocalStore localStore
```
  - unauthToStore
```
public final SubSocketFactory<RemoteStore> unauthToStore
```
    A subsocket factory for unauthenticated connections to stores.
  - authToStore
```
public final SubSocketFactory<RemoteStore> authToStore
```
    A subsocket factory for authenticated connections to stores.
  - authToWorker
```
public final SubSocketFactory<RemoteWorker> authToWorker
```
    A subsocket factory for authenticated connections to workers
  - authFromAll
```
public final SubServerSocketFactory authFromAll
```
    The subserversocket factory
  - fetchManager
```
protected final FetchManager fetchManager
```
    The manager to use for fetching objects from stores.
  - labelCache
```
public final LabelCache labelCache
```
    The global label cache.
  - principal
```
protected final NodePrincipal principal
```
  - inProcessRemoteWorker
```
public final InProcessRemoteWorker inProcessRemoteWorker
```
  - RAND
```
public static final java.util.Random RAND
```
  - instance
```
protected static Worker instance
```
    The singleton Worker instance.
- Method Detail
  - isInitialized
```
public static boolean isInitialized()
```
  - getName
```
public java.lang.String getName()
```
    convenience method for getting the node's name
  - getWorker
```
public static Worker getWorker()
                        throws java.lang.IllegalStateException
```
    Returns the Singleton Worker instance.
    
    Returns:
    
    the Worker instance
    
    Throws:
    
    java.lang.IllegalStateException - if the Fabric worker is uninitialized
  - getStore
```
public RemoteStore getStore(java.lang.String name)
```
    Returns a Store object representing the given store.
    
    Parameters:
    
    name - The store's host name.
    
    Returns:
    
    The corresponding Store object.
  - getWorker
```
public RemoteWorker getWorker(java.lang.String name)
```
    Returns:
    
    a RemoteWorker object
  - getLocalStore
```
public LocalStore getLocalStore()
```
  - getLocalWorker
```
public RemoteWorker getLocalWorker()
```
    Returns:
    
    a RemoteWorker object representing the local worker.
  - fetchManager
```
public FetchManager fetchManager()
```
    Returns the fetch manager.
  - updateCaches
```
public boolean updateCaches(RemoteStore store,
                            long onum,
                            AbstractGlob<?> update)
```
    Updates the dissemination and worker caches with the given glob.
    
    Returns:
    
    true iff either of the caches were updated.
  - updateCache
```
public boolean updateCache(RemoteStore store,
                           ObjectGroup group)
```
    Updates the worker cache with the given object group, as follows:
    - If the cache contains a deserialized copy of an old version of any object in the group, then that old version is replaced with a serialized copy of the new version.
    - If the cache contains a serialized copy of an old version of any object in the group, then that old version is evicted.
    Transactions using any updated object are aborted and retried.
    Returns:
    
    true iff after this update operation, the cache contains any member of the group.
  - findOnumsInCache
```
public java.util.List<java.lang.Long> findOnumsInCache(RemoteStore store,
                                                       java.util.List<java.lang.Long> onums)
```
    Detemines which of a given set of onums are resident in cache.
  - getPrincipal
```
public NodePrincipal getPrincipal()
```
    Returns:
    
    the Fabric notion of the worker principal.
  - clearCache
```
public void clearCache()
```
    Clears out the worker cache (but leaves dissemination cache intact). To be used for (performance) testing only.
  - shutdown
```
public void shutdown()
```
    Shuts down and cleans up the worker.
  - initialize
```
public static void initialize(java.lang.String name)
                       throws java.lang.IllegalStateException,
                              java.io.IOException,
                              InternalError,
                              UsageError,
                              java.security.GeneralSecurityException
```
    Throws:
    
    java.lang.IllegalStateException
    
    java.io.IOException
    
    InternalError
    
    UsageError
    
    java.security.GeneralSecurityException
  - initialize
```
public static void initialize(ConfigProperties props)
                       throws java.lang.IllegalStateException,
                              InternalError,
                              UsageError,
                              java.io.IOException,
                              java.security.GeneralSecurityException
```
    Throws:
    
    java.lang.IllegalStateException
    
    InternalError
    
    UsageError
    
    java.io.IOException
    
    java.security.GeneralSecurityException
  - initializeForStore
```
public static void initializeForStore(java.lang.String name,
                                      java.util.Map<java.lang.String,RemoteStore> initStoreSet)
                               throws java.io.IOException,
                                      java.lang.IllegalStateException,
                                      InternalError,
                                      UsageError,
                                      java.security.GeneralSecurityException
```
    Throws:
    
    java.io.IOException
    
    java.lang.IllegalStateException
    
    InternalError
    
    UsageError
    
    java.security.GeneralSecurityException
  - getClassLoader
```
public FabricClassLoader getClassLoader()
```
  - main
```
public static void main(java.lang.String[] args)
                 throws java.lang.Throwable
```
    Throws:
    
    java.lang.Throwable
  - runFabricApp
```
public void runFabricApp(java.lang.String mainClassName,
                         java.lang.String[] args)
                  throws java.lang.Throwable
```
    Runs the given Fabric program.
    
    Parameters:
    
    mainClassName - the unmangled name of the application's main class.
    
    args - arguments to be passed to the application.
    
    Throws:
    
    java.lang.Throwable
  - runJavaApp
```
public void runJavaApp(java.lang.String mainClassName,
                       java.lang.String[] args)
                throws java.lang.Throwable
```
    Runs the given Java program.
    
    Parameters:
    
    mainClassName - the application's main class.
    
    args - arguments to be passed to the application.
    
    Throws:
    
    java.lang.Throwable
  - runInTopLevelTransaction
```
public static <T> T runInTopLevelTransaction(Worker.Code<T> code,
                                             boolean autoRetry)
```
    Executes the given code from within a new top-level Fabric transaction. Should not be called by generated code. This is here to abstract away the details of starting and finishing transactions.
    
    Parameters:
    
    autoRetry - whether the transaction should be automatically retried if it fails during commit
  - runInTransaction
```
public static <T> T runInTransaction(TransactionID tid,
                                     Worker.Code<T> code)
```
    Executes the given code from within a Fabric transaction. If the transaction fails, it will be automatically retried until it succeeds. Should not be called by generated code. This is here to abstract away the details of starting and finishing transactions.
    
    Parameters:
    
    tid - The parent transaction for the subtransaction that will be created.
  - runInSubTransaction
```
public static <T> T runInSubTransaction(Worker.Code<T> code)
```
    Executes the given code from within a Fabric subtransaction of the current transaction. Should not be called by generated code. This is here to abstract away the details of starting and finishing transactions.

Class Worker

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

config

bootcp

sigcp

filsigcp

codeCache

outputToLocalFS

loader

stores

localStore

unauthToStore

authToStore

authToWorker

authFromAll

fetchManager

labelCache

principal

inProcessRemoteWorker

RAND

instance

Method Detail

isInitialized

getName

getWorker

getStore

getWorker

getLocalStore

getLocalWorker

fetchManager

updateCaches

updateCache

findOnumsInCache

getPrincipal

clearCache

shutdown

initialize

initialize

initializeForStore

getClassLoader

main

runFabricApp

runJavaApp

runInTopLevelTransaction

runInTransaction

runInSubTransaction