View Javadoc

1   package org.apache.maven.archiva.repository.scanner;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *  http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import org.apache.maven.archiva.configuration.ManagedRepositoryConfiguration;
23  import org.apache.maven.archiva.consumers.AbstractMonitoredConsumer;
24  import org.apache.maven.archiva.consumers.ConsumerException;
25  import org.apache.maven.archiva.consumers.KnownRepositoryContentConsumer;
26  
27  import java.util.Date;
28  import java.util.List;
29  
30  /**
31   * SampleKnownConsumer 
32   *
33   * @version $Id: SampleKnownConsumer.java 1041824 2010-12-03 14:11:05Z brett $
34   * 
35   * @plexus.component role="org.apache.maven.archiva.consumers.KnownRepositoryContentConsumer"
36   *                   role-hint="sample-known"
37   */
38  public class SampleKnownConsumer
39    extends AbstractMonitoredConsumer
40      implements KnownRepositoryContentConsumer
41  {
42      /**
43       * @plexus.configuration default-value="unset-id"
44       */
45      private String id = "unset-id";
46      
47      public void beginScan( ManagedRepositoryConfiguration repository, Date whenGathered )
48          throws ConsumerException
49      {
50          /* nothing to do */
51      }
52  
53      public void beginScan( ManagedRepositoryConfiguration repository, Date whenGathered, boolean executeOnEntireRepo )
54          throws ConsumerException
55      {
56          beginScan( repository, whenGathered );
57      }
58  
59      public void completeScan()
60      {
61          /* nothing to do */
62      }
63  
64      public void completeScan( boolean executeOnEntireRepo )
65      {
66          completeScan();
67      }
68  
69      public List<String> getExcludes()
70      {
71          return null;
72      }
73  
74      public List<String> getIncludes()
75      {
76          return null;
77      }
78  
79      public void processFile( String path )
80          throws ConsumerException
81      {
82          /* nothing to do */
83      }
84  
85      public void processFile( String path, boolean executeOnEntireRepo )
86          throws Exception
87      {
88          processFile( path );
89      }
90  
91      public String getDescription()
92      {
93          return "Sample Known Consumer";
94      }
95  
96      public String getId()
97      {
98          return id;
99      }
100 
101     public boolean isPermanent()
102     {
103         return false;
104     }
105 }