| Home >> All >> org >> apache >> cocoon >> [ sunshine Javadoc ] |
• org.apache.cocoon.sunshine: Javadoc index of package org.apache.cocoon.sunshine.
Package Samples:
• org.apache.cocoon.sunshine.components
• org.apache.cocoon.sunshine.sunrise.selection
• org.apache.cocoon.sunshine.sunrise.generation
• org.apache.cocoon.sunshine.sunrise.context
• org.apache.cocoon.sunshine.sunrise.acting
• org.apache.cocoon.sunshine.sunrise
• org.apache.cocoon.sunshine.connector
• org.apache.cocoon.sunshine.sunspot.context
• org.apache.cocoon.sunshine.sunspot.sunlet
• org.apache.cocoon.sunshine.sunspot.generation
• org.apache.cocoon.sunshine.sunspot.acting
• org.apache.cocoon.sunshine.sunspot
• org.apache.cocoon.sunshine.transformation
• org.apache.cocoon.sunshine.xml
• org.apache.cocoon.sunshine.context
• org.apache.cocoon.sunshine.helpers
• org.apache.cocoon.sunshine.acting
Classes:
• InsertTransformer: This implementation allows the inserting of an xml fragment into a resource which is configured in sunConfig. XPath denoting the position to insert the xml fragment By default, the fragment is always inserted (added). It is possible to specify a node (by an XPath) which will be replaced if it exists. XPath denoting the position to insert the xml fragment XPath denoting a criteria for which node will be replaced The information for replace has to be relative to path, but can specify a subnode of the node the be replaced. The XPath specification is very complicated. So here is an example for the ...
• RequestSessionContext: A SessionContext which encapsulates the current Request object. It is not allowed to change this context. The following paths are valid: /parameter - lists all parameters, parameter names build the elements with the values as text node childs /parameter/ - one text node containing the value /querystring - the querystring with a leading '?' or null (the querystring is only for GET) /parametervalues - same as /parameter but values are listed as described below parameter name parameter value ... parameter name parameter value If a parameter has more than one value for each value a block is generated. ...
• ResponseSessionContext: A SessionContext which encapsulates the current Response object. The following XML for setXML and appendXML is allowed: /header/ - The content is the value of the header /cookie - The content is the cookie: gsdgsdg - name of the cookie gdgdgdgs - cookie value optional: true or false Using setXML uses setHeader() and appendXML uses addHeader. Despite this they both have the same effect.
• SunShine: This is the basic sunShine component. The main purpose of this component is session handling, maintaining contexts and providing system management functions. The session information is divided into session contexts. Transaction management Transactions are a series of get/set calls to a sessuib context which must be seen as atomic (single modification). We distingish between reading and writing. Usually parallel reading is allowed but if one thread wants to write, no other can read or write.
• URLRewriter: This is an XMLConsumer which rewrites the stream according to the configuration. The configuration can have the following parameters: "rewriteURLMode" : The mode to rewrite the urls. Currently none and sunShine are supported. "sunShineURL" : The url all links are resolved to "urlParameterName" : The parameter name to use for links (all links are then "sunShineURL?urlParameterName=LINK" "baseURL" : The current URL to rewrite
• SessionContext: Interface for a SessionContext. This interface describes a SessionContext. The SessionContext is a data container containing structured XML which can be retrieved/set by the sunshine transformer. This interface does not specify how the session context stores the data. This is left to the implementation itself, but actually this interface is build in the DOM model. As this context is used in a web context, all methods must be synchronized.
• SessionContextImpl: The sunSpot context This context allows access to various parts of a sunSpot profile. The context provides reading of the following xml, if the current resource is running inside a sunSpot module: <layout> <portal> ... </portal> <sunlets> ... </sunlets> </layout> <configuration> ... </configuration>
• SunShinePostTransformer: This is the sunShine post transformer. It does all the setting and destroying. Thus it should be the last transformer (before the xsl) in the pipeline. For performance and simplicity reasons this transformer inherits from the SunShinePreTransformer, although this is not needed (But then the implementation of the SunShineTransformer would be very unperformant.
• AuthAction: This is the authentication action for sunRise This action contains the complete configuration for sunRise. During configuration the sunRise class gets this configuration to configure the SunRise instances properly. The main task of this action is to check if the user is authenticated using a sunRise handler. If not a redirect takes place.
• XMLUtil: This class is an utitity class for miscellanous XML functions, like creating DOM documents, searching nodes via XPath and changing nodes using XPath. This class should be separated into several other ones. The XPath support should go to the XPath component etc. So this class will not be supported anymore...
• ResourceConnector: The Component for loading and saving xml to external resources. An external resource is specified by a type and an identifier. The type gives the connection information (file, http etc) and the identifier identifies the resource itself (filename, http-address etc).
• SunShineTransformer: This is the sunShine transformer which is only for compatibility. It inherits from the SunShineConnectTransformer which inherits from the sunShinePostTransformer whicb inherits from the SunShinePreTransformer. So those three do all the work
• SessionContextProvider: Interface for a context provider. Objects of this class provide special context, e.g. sunRise or sunSpot. The context is (if used) got once by the sunShine component for each request.
• SunShinePreTransformer: This is the sunShine pre transformer. It does all the getting and creation commands. This transformer should be the first in the pipeline.
• SunShineConnectTransformer: This is the sunShine connect transformer. The class is abstract as the SunShinePreTransformer inherits from this class.
• AuthAction: This is the authentication action for sunSpot This action protecteds a pipeline by using a sunLetID.
• ApplicationHandler: This object stores information about an application configuration inside a handler configuration.
• StandardSessionContextProvider: Context provider for the temporarily context, the request and the response context.
• Resource: This is a resource. It consists of a name and a type and possibly some parameters.
• ConfigurationGenerator: This generator generates the configuration of the portal for the current user.
• ResourceConnectorImpl: The Component for loading and saving xml to external resource connectors.
• LoggedInAction: This action tests if the user is logged in for a given sunRise handler.
• SunShineConstants: The Constants used throughout the core of sunShine.
• Constants: The Constants used throughout the core of sunRise.
• SunLetThread: This is the thread for loading one sunlet in the background.
| Home | Contact Us | Privacy Policy | Terms of Service |