Java Doc for ChannelRuntimeData.java in  » Portal » uPortal_rel-2-6-1-GA » org » jasig » portal » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Portal » uPortal_rel 2 6 1 GA » org.jasig.portal 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.jasig.portal.ChannelRuntimeData

All known Subclasses:   org.jasig.portal.channels.jsp.MediaResolver,
ChannelRuntimeData
public class ChannelRuntimeData extends Hashtable implements Cloneable(Code)
A set of runtime data accessible by a channel.
author:
   Peter Kharchenko
version:
   $Revision: 42267 $


Field Summary
final public static  StringCAR_BASE
    
final public static  StringWEB_APP_BASE
    

Constructor Summary
public  ChannelRuntimeData()
    

Method Summary
public  Objectclone()
    
public  StringgetBaseActionURL()
     Returns a baseActionURL - parameters of a request coming in on the baseActionURL will be placed into the ChannelRuntimeData object for channel's use.
public  StringgetBaseActionURL(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.
public  StringgetBaseMediaURL(Object aChannelObject)
     Returns a media base appropriate for web-visible resources used by and deployed with the passed in object.
public  StringgetBaseMediaURL(Class aChannelClass)
     Returns a media base appropriate for web-visible resources used by and deployed with the passed in class.
public  StringgetBaseMediaURL(String resourcePath)
     Returns a media base appropriate for the resource path passed in.
public  StringgetBaseWorkerURL(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.
public  StringgetBaseWorkerURL(String worker, boolean idempotent)
     Returns the URL to invoke one of the workers specified in PortalSessionManager.
public  BrowserInfogetBrowserInfo()
     Provides information about a user-agent associated with the current request/response.
public  StringgetFnameActionURL(String fname)
     Returns an idempotent URL that includes a single query parameter that targets a channel for focus mode by functional name.
public  StringgetHttpRequestMethod()
     Get HTTP request method (i.e.
public  StringgetKeywords()
    
public  Locale[]getLocales()
     Accessor method for ordered set of locales.
public  ObjectgetObjectParameter(String pName)
     Obtain an Object parameter value.
public  Object[]getObjectParameterValues(String pName)
     Obtain all values for a given parameter as Objects.
public  StringgetParameter(String pName)
     Get a parameter value.
public  EnumerationgetParameterNames()
     Get an enumeration of parameter names.
public  String[]getParameterValues(String pName)
     Obtain all values for a given parameter.
public  Map<String, Object>getParameters()
    
public  StringgetRemoteAddress()
    
public  UPFileSpecgetUPFile()
    
public  booleanisRenderingAsRoot()
     Tells whether or not the channel is rendering as the root of the layout.
public  booleanisTargeted()
     Tells whether or not the channel is currently targeted.
public  voidsetBaseActionURL(String baseActionURL)
     Sets the base action URL.
public  voidsetBrowserInfo(BrowserInfo bi)
     Setter method for browser info object.
public  voidsetHttpRequestMethod(String method)
     Set the HTTP Request method.
public  voidsetKeywords(String keywords)
    
public  voidsetLocales(Locale[] locales)
     Setter method for array of locales.
public  voidsetParameter(String pName, String value)
     Establish a parameter name-value pair.
public synchronized  voidsetParameter(String key, Part value)
    
public  String[]setParameterValues(String pName, String[] values)
     Sets multi-valued parameter.
public  com.oreilly.servlet.multipart.Part[]setParameterValues(String pName, com.oreilly.servlet.multipart.Part[] values)
    
public  voidsetParameters(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  voidsetParametersSingleValued(Map<String, Object> params)
     A convenience method for setting a whole set of parameters at once. The Map should contain name-value pairs.
public  voidsetRemoteAddress(String string)
    
public  voidsetRenderingAsRoot(boolean rar)
     Sets whether or not the channel is rendering as the root of the layout.
public  voidsetTargeted(boolean targeted)
     Sets whether or not the channel is currently targeted.
public  voidsetUPFile(UPFileSpec upfs)
     Set a UPFileSpec which will be used to produce baseActionURL and workerActionURL.
public  StringtoString()
    

Field Detail
CAR_BASE
final public static String CAR_BASE(Code)



WEB_APP_BASE
final public static String WEB_APP_BASE(Code)




Constructor Detail
ChannelRuntimeData
public ChannelRuntimeData()(Code)
Default empty constructor




Method Detail
clone
public Object clone()(Code)
Create a new instance of ourself Used by the CError channel crd the cloned ChannelRuntimeData object



getBaseActionURL
public String getBaseActionURL()(Code)
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.



getBaseActionURL
public String getBaseActionURL(boolean idempotent)(Code)
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.



getBaseMediaURL
public String getBaseMediaURL(Object aChannelObject) throws PortalException(Code)
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.



getBaseMediaURL
public String getBaseMediaURL(Class aChannelClass) throws PortalException(Code)
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.



getBaseMediaURL
public String getBaseMediaURL(String resourcePath) throws PortalException(Code)
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.



getBaseWorkerURL
public String getBaseWorkerURL(String worker)(Code)
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.



getBaseWorkerURL
public String getBaseWorkerURL(String worker, boolean idempotent) throws PortalException(Code)
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



getBrowserInfo
public BrowserInfo getBrowserInfo()(Code)
Provides information about a user-agent associated with the current request/response. a BrowserInfo object ecapsulating various user-agent information.



getFnameActionURL
public String getFnameActionURL(String fname)(Code)
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



getHttpRequestMethod
public String getHttpRequestMethod()(Code)
Get HTTP request method (i.e. GET, POST) a String value



getKeywords
public String getKeywords()(Code)
Returns the keywords a String of keywords, null if there were none



getLocales
public Locale[] getLocales()(Code)
Accessor method for ordered set of locales. locales an ordered list of locales



getObjectParameter
public Object getObjectParameter(String pName)(Code)
Obtain an Object parameter value. If the parameter has multiple values, only the first value is returned.
Parameters:
  pName - parameter name parameter value



getObjectParameterValues
public Object[] getObjectParameterValues(String pName)(Code)
Obtain all values for a given parameter as Objects.
Parameters:
  pName - parameter name a vector of parameter Object[] values



getParameter
public String getParameter(String pName)(Code)
Get a parameter value. If the parameter has multiple values, only the first value is returned.
Parameters:
  pName - parameter name parameter value



getParameterNames
public Enumeration getParameterNames()(Code)
Get an enumeration of parameter names. an Enumeration of parameter names.



getParameterValues
public String[] getParameterValues(String pName)(Code)
Obtain all values for a given parameter.
Parameters:
  pName - parameter name an array of parameter string values



getParameters
public Map<String, Object> getParameters()(Code)
Get the parameters as a Map a Map of parameter name-value pairs



getRemoteAddress
public String getRemoteAddress()(Code)
the remote address



getUPFile
public UPFileSpec getUPFile()(Code)
Get the UPFileSpec channelUPFile the UPFileSpec



isRenderingAsRoot
public boolean isRenderingAsRoot()(Code)
Tells whether or not the channel is rendering as the root of the layout. true if channel is rendering as the root, otherwise false



isTargeted
public boolean isTargeted()(Code)
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



setBrowserInfo
public void setBrowserInfo(BrowserInfo bi)(Code)
Setter method for browser info object.
Parameters:
  bi - a browser info associated with the current request



setHttpRequestMethod
public void setHttpRequestMethod(String method)(Code)
Set the HTTP Request method.
Parameters:
  method - a String value



setKeywords
public void setKeywords(String keywords)(Code)
Sets the keywords
Parameters:
  keywords - a String of keywords



setLocales
public void setLocales(Locale[] locales)(Code)
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



setParameter
public void setParameter(String pName, String value)(Code)
Establish a parameter name-value pair.
Parameters:
  pName - parameter name
Parameters:
  value - parameter value



setParameter
public synchronized void setParameter(String key, Part value)(Code)



setParameterValues
public String[] setParameterValues(String pName, String[] values)(Code)
Sets multi-valued parameter.
Parameters:
  pName - parameter name
Parameters:
  values - an array of parameter values an array of parameter values



setParameterValues
public com.oreilly.servlet.multipart.Part[] setParameterValues(String pName, com.oreilly.servlet.multipart.Part[] values)(Code)



setParameters
public void setParameters(Map<String, Object> params)(Code)
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)(Code)
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.



setRemoteAddress
public void setRemoteAddress(String string)(Code)

Parameters:
  string -



setRenderingAsRoot
public void setRenderingAsRoot(boolean rar)(Code)
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)(Code)
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



setUPFile
public void setUPFile(UPFileSpec upfs)(Code)
Set a UPFileSpec which will be used to produce baseActionURL and workerActionURL.
Parameters:
  upfs - the UPFileSpec



toString
public String toString()(Code)



www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.