getBaseActionURL() Returns a baseActionURL - parameters of a request coming in on the baseActionURL
will be placed into the ChannelRuntimeData object for channel's use.
getBaseActionURL(boolean idempotent) 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.
getBaseWorkerURL(String worker) 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.
getFnameActionURL(String fname) Returns an idempotent URL that includes a single query parameter that
targets a channel for focus mode by functional name.
setParameters(Map<String, Object> params) A convenience method for setting a whole set of parameters at once.
The values in the Map must be object arrays.
public void
setParametersSingleValued(Map<String, Object> params) A convenience method for setting a whole set of parameters at once.
The Map should contain name-value pairs.
Returns a baseActionURL - parameters of a request coming in on the baseActionURL
will be placed into the ChannelRuntimeData object for channel's use.
a value of URL to which parameter sequences should be appended.
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. a value of URL to which parameter sequences should be appended.
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.
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.
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.
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. URL to invoke the worker.
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. Parameters: idempotent - a boolean value sepcifying if a URL should be idempotent URL to invoke the worker. exception: PortalException - if an error occurs
Provides information about a user-agent associated with the current request/response.
a BrowserInfo object ecapsulating various user-agent information.
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.
a value of URL including a single query parameter. since: 2.5.1
Obtain an Object parameter value. If the parameter has multiple values, only the first value is returned.
Parameters: pName - parameter name parameter value
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.
true if channel is targeted, otherwise false
setBaseActionURL
public void setBaseActionURL(String baseActionURL)(Code)
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
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
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.
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.
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