WorkerNodeService (score-node-api 0.3.216 API)

```
public interface WorkerNodeService
```
Created by IntelliJ IDEA. User: Date: 08/11/12
A service responsible for handling a worker node record

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`activate(String uuid)` activates a worker
`void`	`addGroupToWorker(String workerUuid, String group)` adds group to be associated with a worker
`void`	`create(String uuid, String password, String hostName, String installDir)` Create a new worker
`void`	`deactivate(String uuid)` deactivate a worker
`WorkerNode`	`findByUuid(String uuid)` find worker without relating to the IS_DELETED property
`boolean`	`isActive(String workerUuid)` Returns active status of the worker according to the worker UUID
`String`	`keepAlive(String uuid)` Update the Worker Node entity with the current ack version for the keep alive mechanism
`void`	`migratePassword(String uuid, String password)` updates the migration password field of a worker node
`WorkerKeepAliveInfo`	`newKeepAlive(String uuid)` Update the Worker Node entity with the current ack version for the keep alive mechanism
`List<WorkerNode>`	`readAllNotDeletedWorkers()` Reads all of the workers that are not marked with the IS_DELETED flag
`List<String>`	`readAllWorkerGroups()` Reads all of the worker groups
`List<WorkerNode>`	`readAllWorkers()` Reads all of the workers records
`List<String>`	`readAllWorkersUuids()` Read all workers uuids
`WorkerNode`	`readByUUID(String uuid)` find not deleted worker by uuid
`com.google.common.collect.Multimap<String,String>`	`readGroupWorkersMapActiveAndRunningAndVersion(String versionId)` Reads all of the worker that are active and running and their groups
`List<String>`	`readNonRespondingWorkers()` Read all of the worker that didn't send keep alive for a certain amount of time
`List<String>`	`readWorkerGroups(List<String> groups)` Reads all of the groups that matches the given group names
`List<String>`	`readWorkerGroups(String uuid)` Read all of the groups associated with a worker
`Map<String,Set<String>>`	`readWorkerGroupsMap()` Retrieves the worker and worker groups as a map
`List<WorkerNode>`	`readWorkersByActivation(boolean isActive)` read all worker that there activation status is as a given status
`void`	`removeGroupFromWorker(String workerUuid, String group)` removes a group association with a worker
`String`	`up(String uuid)` Notifies the orchestrator that a worker went up
`String`	`up(String uuid, String version, String versionId)` Notifies the orchestrator that a worker went up
`void`	`updateBulkNumber(String workerUuid, String bulkNumber)` updates the worker recovery bulk number
`void`	`updateEnvironmentParams(String uuid, String os, String jvm, String dotNetVersion)` updates the environment params of a given worker
`void`	`updateMigratedPassword(String workerUuid, String encodedPassword)` updates worker's password encoding
`void`	`updateQueueSync(boolean isQueueSync)`
`void`	`updateQueueSyncByUuid(String workerUuid, boolean isQueueSync)`
`void`	`updateStatus(String uuid, io.cloudslang.score.api.nodes.WorkerStatus status)` updates the status of a given worker
`void`	`updateStatusInSeparateTransaction(String uuid, io.cloudslang.score.api.nodes.WorkerStatus status)` updates the status of a given worker in a separate transaction
`void`	`updateVersion(String workerUuid, String version, String versionId)` updates the worker version of a given worker
`void`	`updateWorkerGroups(String uuid, String... groupNames)` updates the groups associated with a worker
`void`	`updateWorkerToDeleted(String uuid)` update a worker record to IS_DELETED state
`void`	`updateWorkerToNotDeleted(String uuid)` update a worker record to its not deleted state
`void`	`updateWRV(String workerUuid, String wrv)` updates the worker recovery version of a given worker

- Method Detail
  - keepAlive
```
String keepAlive(String uuid)
```
    Update the Worker Node entity with the current ack version for the keep alive mechanism
    
    Parameters:
    
    uuid - worker's unique identifier Maintained for backward compatibility only
    
    Returns:
    
    the worker's recovery version (WRV)
  - newKeepAlive
```
WorkerKeepAliveInfo newKeepAlive(String uuid)
```
    Update the Worker Node entity with the current ack version for the keep alive mechanism
    
    Parameters:
    
    uuid - worker's unique identifier
    
    Returns:
    
    the WorkerKeepAliveInfo that contains the worker's recovery version (WRV) and the enable state
  - create
```
void create(String uuid,
            String password,
            String hostName,
            String installDir)
```
    Create a new worker
    
    Parameters:
    
    uuid - worker's unique identifier
    
    password - worker's password
    
    hostName - worker's host
    
    installDir - worker's installation directory
  - updateWorkerToDeleted
```
void updateWorkerToDeleted(String uuid)
```
    update a worker record to IS_DELETED state
    
    Parameters:
    
    uuid - the uuid of the worker to mark deleted
  - updateWorkerToNotDeleted
```
void updateWorkerToNotDeleted(String uuid)
```
    update a worker record to its not deleted state
    
    Parameters:
    
    uuid - the uuid of the worker to mark as not deleted
  - readAllNotDeletedWorkers
```
List<WorkerNode> readAllNotDeletedWorkers()
```
    Reads all of the workers that are not marked with the IS_DELETED flag
    
    Returns:
    
    a List of WorkerNode that are ont marked with the IS_DELETED flag
  - up
```
String up(String uuid,
          String version,
          String versionId)
```
    Notifies the orchestrator that a worker went up
    
    Parameters:
    
    uuid - the the uuid of the worker that went up
    
    version - the version of the worker that went up
    
    versionId - the versionId of the worker that went up
    
    Returns:
    
    a String of the current recovery version of the worker
  - up
```
String up(String uuid)
```
    Notifies the orchestrator that a worker went up
    
    Parameters:
    
    uuid - the the uuid of the worker that went up
    
    Returns:
    
    a String of the current recovery version of the worker
  - readByUUID
```
WorkerNode readByUUID(String uuid)
```
    find not deleted worker by uuid
    
    Parameters:
    
    uuid - the uuid of the worker to find
    
    Returns:
    
    a WorkerNode of the requested worker
  - isActive
```
boolean isActive(String workerUuid)
```
    Returns active status of the worker according to the worker UUID
  - findByUuid
```
WorkerNode findByUuid(String uuid)
```
    find worker without relating to the IS_DELETED property
    
    Parameters:
    
    uuid - the uuid of the worker to find
    
    Returns:
    
    a WorkerNode of the requested worker
  - readAllWorkers
```
List<WorkerNode> readAllWorkers()
```
    Reads all of the workers records
    
    Returns:
    
    a List of all existing WorkerNode
  - readNonRespondingWorkers
```
List<String> readNonRespondingWorkers()
```
    Read all of the worker that didn't send keep alive for a certain amount of time
    
    Returns:
    
    a List of String of the non-responding worker ids
  - readWorkersByActivation
```
List<WorkerNode> readWorkersByActivation(boolean isActive)
```
    read all worker that there activation status is as a given status
    
    Parameters:
    
    isActive - the requested activation status.
    
    Returns:
    
    a List of all WorkerNode the their activation status is as the given status
  - activate
```
void activate(String uuid)
```
    activates a worker
    
    Parameters:
    
    uuid - the uuid of the worker to activate
  - deactivate
```
void deactivate(String uuid)
```
    deactivate a worker
    
    Parameters:
    
    uuid - the uuid of the worker to deactivate
  - updateEnvironmentParams
```
void updateEnvironmentParams(String uuid,
                             String os,
                             String jvm,
                             String dotNetVersion)
```
    updates the environment params of a given worker
    
    Parameters:
    
    uuid - the uuid of the worker to update
    
    os - the operating system the worker is running on
    
    jvm - the jvm version the worker is running on
    
    dotNetVersion - the dot-net version the worker is using
  - updateStatus
```
void updateStatus(String uuid,
                  io.cloudslang.score.api.nodes.WorkerStatus status)
```
    updates the status of a given worker
    
    Parameters:
    
    uuid - the uuid of the worker to update
    
    status - the status to update the given worker to
  - updateStatusInSeparateTransaction
```
void updateStatusInSeparateTransaction(String uuid,
                                       io.cloudslang.score.api.nodes.WorkerStatus status)
```
    updates the status of a given worker in a separate transaction
    
    Parameters:
    
    uuid - the uuid of the worker to update
    
    status - the status to update the given worker to
  - migratePassword
```
void migratePassword(String uuid,
                     String password)
```
    updates the migration password field of a worker node
    
    Parameters:
    
    uuid - the uuid of the worker to update
    
    password - the migrated password to be used
  - readAllWorkerGroups
```
List<String> readAllWorkerGroups()
```
    Reads all of the worker groups
    
    Returns:
    
    a List of String of all existing worker groups
  - readWorkerGroups
```
List<String> readWorkerGroups(String uuid)
```
    Read all of the groups associated with a worker
    
    Parameters:
    
    uuid - the the uuid of the worker to find groups for
    
    Returns:
    
    a List of String of the associated group names
  - updateWorkerGroups
```
void updateWorkerGroups(String uuid,
                        String... groupNames)
```
    updates the groups associated with a worker
    
    Parameters:
    
    uuid - the uuid of the worker to update groups for
    
    groupNames - the groups to associate with the worker
  - readGroupWorkersMapActiveAndRunningAndVersion
```
com.google.common.collect.Multimap<String,String> readGroupWorkersMapActiveAndRunningAndVersion(String versionId)
```
    Reads all of the worker that are active and running and their groups
    
    Parameters:
    
    versionId - - the version of workers
    
    Returns:
    
    A Multimap of the active and running workers in specific version and their groups
  - addGroupToWorker
```
void addGroupToWorker(String workerUuid,
                      String group)
```
    adds group to be associated with a worker
    
    Parameters:
    
    workerUuid - the uuid of the worker to associate the group to
    
    group - the group to associate with the worker
  - removeGroupFromWorker
```
void removeGroupFromWorker(String workerUuid,
                           String group)
```
    removes a group association with a worker
    
    Parameters:
    
    workerUuid - the uuid of the worker to remove the group association from
    
    group - the group to remove its association from the worker
  - readWorkerGroups
```
List<String> readWorkerGroups(List<String> groups)
```
    Reads all of the groups that matches the given group names
    
    Parameters:
    
    groups - the group names to match
    
    Returns:
    
    t List of String of the matched groups
  - updateBulkNumber
```
void updateBulkNumber(String workerUuid,
                      String bulkNumber)
```
    updates the worker recovery bulk number
    
    Parameters:
    
    workerUuid - the uuid of the worker to update
    
    bulkNumber - the new recovery bulk number
  - updateWRV
```
void updateWRV(String workerUuid,
               String wrv)
```
    updates the worker recovery version of a given worker
    
    Parameters:
    
    workerUuid - the uuid of the worker to update
    
    wrv - the new worker recovery version
  - readWorkerGroupsMap
```
Map<String,Set<String>> readWorkerGroupsMap()
```
    Retrieves the worker and worker groups as a map
  - readAllWorkersUuids
```
List<String> readAllWorkersUuids()
```
    Read all workers uuids
    
    Returns:
    
    a List of String of the worker uuids
  - updateVersion
```
void updateVersion(String workerUuid,
                   String version,
                   String versionId)
```
    updates the worker version of a given worker
    
    Parameters:
    
    workerUuid - the uuid of the worker to update
    
    version - the worker's version
    
    versionId - comparable worker's version
  - updateMigratedPassword
```
void updateMigratedPassword(String workerUuid,
                            String encodedPassword)
```
    updates worker's password encoding
    
    Parameters:
    
    workerUuid - the uuid of the worker to be updated
    
    encodedPassword - the newly encoded password of the worker
  - updateQueueSyncByUuid
```
void updateQueueSyncByUuid(String workerUuid,
                           boolean isQueueSync)
```
  - updateQueueSync
```
void updateQueueSync(boolean isQueueSync)
```

Interface WorkerNodeService

Method Summary

Method Detail

keepAlive

newKeepAlive

create

updateWorkerToDeleted

updateWorkerToNotDeleted

readAllNotDeletedWorkers

up

up

readByUUID

isActive

findByUuid

readAllWorkers

readNonRespondingWorkers

readWorkersByActivation

activate

deactivate

updateEnvironmentParams

updateStatus

updateStatusInSeparateTransaction

migratePassword

readAllWorkerGroups

readWorkerGroups

updateWorkerGroups

readGroupWorkersMapActiveAndRunningAndVersion

addGroupToWorker

removeGroupFromWorker

readWorkerGroups

updateBulkNumber

updateWRV

readWorkerGroupsMap

readAllWorkersUuids

updateVersion

updateMigratedPassword

updateQueueSyncByUuid

updateQueueSync