com.norconex.collector.http.filter.impl
Class RegexHeaderFilter

java.lang.Object
  extended by com.norconex.importer.filter.AbstractOnMatchFilter
      extended by com.norconex.collector.http.filter.impl.RegexHeaderFilter
All Implemented Interfaces:
IHttpHeadersFilter, IXMLConfigurable, IOnMatchFilter, Serializable

public class RegexHeaderFilter
extends AbstractOnMatchFilter
implements IHttpHeadersFilter, IXMLConfigurable

Accepts or rejects one or more HTTP header values using regular expression.

XML configuration usage:

  <filter class="com.norconex.collector.http.filter.impl.RegexHeaderFilter"
          onMatch="[include|exclude]" 
          caseSensitive="[false|true]" >
          header="(name of header to match)"
      (regular expression of value to match)
  </filter>
 

Author:
Pascal Essiembre
See Also:
Serialized Form

Constructor Summary
RegexHeaderFilter()
           
RegexHeaderFilter(String header, String regex)
           
RegexHeaderFilter(String header, String regex, OnMatch onMatch)
           
RegexHeaderFilter(String header, String regex, OnMatch onMatch, boolean caseSensitive)
           
 
Method Summary
 boolean acceptDocument(String url, HttpMetadata headers)
          Whether to accept a URL HTTP headers.
 boolean equals(Object obj)
           
 String getHeader()
           
 String getRegex()
           
 int hashCode()
           
 boolean isCaseSensitive()
           
 void loadFromXML(Reader in)
           
 void saveToXML(Writer out)
           
 void setCaseSensitive(boolean caseSensitive)
           
 void setHeader(String header)
           
 void setRegex(String regex)
           
 String toString()
           
 
Methods inherited from class com.norconex.importer.filter.AbstractOnMatchFilter
getOnMatch, loadFromXML, saveToXML, setOnMatch
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RegexHeaderFilter

public RegexHeaderFilter()

RegexHeaderFilter

public RegexHeaderFilter(String header,
                         String regex)

RegexHeaderFilter

public RegexHeaderFilter(String header,
                         String regex,
                         OnMatch onMatch)

RegexHeaderFilter

public RegexHeaderFilter(String header,
                         String regex,
                         OnMatch onMatch,
                         boolean caseSensitive)
Method Detail

getRegex

public String getRegex()

isCaseSensitive

public boolean isCaseSensitive()

getHeader

public String getHeader()

setCaseSensitive

public final void setCaseSensitive(boolean caseSensitive)

setHeader

public final void setHeader(String header)

setRegex

public final void setRegex(String regex)

acceptDocument

public boolean acceptDocument(String url,
                              HttpMetadata headers)
Description copied from interface: IHttpHeadersFilter
Whether to accept a URL HTTP headers.

Specified by:
acceptDocument in interface IHttpHeadersFilter
Parameters:
url - the URL to accept/reject its headers
headers - HTTP headers associated with the URL
Returns:
true if accepted, false otherwise

loadFromXML

public void loadFromXML(Reader in)
Specified by:
loadFromXML in interface IXMLConfigurable

saveToXML

public void saveToXML(Writer out)
               throws IOException
Specified by:
saveToXML in interface IXMLConfigurable
Throws:
IOException

toString

public String toString()
Overrides:
toString in class AbstractOnMatchFilter

equals

public boolean equals(Object obj)
Overrides:
equals in class AbstractOnMatchFilter

hashCode

public int hashCode()
Overrides:
hashCode in class AbstractOnMatchFilter


Copyright © 2009-2013 Norconex Inc.. All Rights Reserved.