source.dussan.org Git - archiva.git/blob

   1 package org.apache.archiva.web.xmlrpc.api;
   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 java.util.List;
  23
  24 import com.atlassian.xmlrpc.ServiceObject;
  25 import org.apache.archiva.web.xmlrpc.api.beans.ManagedRepository;
  26 import org.apache.archiva.web.xmlrpc.api.beans.RemoteRepository;
  27 import org.apache.maven.archiva.configuration.ManagedRepositoryConfiguration;
  28
  29 @ServiceObject( "AdministrationService" )
  30 public interface AdministrationService
  31 {
  32     /**
  33      * Executes repository scanner on the given repository.
  34      *
  35      * @param repoId id of the repository to be scanned
  36      * @return
  37      * @throws Exception
  38      */
  39     public Boolean executeRepositoryScanner( String repoId )
  40         throws Exception;
  41
  42     /**
  43      * Gets all available repository consumers.
  44      *
  45      * @return
  46      */
  47     public List<String> getAllRepositoryConsumers();
  48
  49     // TODO should we already implement config of consumers per repository?
  50     /**
  51      * Configures (enable or disable) repository consumer.
  52      *
  53      * @param repoId
  54      * @param consumerId
  55      * @param enable
  56      * @return
  57      * @throws Exception
  58      */
  59     public Boolean configureRepositoryConsumer( String repoId, String consumerId, boolean enable )
  60         throws Exception;
  61
  62     /**
  63      * Gets all managed repositories.
  64      *
  65      * @return
  66      */
  67     public List<ManagedRepository> getAllManagedRepositories();
  68
  69     /**
  70      * Gets all remote repositories.
  71      *
  72      * @return
  73      */
  74     public List<RemoteRepository> getAllRemoteRepositories();
  75
  76     /**
  77      * Deletes given artifact from the specified repository.
  78      *
  79      * @param repoId id of the repository where the artifact to be deleted resides
  80      * @param groupId groupId of the artifact to be deleted
  81      * @param artifactId artifactId of the artifact to be deleted
  82      * @param version version of the artifact to be deleted
  83      * @return
  84      * @throws Exception
  85      */
  86     public Boolean deleteArtifact( String repoId, String groupId, String artifactId, String version )
  87         throws Exception;
  88
  89     /**
  90      * Create a new managed repository with the given parameters.
  91      *
  92      * @param repoId
  93      * @param layout
  94      * @param name
  95      * @param location
  96      * @param blockRedeployments
  97      * @param releasesIncluded
  98      * @param snapshotsIncluded
  99      * @param cronExpression
 100      * @return
 101      * @throws Exception
 102      */
 103     public Boolean addManagedRepository( String repoId, String layout, String name, String location,
 104                                          boolean blockRedeployments, boolean releasesIncluded,
 105                                          boolean snapshotsIncluded, String cronExpression )
 106         throws Exception;
 107
 108     /**
 109      * Deletes a managed repository with the given repository id.
 110      *
 111      * @param repoId
 112      * @return
 113      */
 114     public Boolean deleteManagedRepository( String repoId )
 115         throws Exception;
 116
 117     /**
 118      * Get a managed repository with the given repository id.
 119      * @param repoId
 120      * @return
 121      * @throws Exception
 122      */
 123     public ManagedRepository getManagedRepository(String repoId) throws Exception;
 124     // TODO
 125     // consider the following as additional services:
 126     // - getAllConfiguredRepositoryConsumers( String repoId ) - list all enabled consumers for the repo
 127     // - getAllConfiguredDatabaseConsumers() - list all enabled db consumers
 128 }