org.jasig.portal
Class ChannelRuntimeData

java.lang.Object
  java.util.Dictionary<K,V>
      java.util.Hashtable<String,Object>
          org.jasig.portal.ChannelRuntimeData

All Implemented Interfaces:

Serializable, Cloneable, Map<String,Object>

Direct Known Subclasses:

MediaResolver

Deprecated. All IChannel implementations should be migrated to portlets

@Deprecated
public class ChannelRuntimeData
extends Hashtable<String,Object>
implements Cloneable

A set of runtime data accessible by a channel.

Version:

$Revision: 19776 $

Author:

Peter Kharchenko

See Also:

Serialized Form

Field Summary

static String	CAR_BASE Deprecated.
static String	WEB_APP_BASE Deprecated.

Constructor Summary

ChannelRuntimeData()
Deprecated. Default empty constructor

Method Summary

Object	clone() Deprecated. Create a new instance of ourself Used by the CError channel
String	getBaseActionURL() Deprecated. Returns a baseActionURL - parameters of a request coming in on the baseActionURL will be placed into the ChannelRuntimeData object for channel's use.
String	getBaseActionURL(boolean idempotent) Deprecated. All URLs are now idempotent. Use getBaseActionURL() instead.
String	getBaseMediaURL(Class aChannelClass) Deprecated. Returns a media base appropriate for web-visible resources used by and deployed with the passed in class.
String	getBaseMediaURL(Object aChannelObject) Deprecated. Returns a media base appropriate for web-visible resources used by and deployed with the passed in object.
String	getBaseMediaURL(String resourcePath) Deprecated. Returns a media base appropriate for the resource path passed in.
String	getBaseWorkerURL(String worker) Deprecated. Returns the URL to invoke one of the workers specified in PortalSessionManager.
String	getBaseWorkerURL(String worker, boolean idempotent) Deprecated. All urls are now idempotent, use getBaseWorkerURL(String) instead.
BrowserInfo	getBrowserInfo() Deprecated. Provides information about a user-agent associated with the current request/response.
String	getFnameActionURL(String fname) Deprecated. Returns an idempotent URL that includes a single query parameter that targets a channel for focus mode by functional name.
String	getHttpRequestMethod() Deprecated. Get HTTP request method (i.e.
String	getKeywords() Deprecated. Returns the keywords
Locale[]	getLocales() Deprecated. Accessor method for ordered set of locales.
Object	getObjectParameter(String pName) Deprecated. Obtain an Object parameter value.
Object[]	getObjectParameterValues(String pName) Deprecated. Obtain all values for a given parameter as Objects.
String	getParameter(String pName) Deprecated. Get a parameter value.
Enumeration	getParameterNames() Deprecated. Get an enumeration of parameter names.
Map<String,Object>	getParameters() Deprecated. Get the parameters as a Map
String[]	getParameterValues(String pName) Deprecated. Obtain all values for a given parameter.
String	getRemoteAddress() Deprecated.
RequestType	getRequestType() Deprecated.
UPFileSpec	getUPFile() Deprecated. Get the UPFileSpec
boolean	isRenderingAsRoot() Deprecated. Tells whether or not the channel is rendering as the root of the layout.
boolean	isTargeted() Deprecated. Tells whether or not the channel is currently targeted.
void	setBaseActionURL(String baseActionURL) Deprecated. Sets the base action URL.
void	setBrowserInfo(BrowserInfo bi) Deprecated. Setter method for browser info object.
void	setHttpRequestMethod(String method) Deprecated. Set the HTTP Request method.
void	setKeywords(String keywords) Deprecated. Sets the keywords
void	setLocales(Locale[] locales) Deprecated. Setter method for array of locales.
void	setParameter(String pName, String value) Deprecated. Establish a parameter name-value pair.
void	setParameters(Map<String,Object> params) Deprecated. A convenience method for setting a whole set of parameters at once.
void	setParametersSingleValued(Map<String,Object> params) Deprecated. A convenience method for setting a whole set of parameters at once.
String[]	setParameterValues(String pName, String[] values) Deprecated. Sets multi-valued parameter.
void	setRemoteAddress(String string) Deprecated.
void	setRenderingAsRoot(boolean rar) Deprecated. Sets whether or not the channel is rendering as the root of the layout.
void	setRequestType(RequestType requestType) Deprecated.
void	setTargeted(boolean targeted) Deprecated. Sets whether or not the channel is currently targeted.
void	setUPFile(UPFileSpec upfs) Deprecated. Set a UPFileSpec which will be used to produce baseActionURL and workerActionURL.
String	toString() Deprecated.

Methods inherited from class java.util.Hashtable

clear, contains, containsKey, containsValue, elements, entrySet, equals, get, hashCode, isEmpty, keys, keySet, put, putAll, rehash, remove, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

CAR_BASE

public static final String CAR_BASE

Deprecated.

See Also:

Constant Field Values

WEB_APP_BASE

public static final String WEB_APP_BASE

Deprecated.

Constructor Detail

ChannelRuntimeData

public ChannelRuntimeData()

Deprecated.

Default empty constructor

Method Detail

clone

public Object clone()

Deprecated.

Create a new instance of ourself Used by the CError channel

Overrides:

clone in class Hashtable<String,Object>

Returns:

crd the cloned ChannelRuntimeData object

setUPFile

public void setUPFile(UPFileSpec upfs)

Deprecated.

Set a UPFileSpec which will be used to produce baseActionURL and workerActionURL.

Parameters:

upfs - the UPFileSpec

getUPFile

public UPFileSpec getUPFile()

Deprecated.

Get the UPFileSpec

Returns:

channelUPFile the UPFileSpec

setHttpRequestMethod

public void setHttpRequestMethod(String method)

Deprecated.

Set the HTTP Request method.

Parameters:

method - a String value

getHttpRequestMethod

public String getHttpRequestMethod()

Deprecated.

Get HTTP request method (i.e. GET, POST)

Returns:

a String value

setBaseActionURL

public void setBaseActionURL(String baseActionURL)

Deprecated.

Sets the base action URL. This was added back in for the benefit of web services. Not sure if it is going to stay this way.

Parameters:

baseActionURL - the base action URL

setRenderingAsRoot

public void setRenderingAsRoot(boolean rar)

Deprecated.

Sets whether or not the channel is rendering as the root of the layout.

Parameters:

rar - true if channel is rendering as the root, otherwise false

setTargeted

public void setTargeted(boolean targeted)

Deprecated.

Sets whether or not the channel is currently targeted. A channel is targeted if an incoming request specifies the channel's subscribe ID as the targeted node ID.

Parameters:

targeted - true if channel is targeted, otherwise false

setBrowserInfo

public void setBrowserInfo(BrowserInfo bi)

Deprecated.

Setter method for browser info object.

Parameters:

bi - a browser info associated with the current request

getBrowserInfo

public BrowserInfo getBrowserInfo()

Deprecated.

Provides information about a user-agent associated with the current request/response.

Returns:

a BrowserInfo object ecapsulating various user-agent information.

setLocales

public void setLocales(Locale[] locales)

Deprecated.

Setter method for array of locales. A channel should make an effort to render itself according to the order of the locales in this array.

Parameters:

locales - an ordered list of locales

getLocales

public Locale[] getLocales()

Deprecated.

Accessor method for ordered set of locales.

Returns:

locales an ordered list of locales

setParameters

public void setParameters(Map<String,Object> params)

Deprecated.

A convenience method for setting a whole set of parameters at once. The values in the Map must be object arrays. If (name, value[]) is in the Map, then a future call to getParameter(name) will return value[0].

Parameters:

params - a Map of parameter names to parameter value arrays.

setParametersSingleValued

public void setParametersSingleValued(Map<String,Object> params)

Deprecated.

A convenience method for setting a whole set of parameters at once. The Map should contain name-value pairs. The name should be a String and the value should be either a String or a Part. If (name, value) is in the Map then a future call to getParameter(name) will return value.

Parameters:

params - a Map of parameter names to parameter value arrays.

setParameterValues

public String[] setParameterValues(String pName,
                                   String[] values)

Deprecated.

Sets multi-valued parameter.

Parameters:

pName - parameter name

values - an array of parameter values

Returns:

an array of parameter values

setParameter

public void setParameter(String pName,
                         String value)

Deprecated.

Establish a parameter name-value pair.

Parameters:

pName - parameter name

value - parameter value

getBaseActionURL

public String getBaseActionURL()

Deprecated.

Returns a baseActionURL - parameters of a request coming in on the baseActionURL will be placed into the ChannelRuntimeData object for channel's use.

Returns:

a value of URL to which parameter sequences should be appended.

getBaseActionURL

public String getBaseActionURL(boolean idempotent)

Deprecated. All URLs are now idempotent. Use getBaseActionURL() instead.

Returns a baseActionURL - parameters of a request coming in on the baseActionURL will be placed into the ChannelRuntimeData object for channel's use.

Parameters:

idempotent - a boolean value specifying if a given URL should be idepotent.

Returns:

a value of URL to which parameter sequences should be appended.

getFnameActionURL

public String getFnameActionURL(String fname)

Deprecated.

Returns an idempotent URL that includes a single query parameter that targets a channel for focus mode by functional name. Additional query parameters appended will be passed to the focused channel via the channel's ChannelRuntimeData object.

Returns:

a value of URL including a single query parameter.

Since:

2.5.1

getBaseWorkerURL

public String getBaseWorkerURL(String worker)

Deprecated.

Returns the URL to invoke one of the workers specified in PortalSessionManager. Typically the channel that is invoked with the worker will have to implement an interface specific for that worker.

Parameters:

worker - - Worker string must be a UPFileSpec.xxx value.

Returns:

URL to invoke the worker.

getBaseMediaURL

public String getBaseMediaURL(Object aChannelObject)
                       throws PortalException

Deprecated.

Returns a media base appropriate for web-visible resources used by and deployed with the passed in object. If the class of the passed in object was loaded from a CAR then a URL appropriate for accessing images in CARs is returned. Otherwise, a URL to the base media in the web application's document root is returned.

Throws:

PortalException

getBaseMediaURL

public String getBaseMediaURL(Class aChannelClass)
                       throws PortalException

Deprecated.

Returns a media base appropriate for web-visible resources used by and deployed with the passed in class. If the class of the passed in object was loaded from a CAR then a URL appropriate for accessing images in CARs is returned. Otherwise, a URL to the base media in the web application's document root is returned.

Throws:

PortalException

getBaseMediaURL

public String getBaseMediaURL(String resourcePath)
                       throws PortalException

Deprecated.

Returns a media base appropriate for the resource path passed in. The resource path is the path to the resource within its channel archive. (See org.jasig.portal.car.CarResources class for more information.) If the passed in resourcePath matches that of a resource loaded from CARs then this method returns a URL appropriate to obtain CAR deployed, web-visible resources. Otherwise it returns a URL to the traditional media path under the uPortal web application's document root.

Throws:

PortalException

getBaseWorkerURL

public String getBaseWorkerURL(String worker,
                               boolean idempotent)
                        throws PortalException

Deprecated. All urls are now idempotent, use getBaseWorkerURL(String) instead.

Returns the URL to invoke one of the workers specified in PortalSessionManager. Typically the channel that is invoked with the worker will have to implement an interface specific for that worker.

Parameters:

worker - - Worker string must be a UPFileSpec.xxx value.

idempotent - a boolean value sepcifying if a URL should be idempotent

Returns:

URL to invoke the worker.

Throws:

PortalException - if an error occurs

isRenderingAsRoot

public boolean isRenderingAsRoot()

Deprecated.

Tells whether or not the channel is rendering as the root of the layout.

Returns:

true if channel is rendering as the root, otherwise false

isTargeted

public boolean isTargeted()

Deprecated.

Tells whether or not the channel is currently targeted. A channel is targeted if an incoming request specifies the channel's subscribe ID as the targeted node ID.

Returns:

true if channel is targeted, otherwise false

getParameter

public String getParameter(String pName)

Deprecated.

Get a parameter value. If the parameter has multiple values, only the first value is returned.

Parameters:

pName - parameter name

Returns:

parameter value

getObjectParameter

public Object getObjectParameter(String pName)

Deprecated.

Obtain an Object parameter value. If the parameter has multiple values, only the first value is returned.

Parameters:

pName - parameter name

Returns:

parameter value

getParameterValues

public String[] getParameterValues(String pName)

Deprecated.

Obtain all values for a given parameter.

Parameters:

pName - parameter name

Returns:

an array of parameter string values

getObjectParameterValues

public Object[] getObjectParameterValues(String pName)

Deprecated.

Obtain all values for a given parameter as Objects.

Parameters:

pName - parameter name

Returns:

a vector of parameter Object[] values

getParameterNames

public Enumeration getParameterNames()

Deprecated.

Get an enumeration of parameter names.

Returns:

an Enumeration of parameter names.

getParameters

public Map<String,Object> getParameters()

Deprecated.

Get the parameters as a Map

Returns:

a Map of parameter name-value pairs

setKeywords

public void setKeywords(String keywords)

Deprecated.

Sets the keywords

Parameters:

keywords - a String of keywords

getKeywords

public String getKeywords()

Deprecated.

Returns the keywords

Returns:

a String of keywords, null if there were none

getRemoteAddress

public String getRemoteAddress()

Deprecated.

Returns:

the remote address

setRemoteAddress

public void setRemoteAddress(String string)

Deprecated.

Parameters:

string -

getRequestType

public RequestType getRequestType()

Deprecated.

Returns:

the requestType

setRequestType

public void setRequestType(RequestType requestType)

Deprecated.

Parameters:

requestType - the requestType to set

toString

public String toString()

Deprecated.

Overrides:

toString in class Hashtable<String,Object>