Handle

java.lang.Object
- fi.techila.user.Handle

```
public class Handle
extends java.lang.Object
```
Handle object for storing state information. Internal object for the library, not intended for use outside the library.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Handle.HandleCallbackType

Nested Classes
Modifier and Type	Class and Description
`static class`	`Handle.HandleCallbackType`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addKerberosRequest(long jobid, java.lang.String token)`
`java.lang.String`	`getBundle()` get the bundle name.
`int`	`getBundleId()` Get the bundle ID.
`int`	`getCancelled()` Get the amount of cancelled jobs.
`long`	`getCpuTime()` Get the used CPU time for the project.
`java.util.Vector<java.lang.String>`	`getCreatedBundleFiles()` Get a vector of created bundle files.
`java.lang.String`	`getDownloadDir()` Get the download directory where project results are downloaded.
`long`	`getDownloaded()` Get the amount of bytes downloaded.
`long`	`getDownloadLength()` Get the total amount of bytes to be downloaded.
`java.lang.String`	`getErrorFile()` Get the error file location.
`Project`	`getErrorProject()` Get the error project object.
`int`	`getErrors()` Get the amount of errors.
`int`	`getFilesReceived()` Get the number of files received so far in streaming mode.
`int`	`getId()` Get the handle ID.
`java.util.Vector<java.lang.String>`	`getIntermediateFiles()`
`int`	`getJobCount()` Get the total amount of jobs.
`int`	`getJobCountWOP()`
`java.lang.String`	`getLastCreatedBundle()` get the last created bundle name.
`java.lang.String`	`getLastCreatedBundleFile()` Get the last created bundle file.
`int`	`getLastError()` Get the status code of the last poll operation, OK if no error or no poll has yet been executed.
`java.lang.String`	`getLastErrorMessage()`
`java.util.logging.Logger`	`getLogger()`
`java.util.Vector<java.lang.String>`	`getNewIntermediateFiles()`
`java.util.Vector<java.lang.String>`	`getNewStreamedFiles()` Get the list of new streamed files.
`int`	`getPost()`
`int`	`getProjectId()` Get the project id associated with this handle.
`java.util.Hashtable<java.lang.String,java.lang.String>`	`getProjectParameters()` Return project parameters from Handle.
`int`	`getReady()` Get the amount of ready jobs.
`int`	`getReadyWOP()` Get the amount of ready jobs (without polling).
`java.lang.String`	`getResultFile()` Get result file (zip).
`int`	`getStatus()` Get the project status.
`java.lang.String`	`getStderrFile()` Get the current stderr file.
`java.lang.String`	`getStdoutFile()` Get the current stdout file.
`java.util.Vector<java.lang.String>`	`getStreamedFiles()` Get the list of ALL streamed files.
`TechilaManager`	`getTechilaManager()`
`long`	`getTime()` Get the used time for the project.
`int`	`getTotalJobs()`
`int`	`getTotalJobsWOP()`
`java.lang.String`	`getUnzipDirectory()` Get the result unzip directory.
`int`	`getUnzipFileCount()` Get the number of files unzipped.
`java.util.Vector<java.lang.String>`	`getUnzipFiles()` Get a vector of unzipped result files.
`long`	`getUploaded()` Get the amount of bytes uploaded.
`long`	`getUploadLength()` Get the total amount of bytes to be uploaded.
`boolean`	`getUseProjectMessages()`
`int`	`getWaiting()` Get the amount of waiting jobs.
`int`	`getWorking()` Get the amount of working jobs.
`void`	`setBundleId(int bundleId)` Set bundle ID.
`void`	`setPost(int post)`
`void`	`setProjectParameters(java.util.Hashtable<java.lang.String,java.lang.String> params)` Save the project parameters to Handle.
`void`	`setUseProjectMessages(boolean useProjectMessages)`
`void`	`stopKerberos()`

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

- Method Detail
  - getId
```
public int getId()
```
    Get the handle ID.
    
    Returns:
    
    ID
  - getBundle
```
public java.lang.String getBundle()
```
    get the bundle name.
    
    Returns:
    
    bundle name
  - getLastCreatedBundle
```
public java.lang.String getLastCreatedBundle()
```
    get the last created bundle name.
    
    Returns:
    
    bundle name
  - getBundleId
```
public int getBundleId()
```
    Get the bundle ID.
    
    Returns:
    
    bundle ID
  - setBundleId
```
public void setBundleId(int bundleId)
```
    Set bundle ID.
    
    Parameters:
    
    bundleId - bundle ID
  - getProjectId
```
public int getProjectId()
```
    Get the project id associated with this handle.
    
    Returns:
    
    project id or -1 if not defined
  - getDownloadDir
```
public java.lang.String getDownloadDir()
```
    Get the download directory where project results are downloaded.
    
    Returns:
    
    download directory
  - getResultFile
```
public java.lang.String getResultFile()
```
    Get result file (zip).
    
    Returns:
    
    result file
  - getErrorFile
```
public java.lang.String getErrorFile()
```
    Get the error file location.
    
    Returns:
    
    errorFile
  - getStdoutFile
```
public java.lang.String getStdoutFile()
```
    Get the current stdout file.
    
    Returns:
  - getStderrFile
```
public java.lang.String getStderrFile()
```
    Get the current stderr file.
    
    Returns:
  - getLastErrorMessage
```
public java.lang.String getLastErrorMessage()
```
  - getUnzipDirectory
```
public java.lang.String getUnzipDirectory()
```
    Get the result unzip directory.
    
    Returns:
    
    unzip directory
  - getUnzipFiles
```
public java.util.Vector<java.lang.String> getUnzipFiles()
```
    Get a vector of unzipped result files.
    
    Returns:
    
    Vector or null
  - getNewStreamedFiles
```
public java.util.Vector<java.lang.String> getNewStreamedFiles()
```
    Get the list of new streamed files. The list will be emptied.
    
    Returns:
    
    The list or null
  - getIntermediateFiles
```
public java.util.Vector<java.lang.String> getIntermediateFiles()
```
  - getNewIntermediateFiles
```
public java.util.Vector<java.lang.String> getNewIntermediateFiles()
```
  - getStreamedFiles
```
public java.util.Vector<java.lang.String> getStreamedFiles()
```
    Get the list of ALL streamed files. The list will NOT be emptied.
    
    Returns:
    
    The list or null
  - getErrorProject
```
public Project getErrorProject()
```
    Get the error project object.
    
    Returns:
  - getCreatedBundleFiles
```
public java.util.Vector<java.lang.String> getCreatedBundleFiles()
```
    Get a vector of created bundle files.
    
    Returns:
    
    Vector or null
  - getLastCreatedBundleFile
```
public java.lang.String getLastCreatedBundleFile()
```
    Get the last created bundle file.
    
    Returns:
    
    the bundle file created last
  - setProjectParameters
```
public void setProjectParameters(java.util.Hashtable<java.lang.String,java.lang.String> params)
```
    Save the project parameters to Handle.
    
    Parameters:
    
    params - project parameters
  - getProjectParameters
```
public java.util.Hashtable<java.lang.String,java.lang.String> getProjectParameters()
```
    Return project parameters from Handle.
    
    Returns:
    
    project parameters
  - getStatus
```
public int getStatus()
```
    Get the project status.
    
    Returns:
    
    status
  - getReady
```
public int getReady()
```
    Get the amount of ready jobs.
    
    Returns:
    
    amount of ready jobs
  - getReadyWOP
```
public int getReadyWOP()
```
    Get the amount of ready jobs (without polling).
    
    Returns:
    
    amount of ready jobs
  - getWorking
```
public int getWorking()
```
    Get the amount of working jobs.
    
    Returns:
    
    amount of working jobs
  - getWaiting
```
public int getWaiting()
```
    Get the amount of waiting jobs.
    
    Returns:
    
    amount of waiting jobs
  - getCancelled
```
public int getCancelled()
```
    Get the amount of cancelled jobs.
    
    Returns:
    
    amount of cancelled jobs
  - getJobCount
```
public int getJobCount()
```
    Get the total amount of jobs.
    
    Returns:
    
    amount of total jobs
  - getJobCountWOP
```
public int getJobCountWOP()
```
  - getTotalJobs
```
public int getTotalJobs()
```
  - getTotalJobsWOP
```
public int getTotalJobsWOP()
```
  - getPost
```
public int getPost()
```
  - setPost
```
public void setPost(int post)
```
  - getErrors
```
public int getErrors()
```
    Get the amount of errors.
    
    Returns:
    
    amount of errors
  - getCpuTime
```
public long getCpuTime()
```
    Get the used CPU time for the project.
    
    Returns:
    
    time used in seconds
  - getTime
```
public long getTime()
```
    Get the used time for the project.
    
    Returns:
    
    time used in seconds
  - getLastError
```
public int getLastError()
```
    Get the status code of the last poll operation, OK if no error or no poll has yet been executed.
    
    Returns:
    
    statuscode
  - getDownloaded
```
public long getDownloaded()
```
    Get the amount of bytes downloaded.
    
    Returns:
  - getDownloadLength
```
public long getDownloadLength()
```
    Get the total amount of bytes to be downloaded.
    
    Returns:
  - getUploaded
```
public long getUploaded()
```
    Get the amount of bytes uploaded.
    
    Returns:
  - getUploadLength
```
public long getUploadLength()
```
    Get the total amount of bytes to be uploaded.
    
    Returns:
  - getUnzipFileCount
```
public int getUnzipFileCount()
```
    Get the number of files unzipped.
    
    Returns:
  - getFilesReceived
```
public int getFilesReceived()
```
    Get the number of files received so far in streaming mode.
    
    Returns:
  - setUseProjectMessages
```
public void setUseProjectMessages(boolean useProjectMessages)
```
  - getUseProjectMessages
```
public boolean getUseProjectMessages()
```
  - getLogger
```
public java.util.logging.Logger getLogger()
```
  - getTechilaManager
```
public TechilaManager getTechilaManager()
```
  - stopKerberos
```
public void stopKerberos()
```
  - addKerberosRequest
```
public void addKerberosRequest(long jobid,
                               java.lang.String token)
```

Class Handle

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getId

getBundle

getLastCreatedBundle

getBundleId

setBundleId

getProjectId

getDownloadDir

getResultFile

getErrorFile

getStdoutFile

getStderrFile

getLastErrorMessage

getUnzipDirectory

getUnzipFiles

getNewStreamedFiles

getIntermediateFiles

getNewIntermediateFiles

getStreamedFiles

getErrorProject

getCreatedBundleFiles

getLastCreatedBundleFile

setProjectParameters

getProjectParameters

getStatus

getReady

getReadyWOP

getWorking

getWaiting

getCancelled

getJobCount

getJobCountWOP

getTotalJobs

getTotalJobsWOP

getPost

setPost

getErrors

getCpuTime

getTime

getLastError

getDownloaded

getDownloadLength

getUploaded

getUploadLength

getUnzipFileCount

getFilesReceived

setUseProjectMessages

getUseProjectMessages

getLogger

getTechilaManager

stopKerberos

addKerberosRequest