uPortal 2.3.2
API Documentation

org.jasig.portal.channels.wsrp
Class MarkupWrapper

java.lang.Object
  extended byorg.jasig.portal.channels.wsrp.MarkupWrapper

public class MarkupWrapper
extends java.lang.Object

A wrapper for portlet markup that gets placed into a markup cache and keeps track of the time the markup was cached and when the markup expires.

Version:
$Revision: 1.1 $
Author:
Ken Weiner, kweiner@unicon.net

Constructor Summary
MarkupWrapper(java.lang.String markup, CacheControl cacheControl)
          Constructs a MarkupWrapper.
 
Method Summary
 CacheControl getCacheControl()
           
 long getCacheTime()
           
 java.lang.String getMarkup()
           
 boolean hasExpired()
          Reveals whether or not this markup has been cached longer than its expiration time.
 void setCacheControl(CacheControl cacheControl)
           
 void setCacheTime(long cacheTime)
           
 void setMarkup(java.lang.String markup)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MarkupWrapper

public MarkupWrapper(java.lang.String markup,
                     CacheControl cacheControl)
Constructs a MarkupWrapper.

Parameters:
markup - the portlet markup to cache
cacheControl - the cache control structure
Method Detail

getCacheTime

public long getCacheTime()

getCacheControl

public CacheControl getCacheControl()

getMarkup

public java.lang.String getMarkup()

setCacheTime

public void setCacheTime(long cacheTime)

setCacheControl

public void setCacheControl(CacheControl cacheControl)

setMarkup

public void setMarkup(java.lang.String markup)

hasExpired

public boolean hasExpired()
Reveals whether or not this markup has been cached longer than its expiration time. It is possible that the cache never expires. This is indicated in WSRP by an expires value of -1.

Returns:
true if the markup has expired, otherwise false

uPortal 2.3.2
API Documentation