View Javadoc

1   package org.apache.continuum.purge;
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.continuum.model.repository.AbstractPurgeConfiguration;
23  import org.apache.continuum.model.repository.DirectoryPurgeConfiguration;
24  import org.apache.continuum.model.repository.DistributedDirectoryPurgeConfiguration;
25  import org.apache.continuum.model.repository.RepositoryPurgeConfiguration;
26  import org.apache.continuum.purge.repository.content.RepositoryManagedContent;
27  
28  import java.util.List;
29  
30  /**
31   * @author Maria Catherine Tan
32   * @version $Id: PurgeConfigurationService.java 1372260 2012-08-13 04:29:09Z brett $
33   * @since 25 jul 07
34   */
35  public interface PurgeConfigurationService
36  {
37      String ROLE = PurgeConfigurationService.class.getName();
38  
39      AbstractPurgeConfiguration addPurgeConfiguration( AbstractPurgeConfiguration purgeConfig )
40          throws PurgeConfigurationServiceException;
41  
42      void updatePurgeConfiguration( AbstractPurgeConfiguration purgeConfig )
43          throws PurgeConfigurationServiceException;
44  
45      void removePurgeConfiguration( int purgeConfigId )
46          throws PurgeConfigurationServiceException;
47  
48      RepositoryPurgeConfiguration addRepositoryPurgeConfiguration( RepositoryPurgeConfiguration repoPurge )
49          throws PurgeConfigurationServiceException;
50  
51      void updateRepositoryPurgeConfiguration( RepositoryPurgeConfiguration repoPurge )
52          throws PurgeConfigurationServiceException;
53  
54      void removeRepositoryPurgeConfiguration( RepositoryPurgeConfiguration repoPurge )
55          throws PurgeConfigurationServiceException;
56  
57      RepositoryPurgeConfiguration getRepositoryPurgeConfiguration( int repoPurgeId )
58          throws PurgeConfigurationServiceException;
59  
60      RepositoryPurgeConfiguration getDefaultPurgeConfigurationForRepository( int repositoryId );
61  
62      List<RepositoryPurgeConfiguration> getRepositoryPurgeConfigurationsBySchedule( int scheduleId );
63  
64      List<RepositoryPurgeConfiguration> getEnableRepositoryPurgeConfigurationsBySchedule( int scheduleId );
65  
66      List<RepositoryPurgeConfiguration> getRepositoryPurgeConfigurationsByRepository( int repositoryId );
67  
68      List<RepositoryPurgeConfiguration> getAllRepositoryPurgeConfigurations();
69  
70      DirectoryPurgeConfiguration addDirectoryPurgeConfiguration( DirectoryPurgeConfiguration dirPurge )
71          throws PurgeConfigurationServiceException;
72  
73      void updateDirectoryPurgeConfiguration( DirectoryPurgeConfiguration dirPurge )
74          throws PurgeConfigurationServiceException;
75  
76      void removeDirectoryPurgeConfiguration( DirectoryPurgeConfiguration dirPurge )
77          throws PurgeConfigurationServiceException;
78  
79      DirectoryPurgeConfiguration getDirectoryPurgeConfiguration( int dirPurgeId )
80          throws PurgeConfigurationServiceException;
81  
82      DirectoryPurgeConfiguration getDefaultPurgeConfigurationForDirectoryType( String directoryType );
83  
84      List<DirectoryPurgeConfiguration> getDirectoryPurgeConfigurationsBySchedule( int scheduleId );
85  
86      List<DirectoryPurgeConfiguration> getEnableDirectoryPurgeConfigurationsBySchedule( int scheduleId );
87  
88      List<DirectoryPurgeConfiguration> getDirectoryPurgeConfigurationsByLocation( String location );
89  
90      List<DirectoryPurgeConfiguration> getAllDirectoryPurgeConfigurations();
91  
92      List<AbstractPurgeConfiguration> getAllPurgeConfigurations();
93  
94      List<DistributedDirectoryPurgeConfiguration> getAllDistributedDirectoryPurgeConfigurations();
95  
96      DistributedDirectoryPurgeConfiguration getDistributedDirectoryPurgeConfiguration( int dirPurgeId )
97          throws PurgeConfigurationServiceException;
98  
99      DistributedDirectoryPurgeConfiguration addDistributedDirectoryPurgeConfiguration(
100         DistributedDirectoryPurgeConfiguration dirPurge )
101         throws PurgeConfigurationServiceException;
102 
103     void updateDistributedDirectoryPurgeConfiguration( DistributedDirectoryPurgeConfiguration dirPurge )
104         throws PurgeConfigurationServiceException;
105 
106     void removeDistributedDirectoryPurgeConfiguration( DistributedDirectoryPurgeConfiguration dirPurge )
107         throws PurgeConfigurationServiceException;
108 
109     AbstractPurgeConfiguration getPurgeConfiguration( int purgeConfigId );
110 
111     List<DistributedDirectoryPurgeConfiguration> getEnableDistributedDirectoryPurgeConfigurationsBySchedule(
112         int scheduleId );
113 
114     /**
115      * @param repositoryId
116      * @return
117      * @throws PurgeConfigurationServiceException
118      *
119      */
120     RepositoryManagedContent getManagedRepositoryContent( int repositoryId )
121         throws PurgeConfigurationServiceException;
122 }