org.apache.lenya.cms.cocoon.components.modules.input
Class ProxyModule

java.lang.Object
  extended by org.apache.avalon.framework.logger.AbstractLogEnabled
      extended by org.apache.cocoon.components.modules.input.AbstractInputModule
          extended by org.apache.lenya.cms.cocoon.components.modules.input.ProxyModule
All Implemented Interfaces:
org.apache.avalon.framework.activity.Disposable, org.apache.avalon.framework.component.Component, org.apache.avalon.framework.configuration.Configurable, org.apache.avalon.framework.logger.LogEnabled, org.apache.avalon.framework.service.Serviceable, org.apache.cocoon.components.modules.input.InputModule

public class ProxyModule
extends org.apache.cocoon.components.modules.input.AbstractInputModule
implements org.apache.avalon.framework.service.Serviceable

Input module for getting the base URL which may be prepended to internal URLs to construct links. The functionality corresponds to the ProxyTransformer with one exception: If the webappUrl parameter is an empty string, the root proxy URL (or the context prefix, resp.) is returned.

Usage: {proxy:{webappUrl}}

The module can be configured to use absolute or relative URLs in the same way as the ProxyTransformer.


Field Summary
protected static java.lang.String ATTRIBUTE_TYPE
           
protected static java.lang.String PARAMETER_URLS
           
protected static java.lang.String URL_TYPE_ABSOLUTE
           
protected static java.lang.String URL_TYPE_RELATIVE
           
 
Fields inherited from class org.apache.cocoon.components.modules.input.AbstractInputModule
settings
 
Fields inherited from interface org.apache.cocoon.components.modules.input.InputModule
ROLE
 
Constructor Summary
ProxyModule()
           
 
Method Summary
 void configure(org.apache.avalon.framework.configuration.Configuration conf)
           
 java.lang.Object getAttribute(java.lang.String name, org.apache.avalon.framework.configuration.Configuration modeConf, java.util.Map objectModel)
           
 java.util.Iterator getAttributeNames(org.apache.avalon.framework.configuration.Configuration modeConf, java.util.Map objectModel)
           
 java.lang.Object[] getAttributeValues(java.lang.String name, org.apache.avalon.framework.configuration.Configuration modeConf, java.util.Map objectModel)
           
protected  java.lang.String rewrite(org.apache.cocoon.environment.Request request, java.lang.String url)
           
 void service(org.apache.avalon.framework.service.ServiceManager manager)
           
protected  void setUrlType(java.lang.String value)
           
 
Methods inherited from class org.apache.cocoon.components.modules.input.AbstractInputModule
dispose
 
Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled
enableLogging, getLogger, setupLogger, setupLogger, setupLogger
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ATTRIBUTE_TYPE

protected static final java.lang.String ATTRIBUTE_TYPE
See Also:
Constant Field Values

URL_TYPE_ABSOLUTE

protected static final java.lang.String URL_TYPE_ABSOLUTE
See Also:
Constant Field Values

URL_TYPE_RELATIVE

protected static final java.lang.String URL_TYPE_RELATIVE
See Also:
Constant Field Values

PARAMETER_URLS

protected static final java.lang.String PARAMETER_URLS
See Also:
Constant Field Values
Constructor Detail

ProxyModule

public ProxyModule()
Method Detail

getAttribute

public java.lang.Object getAttribute(java.lang.String name,
                                     org.apache.avalon.framework.configuration.Configuration modeConf,
                                     java.util.Map objectModel)
                              throws org.apache.avalon.framework.configuration.ConfigurationException
Specified by:
getAttribute in interface org.apache.cocoon.components.modules.input.InputModule
Overrides:
getAttribute in class org.apache.cocoon.components.modules.input.AbstractInputModule
Throws:
org.apache.avalon.framework.configuration.ConfigurationException
See Also:
InputModule.getAttribute(java.lang.String, org.apache.avalon.framework.configuration.Configuration, java.util.Map)

rewrite

protected java.lang.String rewrite(org.apache.cocoon.environment.Request request,
                                   java.lang.String url)
                            throws org.apache.lenya.cms.repository.RepositoryException,
                                   org.apache.avalon.framework.configuration.ConfigurationException
Throws:
org.apache.lenya.cms.repository.RepositoryException
org.apache.avalon.framework.configuration.ConfigurationException

getAttributeNames

public java.util.Iterator getAttributeNames(org.apache.avalon.framework.configuration.Configuration modeConf,
                                            java.util.Map objectModel)
                                     throws org.apache.avalon.framework.configuration.ConfigurationException
Specified by:
getAttributeNames in interface org.apache.cocoon.components.modules.input.InputModule
Overrides:
getAttributeNames in class org.apache.cocoon.components.modules.input.AbstractInputModule
Throws:
org.apache.avalon.framework.configuration.ConfigurationException
See Also:
InputModule.getAttributeNames(org.apache.avalon.framework.configuration.Configuration, java.util.Map)

getAttributeValues

public java.lang.Object[] getAttributeValues(java.lang.String name,
                                             org.apache.avalon.framework.configuration.Configuration modeConf,
                                             java.util.Map objectModel)
                                      throws org.apache.avalon.framework.configuration.ConfigurationException
Specified by:
getAttributeValues in interface org.apache.cocoon.components.modules.input.InputModule
Overrides:
getAttributeValues in class org.apache.cocoon.components.modules.input.AbstractInputModule
Throws:
org.apache.avalon.framework.configuration.ConfigurationException
See Also:
InputModule.getAttributeValues(java.lang.String, org.apache.avalon.framework.configuration.Configuration, java.util.Map)

service

public void service(org.apache.avalon.framework.service.ServiceManager manager)
             throws org.apache.avalon.framework.service.ServiceException
Specified by:
service in interface org.apache.avalon.framework.service.Serviceable
Throws:
org.apache.avalon.framework.service.ServiceException
See Also:
Serviceable.service(org.apache.avalon.framework.service.ServiceManager)

configure

public void configure(org.apache.avalon.framework.configuration.Configuration conf)
               throws org.apache.avalon.framework.configuration.ConfigurationException
Specified by:
configure in interface org.apache.avalon.framework.configuration.Configurable
Overrides:
configure in class org.apache.cocoon.components.modules.input.AbstractInputModule
Throws:
org.apache.avalon.framework.configuration.ConfigurationException

setUrlType

protected void setUrlType(java.lang.String value)
                   throws org.apache.avalon.framework.configuration.ConfigurationException
Throws:
org.apache.avalon.framework.configuration.ConfigurationException


Copyright $ Apache Software Foundation. All Rights Reserved.