"Fossies" - the Fresh Open Source Software archive

Member "urlrewrite-3.2.0-src/api/org/tuckey/web/filters/urlrewrite/Rule.html" (4 Dec 2008, 17482 Bytes) of archive /linux/www/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.



org.tuckey.web.filters.urlrewrite
Interface Rule

All Known Implementing Classes:
ClassRule, NormalRule

public interface Rule


Method Summary
 void destroy()
           
 java.lang.String getDisplayName()
           
 java.util.List getErrors()
          List of strings for all errors.
 int getId()
           
 java.lang.String getName()
           
 boolean initialise(javax.servlet.ServletContext context)
          Will initialise the rule.
 boolean isFilter()
           
 boolean isLast()
           
 boolean isValid()
           
 RewrittenUrl matches(java.lang.String url, javax.servlet.http.HttpServletRequest hsRequest, javax.servlet.http.HttpServletResponse hsResponse)
           
 RewrittenUrl matches(java.lang.String url, javax.servlet.http.HttpServletRequest hsRequest, javax.servlet.http.HttpServletResponse hsResponse, RuleChain chain)
          Will run the rule against the uri and perform action required will return false is not matched otherwise true.
 void setId(int i)
           
 

Method Detail

matches

RewrittenUrl matches(java.lang.String url,
                     javax.servlet.http.HttpServletRequest hsRequest,
                     javax.servlet.http.HttpServletResponse hsResponse,
                     RuleChain chain)
                     throws java.io.IOException,
                            javax.servlet.ServletException,
                            java.lang.reflect.InvocationTargetException
Will run the rule against the uri and perform action required will return false is not matched otherwise true.

Parameters:
url -
hsRequest -
Returns:
String of the rewritten url or the same as the url passed in if no match was made
Throws:
java.io.IOException
javax.servlet.ServletException
java.lang.reflect.InvocationTargetException

matches

RewrittenUrl matches(java.lang.String url,
                     javax.servlet.http.HttpServletRequest hsRequest,
                     javax.servlet.http.HttpServletResponse hsResponse)
                     throws java.io.IOException,
                            javax.servlet.ServletException,
                            java.lang.reflect.InvocationTargetException
Throws:
java.io.IOException
javax.servlet.ServletException
java.lang.reflect.InvocationTargetException

initialise

boolean initialise(javax.servlet.ServletContext context)
Will initialise the rule.

Returns:
true on success

destroy

void destroy()

getName

java.lang.String getName()

getDisplayName

java.lang.String getDisplayName()

isLast

boolean isLast()

setId

void setId(int i)

getId

int getId()

isValid

boolean isValid()

isFilter

boolean isFilter()

getErrors

java.util.List getErrors()
List of strings for all errors.