Package org.eblocker.server.icap.transaction

Class AbstractTransaction

java.lang.Object

org.eblocker.server.icap.transaction.AbstractTransaction

All Implemented Interfaces:

TransactionContext, TransactionIdentifier, Transaction

Direct Known Subclasses:

IcapTransaction

public abstract class AbstractTransaction
extends Object
implements Transaction, TransactionIdentifier

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	contentChanged
protected boolean	headersChanged

Constructor Summary

Constructors

Constructor	Description
AbstractTransaction(boolean isRequest, boolean isResponse)

Method Summary

Modifier and Type	Method	Description
void	block()
protected abstract void	doSetHttpRequest(io.netty.handler.codec.http.FullHttpRequest httpRequest)
protected abstract void	doSetHttpResponse(io.netty.handler.codec.http.FullHttpResponse httpResponse)
String	getAccept()
String	getBaseUrl()
StringBuilder	getContent()
ContentEncoding	getContentEncoding()
String	getContentType()
String	getControlBarUrl()	Returns the base URL from which the ControlBar iframe, icons and XMLHttpRequests are loaded.
String	getCspNonce()	Returns the nonce that can be used to allow the injected ControlBar script in the Content-Security-Policy of the response.
Decision	getDecision()
String	getDomain()
FilterResult	getFilterResult()
Injections	getInjections()
PageContext	getPageContext()
String	getRedirectTarget()
String	getReferrer()
String	getReferrerHostname()
Session	getSession()
String	getSessionId()
String	getUrl()
String	getUserAgent()
String	getUserReference()
boolean	isComplete()
boolean	isContentChanged()
boolean	isHeadersChanged()
boolean	isRequest()
boolean	isResponse()
boolean	isThirdParty()
void	noContent()
void	redirect(String targetUrl)
void	setBaseUrl(String baseUrl)
void	setComplete(boolean complete)
void	setContent(StringBuilder content)
void	setContentChanged(boolean contentChanged)
void	setContentEncoding(ContentEncoding contentEncoding)
void	setControlBarUrl(String controlBarUrl)	Sets the base URL from which the ControlBar iframe, icons and XMLHttpRequests are loaded.
void	setCspNonce(String cspNonce)	Sets the nonce that can be used to allow the injected ControlBar script in the Content-Security-Policy of the response.
void	setDecision(Decision decision)
void	setFilterResult(FilterResult filterResult)
void	setHeadersChanged(boolean headersChanged)
void	setInjections(Injections injections)
void	setPageContext(PageContext pageContext)
void	setRedirectTarget(String redirectTarget)
void	setRequest(io.netty.handler.codec.http.FullHttpRequest httpRequest)
void	setResponse(io.netty.handler.codec.http.FullHttpResponse httpResponse)	This method does not only set the http response object - it will make the whole transaction a response transaction, even if it was a request transaction, before!
void	setSession(Session session)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eblocker.server.icap.transaction.Transaction

getRequest, getResponse, isPreview

Methods inherited from interface org.eblocker.server.common.transaction.TransactionIdentifier

getOriginalClientIP

Field Details

contentChanged

protected boolean contentChanged

headersChanged

protected boolean headersChanged

Constructor Details

AbstractTransaction

public AbstractTransaction(boolean isRequest,
 boolean isResponse)

Method Details

getSessionId

public String getSessionId()

Specified by:

getSessionId in interface TransactionContext

getSession

public Session getSession()

Specified by:

getSession in interface Transaction

setSession

public void setSession(Session session)

Specified by:

setSession in interface Transaction

getUrl

public String getUrl()

Specified by:

getUrl in interface TransactionContext

getReferrer

public String getReferrer()

Specified by:

getReferrer in interface TransactionContext

getAccept

public String getAccept()

Specified by:

getAccept in interface TransactionContext

getUserAgent

public String getUserAgent()

Specified by:

getUserAgent in interface TransactionIdentifier

getDomain

public String getDomain()

Specified by:

getDomain in interface TransactionContext

getReferrerHostname

public String getReferrerHostname()

Specified by:

getReferrerHostname in interface TransactionContext

isRequest

public boolean isRequest()

Specified by:

isRequest in interface Transaction

isResponse

public boolean isResponse()

Specified by:

isResponse in interface Transaction

getUserReference

public String getUserReference()

Specified by:

getUserReference in interface Transaction

doSetHttpResponse

protected abstract void doSetHttpResponse(io.netty.handler.codec.http.FullHttpResponse httpResponse)

doSetHttpRequest

protected abstract void doSetHttpRequest(io.netty.handler.codec.http.FullHttpRequest httpRequest)

setRequest

public void setRequest(io.netty.handler.codec.http.FullHttpRequest httpRequest)

Specified by:

setRequest in interface Transaction

setResponse

public void setResponse(io.netty.handler.codec.http.FullHttpResponse httpResponse)

Description copied from interface: Transaction

This method does not only set the http response object - it will make the whole transaction a response transaction, even if it was a request transaction, before!

Specified by:

setResponse in interface Transaction

getContentType

public String getContentType()

Specified by:

getContentType in interface Transaction

isContentChanged

public boolean isContentChanged()

Specified by:

isContentChanged in interface Transaction

setContentChanged

public void setContentChanged(boolean contentChanged)

Specified by:

setContentChanged in interface Transaction

isHeadersChanged

public boolean isHeadersChanged()

Specified by:

isHeadersChanged in interface Transaction

setHeadersChanged

public void setHeadersChanged(boolean headersChanged)

Specified by:

setHeadersChanged in interface Transaction

isComplete

public boolean isComplete()

Specified by:

isComplete in interface Transaction

setComplete

public void setComplete(boolean complete)

Specified by:

setComplete in interface Transaction

block

public void block()

Specified by:

block in interface Transaction

noContent

public void noContent()

Specified by:

noContent in interface Transaction

redirect

public void redirect(String targetUrl)

Specified by:

redirect in interface Transaction

getRedirectTarget

public String getRedirectTarget()

Specified by:

getRedirectTarget in interface TransactionContext

setRedirectTarget

public void setRedirectTarget(String redirectTarget)

Specified by:

setRedirectTarget in interface Transaction

getDecision

public Decision getDecision()

Specified by:

getDecision in interface TransactionContext

setDecision

public void setDecision(Decision decision)

Specified by:

setDecision in interface Transaction

isThirdParty

public boolean isThirdParty()

Specified by:

isThirdParty in interface TransactionContext

getBaseUrl

public String getBaseUrl()

Specified by:

getBaseUrl in interface Transaction

setBaseUrl

public void setBaseUrl(String baseUrl)

Specified by:

setBaseUrl in interface Transaction

getFilterResult

public FilterResult getFilterResult()

Specified by:

getFilterResult in interface Transaction

setFilterResult

public void setFilterResult(FilterResult filterResult)

Specified by:

setFilterResult in interface Transaction

getPageContext

public PageContext getPageContext()

Specified by:

getPageContext in interface Transaction

setPageContext

public void setPageContext(PageContext pageContext)

Specified by:

setPageContext in interface Transaction

getInjections

public Injections getInjections()

Specified by:

getInjections in interface Transaction

setInjections

public void setInjections(Injections injections)

Specified by:

setInjections in interface Transaction

getContentEncoding

public ContentEncoding getContentEncoding()

Specified by:

getContentEncoding in interface Transaction

setContentEncoding

public void setContentEncoding(ContentEncoding contentEncoding)

Specified by:

setContentEncoding in interface Transaction

getContent

public StringBuilder getContent()

Specified by:

getContent in interface Transaction

setContent

public void setContent(StringBuilder content)

Specified by:

setContent in interface Transaction

setControlBarUrl

public void setControlBarUrl(String controlBarUrl)

Description copied from interface: Transaction

Sets the base URL from which the ControlBar iframe, icons and XMLHttpRequests are loaded. The ControlBar URL is only set when the ControlBar code should be injected into an HTML response.

Specified by:

setControlBarUrl in interface Transaction

getControlBarUrl

public String getControlBarUrl()

Description copied from interface: Transaction

Returns the base URL from which the ControlBar iframe, icons and XMLHttpRequests are loaded.

Specified by:

getControlBarUrl in interface Transaction

Returns:

ControlBar base URL or null if the ControlBar should not be injected.

setCspNonce

public void setCspNonce(String cspNonce)

Description copied from interface: Transaction

Sets the nonce that can be used to allow the injected ControlBar script in the Content-Security-Policy of the response. The nonce is only set when the ControlBar code should be injected into an HTML response.

Specified by:

setCspNonce in interface Transaction

getCspNonce

public String getCspNonce()

Description copied from interface: Transaction

Returns the nonce that can be used to allow the injected ControlBar script in the Content-Security-Policy of the response.

Specified by:

getCspNonce in interface Transaction

Returns:

CSP nonce or null if the ControlBar should not be injected.