org.jasig.portal.channels.webproxy
Class CWebProxy.ChannelState

java.lang.Object
  org.jasig.portal.channels.webproxy.CWebProxy.ChannelState

Enclosing class:

CWebProxy

protected class CWebProxy.ChannelState
extends Object

All state variables are stored in this inner class. It would probably be an improvement to extract this inner class into its own fully fledged class in the cwebproxy package, thereby enforcing that its properties are only accessed via getter and setter methods that would need to be added.

Constructor Summary

CWebProxy.ChannelState(IUriScrutinizer uriScrutinizerArg)

Method Summary

Object	getCacheContent(String key)
long	getCacheContentLoaded()
IPerson	getIPerson()
void	setCacheContent(String key, Object data) Storing cache data is straigt-forward.
void	setXmlUri(String uriArg) Set the xmlUri channel state property, applying URI acceptance logic before accepting the parameter.
void	setXmlUriNotRestricted(String uri) Sets the xmlUri channel state property without applying URI acceptance logic.

Methods inherited from class java.lang.Object

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

Constructor Detail

CWebProxy.ChannelState

public CWebProxy.ChannelState(IUriScrutinizer uriScrutinizerArg)

Method Detail

setXmlUri

public void setXmlUri(String uriArg)

Set the xmlUri channel state property, applying URI acceptance logic before accepting the parameter.

Parameters:

uriArg - URI of XML source, or null

Throws:

IllegalArgumentException - if the uriArg is not in URI syntax or is a non-URI classpath-relative path which doesn't map to an actually existing resource.

BlockedUriException - if the URI is unacceptable for reasons of policy

Since:

uPortal 2.5.1

setXmlUriNotRestricted

public void setXmlUriNotRestricted(String uri)

Sets the xmlUri channel state property without applying URI acceptance logic.

setCacheContent

public void setCacheContent(String key,
                            Object data)

Storing cache data is straigt-forward. We rely on the cache implementation to remove data as it ages AND only allow a maximum amount of data into the structure.

Parameters:

key - the URL key String

data - our cache data as a String or Document Object

getCacheContent

public Object getCacheContent(String key)

getCacheContentLoaded

public long getCacheContentLoaded()

getIPerson

public IPerson getIPerson()