"Fossies" - the Fresh Open Source Software archive

Member "urlrewrite-3.2.0-src/api/org/tuckey/web/filters/urlrewrite/OutboundRule.html" of archive urlrewritefilter-3.2.0-src.zip:

Caution: In this restricted "Fossies" environment the current HTML page may not be correctly presentated and may have some non-functional links. Alternatively you can here view or download the uninterpreted source code. That can be also achieved for any archive member file by clicking within an archive contents listing on the first character of the file(path) respectively on the according byte size field.

Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.tuckey.web.filters.urlrewrite
Class OutboundRule

java.lang.Object
  extended by org.tuckey.web.filters.urlrewrite.RuleBase
      extended by org.tuckey.web.filters.urlrewrite.OutboundRule
All Implemented Interfaces:
Runnable
public class OutboundRule
extends RuleBase

Defines an outbound rule that can be run against a link in a page.

Version:
$Revision: 36 $ $Date: 2006-09-19 18:32:39 +1200 (Tue, 19 Sep 2006) $
Author:
Paul Tuckey

Field Summary
 
Fields inherited from class org.tuckey.web.filters.urlrewrite.RuleBase
DEFAULT_MATCH_TYPE, errors, from, id, initialised, MATCH_TYPE_WILDCARD, name, setAttributes, to, valid
 
Constructor Summary
OutboundRule()
          Constructor.
 
Method Summary
protected  void addError(java.lang.String s)
           
 RewrittenOutboundUrl execute(java.lang.String url, javax.servlet.http.HttpServletRequest hsRequest, javax.servlet.http.HttpServletResponse hsResponse)
          Execute this outbound rule.
 java.lang.String getDisplayName()
           
 boolean initialise(javax.servlet.ServletContext servletContext)
          Will initialise the outbound rule.
 boolean isEncodeFirst()
           
 boolean isEncodeToUrl()
           
 void setEncodeFirst(boolean encodeFirst)
           
 void setEncodeToUrl(boolean encodeToUrl)
           
 
Methods inherited from class org.tuckey.web.filters.urlrewrite.RuleBase
addCondition, addRun, addSetAttribute, destroy, getConditions, getErrors, getFrom, getFullDisplayName, getId, getMatchType, getName, getNote, getRuns, getSetAttributes, getTo, isEnabled, isFilter, isFromCaseSensitive, isLast, isMatchTypeWildcard, isNoSubstitution, isToContainsBackReference, isToContainsFunction, isToContainsVariable, isValid, matchesBase, setEnabled, setFrom, setFromCaseSensitive, setId, setMatchType, setName, setNote, setTo, setToLast
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OutboundRule

public OutboundRule()
Constructor.

Method Detail

execute

public RewrittenOutboundUrl execute(java.lang.String url,
                                    javax.servlet.http.HttpServletRequest hsRequest,
                                    javax.servlet.http.HttpServletResponse hsResponse)
                             throws java.lang.reflect.InvocationTargetException
Execute this outbound rule.

Throws:
java.lang.reflect.InvocationTargetException

initialise

public boolean initialise(javax.servlet.ServletContext servletContext)
Will initialise the outbound rule.

Overrides:
initialise in class RuleBase
Returns:
true on success

addError

protected void addError(java.lang.String s)
Overrides:
addError in class RuleBase

getDisplayName

public java.lang.String getDisplayName()
Overrides:
getDisplayName in class RuleBase

isEncodeFirst

public boolean isEncodeFirst()

isEncodeToUrl

public boolean isEncodeToUrl()

setEncodeFirst

public void setEncodeFirst(boolean encodeFirst)

setEncodeToUrl

public void setEncodeToUrl(boolean encodeToUrl)
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD