/* 
    P/P   *  Method: org.apache.roller.weblogger.business.referrers.RefererManager__static_init
          */
     1  /*
     2  * Licensed to the Apache Software Foundation (ASF) under one or more
     3  *  contributor license agreements.  The ASF licenses this file to You
     4  * under the Apache License, Version 2.0 (the "License"); you may not
     5  * use this file except in compliance with the License.
     6  * You may obtain a copy of the License at
     7  *
     8  *     http://www.apache.org/licenses/LICENSE-2.0
     9  *
    10  * Unless required by applicable law or agreed to in writing, software
    11  * distributed under the License is distributed on an "AS IS" BASIS,
    12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13  * See the License for the specific language governing permissions and
    14  * limitations under the License.  For additional information regarding
    15  * copyright in this work, please see the NOTICE file in the top level
    16  * directory of this distribution.
    17  */
    18  
    19  package org.apache.roller.weblogger.business.referrers;
    20  
    21  import java.util.List;
    22  import org.apache.roller.weblogger.WebloggerException;
    23  import org.apache.roller.weblogger.pojos.WeblogReferrer;
    24  import org.apache.roller.weblogger.pojos.Weblog;
    25  
    26  /**
    27   * Interface to Referer management.
    28   */
    29  public interface RefererManager {    
    30      
    31      /**
    32       * Store the referer.
    33       */
    34      public void saveReferer(WeblogReferrer referer) throws WebloggerException;    
    35      
    36      /**
    37       * Remove a single referer.
    38       */
    39      public void removeReferer(WeblogReferrer referer) throws WebloggerException;    
    40      
    41      /**
    42       * Clear referrer dayhits and remove referrers without excerpts.
    43       */
    44      public void clearReferrers() throws WebloggerException;    
    45      
    46      /**
    47       * Clear referrer dayhits and remove referrers without excerpts.
    48       */
    49      public void clearReferrers(Weblog website) throws WebloggerException;    
    50      
    51      /**
    52       * Retrieve referer by id.
    53       */
    54      public WeblogReferrer getReferer(String id) throws WebloggerException;    
    55      
    56      /**
    57       * Get all referers for specified weblog.
    58       * @param weblog
    59       * @return List of type RefererData
    60       */
    61      public List getReferers(Weblog weblog) throws WebloggerException;    
    62      
    63      /**
    64       * Get all referers for specified user that were made today.
    65       * @param userName Name of user.
    66       * @return List of type RefererData
    67       */
    68      public List getTodaysReferers(Weblog website) throws WebloggerException;    
    69      
    70      /**
    71       * Get referers for a specified date.
    72       * @param userName Name of user.
    73       * @param date YYYYMMDD format of day's date.
    74       * @return List of type RefererData.
    75       * @throws WebloggerException
    76       */
    77      public List getReferersToDate(Weblog website, String date) 
    78          throws WebloggerException;    
    79          
    80      /**
    81       * Returns hot weblogs as StatCount objects, in descending order by today's hits.
    82       * @param sinceDays Restrict to last X days (or -1 for all)
    83       * @param offset    Offset into results (for paging)
    84       * @param len       Maximum number of results to return (for paging)
    85       * @return List of StatCount objects.
    86       */
    87      public List getHotWeblogs(int sinceDays, int offset, int length) 
    88          throws WebloggerException; 
    89  
    90      /**
    91       * Get referers that refer to a specific weblog entry.
    92       * @param entryid Weblog entry ID
    93       * @return List of RefererData objects.
    94       * @throws WebloggerException
    95       */
    96      public List getReferersToEntry(String entryid) throws WebloggerException;   
    97      
    98      /** 
    99       * Get user's day hits 
   100       */
   101      public int getDayHits(Weblog website) throws WebloggerException;    
   102      
   103      /** 
   104       * Get user's all-time total hits 
   105       */
   106      public int getTotalHits(Weblog website) throws WebloggerException;    
   107      
   108      /**
   109       * Apply ignoreWord/spam filters to all referers in system.
   110       */
   111      public void applyRefererFilters() throws WebloggerException;    
   112      
   113      /**
   114       * Apply ignoreWord/spam filters to all referers in website.
   115       */
   116      public void applyRefererFilters(Weblog website) throws WebloggerException;    
   117      
   118      /**
   119       * Process an incoming referer.
   120       */
   121      public void processReferrer(
   122              String requestUrl,
   123              String referrerUrl,
   124              String weblogHandle,
   125              String weblogAnchor,
   126              String weblogDateString);    
   127      
   128      /**
   129       * Release all resources held by manager.
   130       */
   131      public void release();  
   132  }
   133