ProxyWorker (CADI API)

java.lang.Object
- java.lang.Thread
- - CADI.Proxy.Core.ProxyWorker

All Implemented Interfaces:

java.lang.Runnable

Direct Known Subclasses:

CachedProxyWorker, TransparentProxyWorker
```
public class ProxyWorker
extends java.lang.Thread
```
Version:

1.0 2009/08/22

Author:

Group on Interactive Coding of Images (GICI)

Nested Class Summary
- Nested classes/interfaces inherited from class java.lang.Thread
  java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`busy` Indicates if the thread is carrying out a task.
`protected long`	`cumMessageBodiesLength` Attribute only for debugging purposes.
`protected long`	`cumMessageHeadersLength` Attribute only for debugging purposes.
`protected boolean`	`finish` Indicates whether the thread has to finish when it is working with a request with the keep-alive mode set.
`protected HTTPRequest`	`httpRequest` Definition in `HTTPRequest`.
`protected HTTPResponse`	`httpResponse`
`protected HTTPResponseSender`	`httpResponseSender`
`protected boolean`	`independentMessageHeaders` Definition in `CADI.Server.Network.JPIPMessageEncoder#independentForm`.
`protected JPIPResponseFields`	`jpipResponseFields`
`protected int`	`keepAliveTimeout` Definition in `Scheduler.keepAliveTimeout`.
`protected CADILog`	`log` It is an object that will be used to log the server process
`protected long`	`maxTxRate` Definition in `Scheduler.maxTxRate`.
`protected java.io.OutputStream`	`os` Is an output stream that will be used to send the server response to the client.
`protected RequestQueue`	`requestQueue` Definition in `Proxy.requestQueue`.
`protected java.net.Socket`	`socket` Contains the client socket of which request is being processed.
`protected int`	`trafficShaping`

Fields inherited from class java.lang.Thread
MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors
Constructor and Description

ProxyWorker(java.lang.String threadName, RequestQueue requestQueue, CADILog log)
Constructor.

Constructors
Constructor and Description
`ProxyWorker(java.lang.String threadName, RequestQueue requestQueue, CADILog log)` Constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`private void`	`encodeJPIPResponseFields()` JPIP HEADERS (See ISO/IEC 15444-9 Annex D)
`void`	`finish()` This method is used to indicate that the thread has to finish.
`java.lang.Thread.State`	`getState()`
`boolean`	`isBusy()` This method is used to indicate if the thread is or no busy processing a task.
`void`	`list(java.io.PrintStream out)` Prints this ProxyWorker out to the specified output stream.
`protected void`	`listenNewRequest()`
`void`	`run()`
`protected void`	`sendHTTPResponseError(int statusCode, java.lang.String reasonPhrase)` This method will be used to send an HTTP error response to the client.
`protected void`	`sendHTTPResponseHeader(HTTPResponse httpResponse)`
`void`	`setIndependentMessageHeaders(boolean independentMessageHeaders)` Sets the `#independentMesssageHeaders` attribute.
`void`	`setKeepAliveTimeout(int keepAliveTimeout)` Sets the `keepAliveTimeout` attribute.
`void`	`setMaxTxRate(long maxTxRate)` Sets the `maxTxRate` attribute.
`void`	`setTrafficShaping(int trafficShaping)` Sets the `trafficShaping` attribute.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Thread
activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, yield

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

- Field Detail
  - requestQueue
```
protected RequestQueue requestQueue
```
    Definition in Proxy.requestQueue.
  - log
```
protected CADILog log
```
    It is an object that will be used to log the server process
  - finish
```
protected boolean finish
```
    Indicates whether the thread has to finish when it is working with a request with the keep-alive mode set.
    
    See Also:
    finish()
  - busy
```
protected boolean busy
```
    Indicates if the thread is carrying out a task. If the thread is waiting for a new task, the busy attribute is false.
  - socket
```
protected java.net.Socket socket
```
    Contains the client socket of which request is being processed.
  - httpRequest
```
protected HTTPRequest httpRequest
```
    Definition in HTTPRequest.
  - keepAliveTimeout
```
protected int keepAliveTimeout
```
    Definition in Scheduler.keepAliveTimeout.
  - maxTxRate
```
protected long maxTxRate
```
    Definition in Scheduler.maxTxRate.
  - trafficShaping
```
protected int trafficShaping
```
  - independentMessageHeaders
```
protected boolean independentMessageHeaders
```
    Definition in CADI.Server.Network.JPIPMessageEncoder#independentForm.
  - os
```
protected java.io.OutputStream os
```
    Is an output stream that will be used to send the server response to the client.
  - httpResponse
```
protected HTTPResponse httpResponse
```
  - jpipResponseFields
```
protected JPIPResponseFields jpipResponseFields
```
  - httpResponseSender
```
protected HTTPResponseSender httpResponseSender
```
  - cumMessageHeadersLength
```
protected long cumMessageHeadersLength
```
    Attribute only for debugging purposes.
  - cumMessageBodiesLength
```
protected long cumMessageBodiesLength
```
    Attribute only for debugging purposes.
- Constructor Detail
  - ProxyWorker
```
public ProxyWorker(java.lang.String threadName,
           RequestQueue requestQueue,
           CADILog log)
```
    Constructor.
    
    Parameters:
    threadName -
    requestQueue - definition in requestQueue.
    log - definition in log.
- Method Detail
  - run
```
public void run()
```
    Specified by:
    
    run in interface java.lang.Runnable
    
    Overrides:
    
    run in class java.lang.Thread
  - finish
```
public void finish()
```
    This method is used to indicate that the thread has to finish.
  - isBusy
```
public boolean isBusy()
```
    This method is used to indicate if the thread is or no busy processing a task.
    
    Returns:
    true if the thread is processing a task. Otherwise, it returns false.
  - getState
```
public java.lang.Thread.State getState()
```
    Overrides:
    
    getState in class java.lang.Thread
  - setKeepAliveTimeout
```
public void setKeepAliveTimeout(int keepAliveTimeout)
```
    Sets the keepAliveTimeout attribute.
    
    Parameters:
    keepAliveTimeout - definition in keepAliveTimeout.
  - setMaxTxRate
```
public void setMaxTxRate(long maxTxRate)
```
    Sets the maxTxRate attribute.
    
    Parameters:
    maxTxRate - definition in maxTxRate attribute.
  - setTrafficShaping
```
public void setTrafficShaping(int trafficShaping)
```
    Sets the trafficShaping attribute.
    
    Parameters:
    maxTxRate - definition in trafficShaping attribute.
  - setIndependentMessageHeaders
```
public void setIndependentMessageHeaders(boolean independentMessageHeaders)
```
    Sets the #independentMesssageHeaders attribute.
    
    Parameters:
    independentMesssageHeaders - definition in #independentMesssageHeaders attribute.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Thread
  - list
```
public void list(java.io.PrintStream out)
```
    Prints this ProxyWorker out to the specified output stream. This method is useful for debugging.
    
    Parameters:
    out - an output stream.
  - listenNewRequest
```
protected void listenNewRequest()
                         throws WarningException,
                                ErrorException
```
    Throws:
    
    WarningException
    
    ErrorException
  - encodeJPIPResponseFields
```
private void encodeJPIPResponseFields()
```
    JPIP HEADERS (See ISO/IEC 15444-9 Annex D)
  - sendHTTPResponseHeader
```
protected void sendHTTPResponseHeader(HTTPResponse httpResponse)
                               throws WarningException
```
    Parameters:
    httpResponse -
    
    Throws:
    
    WarningException
  - sendHTTPResponseError
```
protected void sendHTTPResponseError(int statusCode,
                         java.lang.String reasonPhrase)
```
    This method will be used to send an HTTP error response to the client.
    
    Parameters:
    statusCode - definition in StatusCodes.
    reasonPhrase - a reason phrase related with the status code.

CADI - Copyright (C) 2007
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

Group on Interactive Coding of Images (GICI) (contact)

Class ProxyWorker

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

Field Summary

Fields inherited from class java.lang.Thread

Constructor Summary

Method Summary

Methods inherited from class java.lang.Thread

Methods inherited from class java.lang.Object

Field Detail

requestQueue

log

finish

busy

socket

httpRequest

keepAliveTimeout

maxTxRate

trafficShaping

independentMessageHeaders

os

httpResponse

jpipResponseFields

httpResponseSender

cumMessageHeadersLength

cumMessageBodiesLength

Constructor Detail

ProxyWorker

Method Detail

run

finish

isBusy

getState

setKeepAliveTimeout

setMaxTxRate

setTrafficShaping

setIndependentMessageHeaders

toString

list

listenNewRequest

encodeJPIPResponseFields

sendHTTPResponseHeader

sendHTTPResponseError