|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.util.Dictionary
java.util.Hashtable
org.jasig.portal.ChannelRuntimeData
A set of runtime data accessible by a channel.
Constructor Summary | |
ChannelRuntimeData()
Default empty constructor |
Method Summary | |
java.lang.Object |
clone()
Create a new instance of ourself Used by the CError channel |
java.lang.String |
getBaseActionURL()
Returns a baseActionURL - parameters of a request coming in on the baseActionURL will be placed into the ChannelRuntimeData object for channel's use. |
java.lang.String |
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. |
java.lang.String |
getBaseMediaURL(java.lang.Class aChannelClass)
Returns a media base appropriate for web-visible resources used by and deployed with the passed in class. |
java.lang.String |
getBaseMediaURL(java.lang.Object aChannelObject)
Returns a media base appropriate for web-visible resources used by and deployed with the passed in object. |
java.lang.String |
getBaseMediaURL(java.lang.String resourcePath)
Returns a media base appropriate for the resource path passed in. |
java.lang.String |
getBaseWorkerURL(java.lang.String worker)
Returns the URL to invoke one of the workers specified in PortalSessionManager. |
java.lang.String |
getBaseWorkerURL(java.lang.String worker,
boolean idempotent)
Returns the URL to invoke one of the workers specified in PortalSessionManager. |
BrowserInfo |
getBrowserInfo()
Provides information about a user-agent associated with the current request/response. |
java.lang.String |
getHttpRequestMethod()
Get HTTP request method (i.e. |
java.lang.String |
getKeywords()
Returns the keywords |
java.util.Locale[] |
getLocales()
Accessor method for ordered set of locales. |
java.lang.Object |
getObjectParameter(java.lang.String pName)
Obtain an Object parameter value. |
java.lang.Object[] |
getObjectParameterValues(java.lang.String pName)
Obtain all values for a given parameter as Object s. |
java.lang.String |
getParameter(java.lang.String pName)
Get a parameter value. |
java.util.Enumeration |
getParameterNames()
Get an enumeration of parameter names. |
java.util.Map |
getParameters()
Get the parameters as a Map |
java.lang.String[] |
getParameterValues(java.lang.String pName)
Obtain all values for a given parameter. |
java.lang.String |
getRemoteAddress()
|
UPFileSpec |
getUPFile()
Get the UPFileSpec |
boolean |
isRenderingAsRoot()
Tells whether or not the channel is rendering as the root of the layout. |
boolean |
isTargeted()
Tells whether or not the channel is currently targeted. |
void |
setBaseActionURL(java.lang.String baseActionURL)
Sets the base action URL. |
void |
setBrowserInfo(BrowserInfo bi)
Setter method for browser info object. |
void |
setHttpRequestMethod(java.lang.String method)
Set the HTTP Reqeust method. |
void |
setKeywords(java.lang.String keywords)
Sets the keywords |
void |
setLocales(java.util.Locale[] locales)
Setter method for array of locales. |
void |
setParameter(java.lang.String key,
com.oreilly.servlet.multipart.Part value)
|
void |
setParameter(java.lang.String pName,
java.lang.String value)
Establish a parameter name-value pair. |
void |
setParameters(java.util.Map params)
A convenience method for setting a whole set of parameters at once. |
void |
setParametersSingleValued(java.util.Map params)
A convenience method for setting a whole set of parameters at once. |
com.oreilly.servlet.multipart.Part[] |
setParameterValues(java.lang.String pName,
com.oreilly.servlet.multipart.Part[] values)
|
java.lang.String[] |
setParameterValues(java.lang.String pName,
java.lang.String[] values)
Sets multi-valued parameter. |
void |
setRemoteAddress(java.lang.String string)
|
void |
setRenderingAsRoot(boolean rar)
Sets whether or not the channel is rendering as the root of the layout. |
void |
setTargeted(boolean targeted)
Sets whether or not the channel is currently targeted. |
void |
setUPFile(UPFileSpec upfs)
Set a UPFileSpec which will be used to produce baseActionURL and workerActionURL. |
Methods inherited from class java.util.Hashtable |
clear, contains, containsKey, containsValue, elements, entrySet, equals, get, hashCode, isEmpty, keys, keySet, put, putAll, remove, size, toString, values |
Methods inherited from class java.lang.Object |
getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public ChannelRuntimeData()
Method Detail |
public java.lang.Object clone()
public void setUPFile(UPFileSpec upfs)
upfs
- the UPFileSpecpublic UPFileSpec getUPFile()
public void setHttpRequestMethod(java.lang.String method)
method
- a String
valuepublic java.lang.String getHttpRequestMethod()
String
valuepublic void setBaseActionURL(java.lang.String baseActionURL)
baseActionURL
- the base action URLpublic void setRenderingAsRoot(boolean rar)
rar
- true
if channel is rendering as the root, otherwise false
public void setTargeted(boolean targeted)
targeted
- true
if channel is targeted, otherwise false
public void setBrowserInfo(BrowserInfo bi)
bi
- a browser info associated with the current requestpublic BrowserInfo getBrowserInfo()
BrowserInfo
object ecapsulating various user-agent information.public void setLocales(java.util.Locale[] locales)
locales
- an ordered list of localespublic java.util.Locale[] getLocales()
public void setParameters(java.util.Map params)
params
- a Map
of parameter names to parameter value arrays.public void setParametersSingleValued(java.util.Map params)
params
- a Map
of parameter names to parameter value arrays.public java.lang.String[] setParameterValues(java.lang.String pName, java.lang.String[] values)
pName
- parameter namevalues
- an array of parameter values
public void setParameter(java.lang.String pName, java.lang.String value)
pName
- parameter namevalue
- parameter valuepublic com.oreilly.servlet.multipart.Part[] setParameterValues(java.lang.String pName, com.oreilly.servlet.multipart.Part[] values)
public void setParameter(java.lang.String key, com.oreilly.servlet.multipart.Part value)
public java.lang.String getBaseActionURL()
public java.lang.String getBaseActionURL(boolean idempotent)
idempotent
- a boolean
value specifying if a given URL should be idepotent.
public java.lang.String getBaseWorkerURL(java.lang.String worker)
worker
- - Worker string must be a UPFileSpec.xxx value.
public java.lang.String getBaseMediaURL(java.lang.Object aChannelObject) throws PortalException
PortalException
public java.lang.String getBaseMediaURL(java.lang.Class aChannelClass) throws PortalException
PortalException
public java.lang.String getBaseMediaURL(java.lang.String resourcePath) throws PortalException
PortalException
public java.lang.String getBaseWorkerURL(java.lang.String worker, boolean idempotent) throws PortalException
worker
- - Worker string must be a UPFileSpec.xxx value.idempotent
- a boolean
value sepcifying if a URL should be idempotent
PortalException
- if an error occurspublic boolean isRenderingAsRoot()
true
if channel is rendering as the root, otherwise false
public boolean isTargeted()
true
if channel is targeted, otherwise false
public java.lang.String getParameter(java.lang.String pName)
pName
- parameter name
public java.lang.Object getObjectParameter(java.lang.String pName)
Object
parameter value. If the parameter has multiple values, only the first value is returned.
pName
- parameter name
public java.lang.String[] getParameterValues(java.lang.String pName)
pName
- parameter name
public java.lang.Object[] getObjectParameterValues(java.lang.String pName)
Object
s.
pName
- parameter name
Object[]
valuespublic java.util.Enumeration getParameterNames()
Enumeration
of parameter names.public java.util.Map getParameters()
public void setKeywords(java.lang.String keywords)
keywords
- a String of keywordspublic java.lang.String getKeywords()
public java.lang.String getRemoteAddress()
public void setRemoteAddress(java.lang.String string)
string
-
|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |