com.yahoo.bard.webservice.logging.blocks

Class Epilogue

java.lang.Object

com.yahoo.bard.webservice.logging.blocks.Epilogue

All Implemented Interfaces:

LogInfo

public class Epilogue
extends Object
implements LogInfo

Common information for every request that is saved when the logging of a request is finalized. Epilogue takes an Observer that listens for the length of the output stream that was successfully sent to the client.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	code
protected static long	LENGTH_UNKNOWN
protected String	logMessage
protected String	status

Constructor Summary

Constructors

Constructor and Description
Epilogue(String logMessage, javax.ws.rs.core.Response.StatusType response, CacheLastObserver<Long> responseLengthObserver) Builds the block containing the common information for every request that is saved when the logging of a request is finalized.

Method Summary

Modifier and Type	Method and Description
long	getResponseLength()
boolean	isConnectionClosedPrematurely() The connection between Bard and the client is considered to be closed prematurely if the connection is closed before Bard finishes streaming the results back to the client.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.yahoo.bard.webservice.logging.LogInfo

getName

Field Detail

LENGTH_UNKNOWN

protected static final long LENGTH_UNKNOWN

See Also:

Constant Field Values

status

protected final String status

code

protected final int code

logMessage

protected final String logMessage

Constructor Detail

Epilogue

public Epilogue(String logMessage,
                javax.ws.rs.core.Response.StatusType response,
                CacheLastObserver<Long> responseLengthObserver)

Builds the block containing the common information for every request that is saved when the logging of a request is finalized.

Parameters:

logMessage - The message to log

response - The status of the response

responseLengthObserver - An Observer that receives the length of the response streamed back to the client once streaming is complete

Method Detail

getResponseLength

public long getResponseLength()

isConnectionClosedPrematurely

public boolean isConnectionClosedPrematurely()

The connection between Bard and the client is considered to be closed prematurely if the connection is closed before Bard finishes streaming the results back to the client.

When this happens, an EOFException is thrown. So as an approximation (it is theoretically possible for an EOFException to be thrown for other reasons), we consider the connection to be closed prematurely if an EOFException is generated while sending the response back to the client.

Returns:

True if the connection to the client closed before Bard could finish sending the result back to the client