lumis.portal.servlet

Class UniqueWriterController

java.lang.Object

lumis.portal.servlet.UniqueWriterController

public class UniqueWriterController
extends Object

Class responsible for controlling unique writes based on keys.
Guarantees uniqueness during a request.

Since:

7.0.0

Version:

$Revision: 20129 $ $Date: 2017-04-18 16:06:53 +0000 (Tue, 18 Apr 2017) $

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UniqueWriterController.UniqueWriterControllerListener The interface that listeners must implement.

Method Summary

Modifier and Type	Method and Description
void	addTracedKey(String key) Add a key to tracedItems.
String	getHeadEndMarkers() Returns the head end markers (or null if there's no marker to be inserted).
String	getHeadStartMarkers() Returns the head start markers (or null if there's no marker to be inserted).
static UniqueWriterController	getInstance(HttpServletRequest request) Gets the instance that is controlling the writes in the given request.
String	getStringToLocallyWrite(String key, String text) Returns the string to be written locally (inline).
Set<String>	getUniqueKeys() Returns the unique keys used.
List<String>	getUntracedKeys() A list containing all items from getUniqueKeys() without the items present in tracedItems.
String	processHtml(String html, boolean isServerSide) Deprecated. since 8.2.0 replaced by processHtml(String, boolean, IPageWebResourceRenderRequest).
String	processHtml(String html, boolean isServerSide, IPageWebResourceRenderRequest renderRequest) Process the HTML replacing the found markers for their text fragment accordingly.
String	processHtml(String html, Set<String> usedKeys, boolean isServerSide, IPageWebResourceRenderRequest renderRequest) Process the HTML replacing the found markers for their text fragment accordingly.
void	removeListener() Removes this unique writer controller listener.
void	setListener(UniqueWriterController.UniqueWriterControllerListener listener) Sets this unique writer controller listener.
void	writeHead(String key, String text, PortalPrintWriter.WritePosition itemPosition) Inserts the item to be written in head.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static UniqueWriterController getInstance(HttpServletRequest request)

Gets the instance that is controlling the writes in the given request. If there's no controller yet, creates a new one and returns it.

Parameters:

request - the request being controlled.

Returns:

the controller for the request.

Since:

7.0.0

getStringToLocallyWrite

public String getStringToLocallyWrite(String key,
                                      String text)

Returns the string to be written locally (inline).

Parameters:

key - the unique key.

text - the text fragment.

Returns:

the string to be written locally (inline).

Since:

7.0.0

writeHead

public void writeHead(String key,
                      String text,
                      PortalPrintWriter.WritePosition itemPosition)

Inserts the item to be written in head.

Parameters:

key - the unique key.

text - the text fragment.

itemPosition - the item position.

Throws:

IllegalArgumentException - if the itemPosition parameter is null or is not any of PortalPrintWriter.WritePosition.HEAD_START or PortalPrintWriter.WritePosition.HEAD_END.

Since:

7.0.0

processHtml

@Deprecated
public String processHtml(String html,
                                      boolean isServerSide)
                               throws PortalException

Deprecated. since 8.2.0 replaced by processHtml(String, boolean, IPageWebResourceRenderRequest).

Process the HTML replacing the found markers for their text fragment accordingly.

Parameters:

html - the HTML to be processed.

renderRequest -

Returns:

the processed HTML.

Throws:

PortalException

Since:

7.0.0

processHtml

public String processHtml(String html,
                          boolean isServerSide,
                          IPageWebResourceRenderRequest renderRequest)
                   throws PortalException

Process the HTML replacing the found markers for their text fragment accordingly.

Parameters:

html - the HTML to be processed.

renderRequest -

Returns:

the processed HTML.

Throws:

PortalException

Since:

8.2.0

processHtml

public String processHtml(String html,
                          Set<String> usedKeys,
                          boolean isServerSide,
                          IPageWebResourceRenderRequest renderRequest)
                   throws PortalException

Process the HTML replacing the found markers for their text fragment accordingly.

Parameters:

html - the HTML to be processed.

usedKeys - the used keys that will not be processed.

Returns:

the processed HTML.

Throws:

PortalException

Since:

8.2.0

getHeadStartMarkers

public String getHeadStartMarkers()

Returns the head start markers (or null if there's no marker to be inserted).

Returns:

the head start markers (or null if there's no marker to be inserted).

Since:

7.0.0

getHeadEndMarkers

public String getHeadEndMarkers()

Returns the head end markers (or null if there's no marker to be inserted).

Returns:

the head end markers (or null if there's no marker to be inserted).

Since:

7.0.0

getUniqueKeys

public Set<String> getUniqueKeys()

Returns the unique keys used.

Returns:

the unique keys used.

Since:

7.0.0

setListener

public void setListener(UniqueWriterController.UniqueWriterControllerListener listener)

Sets this unique writer controller listener.

Parameters:

listener - the listener.

Since:

7.1.0

removeListener

public void removeListener()

Removes this unique writer controller listener.

Since:

7.1.0

getUntracedKeys

public List<String> getUntracedKeys()

A list containing all items from getUniqueKeys() without the items present in tracedItems.

Returns:

Since:

8.1.0

addTracedKey

public void addTracedKey(String key)

Add a key to tracedItems. The list is used by getUntracedKeys() to return getUniqueKeys() without the keys present in tracedItems.

Parameters:

key - The key to be added to the list.

Since:

8.1.0