/* 
    P/P   *  Method: org.apache.roller.weblogger.business.referrers.ReferrerQueueManager__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   * ReferrerQueueManager.java
    20   *
    21   * Created on December 16, 2005, 5:37 PM
    22   */
    23  
    24  package org.apache.roller.weblogger.business.referrers;
    25  
    26  /**
    27   * A queue for incoming referrers.
    28   *
    29   * @author Allen Gilliland
    30   */
    31  public interface ReferrerQueueManager {
    32      
    33      /**
    34       * Process an incoming referrer.
    35       *
    36       * This method may contain additional logic on how to deal with referrers.
    37       * It may process them immediately or it may store them for later processing.
    38       */
    39      public void processReferrer(IncomingReferrer ref);
    40      
    41      
    42      /**
    43       * Add a referrer to the queue.
    44       *
    45       * It is almost always preferable to call processReferrer() instead.
    46       */
    47      public void enqueue(IncomingReferrer ref);
    48      
    49      
    50      /**
    51       * Get the next item in the queue.
    52       *
    53       * Returns null if there is nothing in the queue.
    54       */
    55      public IncomingReferrer dequeue();
    56      
    57      
    58      /**
    59       * Called when the system is being shutdown.
    60       */
    61      public void shutdown();
    62      
    63  }