| package org.apache.archiva.web.xmlrpc.api; |
| |
| /* |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| */ |
| |
| import com.atlassian.xmlrpc.ServiceObject; |
| import org.apache.archiva.admin.model.RepositoryAdminException; |
| import org.apache.archiva.web.xmlrpc.api.beans.ManagedRepository; |
| import org.apache.archiva.web.xmlrpc.api.beans.RemoteRepository; |
| |
| import java.util.List; |
| |
| @ServiceObject( "AdministrationService" ) |
| public interface AdministrationService |
| { |
| /** |
| * Executes repository scanner on the given repository. |
| * |
| * @param repoId id of the repository to be scanned |
| * @return |
| * @throws Exception |
| */ |
| Boolean executeRepositoryScanner( String repoId ) |
| throws Exception; |
| |
| /** |
| * Gets all available repository consumers. |
| * |
| * @return |
| */ |
| List<String> getAllRepositoryConsumers(); |
| |
| // TODO should we already implement config of consumers per repository? |
| |
| /** |
| * Configures (enable or disable) repository consumer. |
| * |
| * @param repoId |
| * @param consumerId |
| * @param enable |
| * @return |
| * @throws Exception |
| */ |
| Boolean configureRepositoryConsumer( String repoId, String consumerId, boolean enable ) |
| throws Exception; |
| |
| /** |
| * Gets all managed repositories. |
| * |
| * @return |
| */ |
| List<ManagedRepository> getAllManagedRepositories() |
| throws RepositoryAdminException; |
| |
| /** |
| * Gets all remote repositories. |
| * |
| * @return |
| */ |
| List<RemoteRepository> getAllRemoteRepositories() |
| throws RepositoryAdminException; |
| |
| /** |
| * Deletes given artifact from the specified repository. |
| * |
| * @param repoId id of the repository where the artifact to be deleted resides |
| * @param groupId groupId of the artifact to be deleted |
| * @param artifactId artifactId of the artifact to be deleted |
| * @param version version of the artifact to be deleted |
| * @return |
| * @throws Exception |
| */ |
| Boolean deleteArtifact( String repoId, String groupId, String artifactId, String version ) |
| throws Exception; |
| |
| /** |
| * Create a new managed repository with the given parameters. |
| * |
| * @param repoId |
| * @param layout |
| * @param name |
| * @param location |
| * @param blockRedeployments |
| * @param releasesIncluded |
| * @param snapshotsIncluded |
| * @param cronExpression |
| * @return |
| * @throws Exception |
| */ |
| Boolean addManagedRepository( String repoId, String layout, String name, String location, |
| boolean blockRedeployments, boolean releasesIncluded, boolean snapshotsIncluded, |
| boolean stageRepoNeeded, String cronExpression, int daysOlder, int retentionCount, |
| boolean deleteReleasedSnapshots ) |
| throws Exception; |
| |
| /** |
| * Deletes a managed repository with the given repository id. |
| * |
| * @param repoId |
| * @return |
| */ |
| Boolean deleteManagedRepository( String repoId ) |
| throws Exception; |
| |
| /** |
| * Deletes a managed repository content with the given repository id |
| * |
| * @param repoId |
| * @return |
| * @throws Exception |
| */ |
| Boolean deleteManagedRepositoryContent( String repoId ) |
| throws Exception; |
| |
| /** |
| * Get a managed repository with the given repository id. |
| * |
| * @param repoId |
| * @return |
| * @throws Exception |
| */ |
| ManagedRepository getManagedRepository( String repoId ) |
| throws Exception; |
| // TODO |
| // consider the following as additional services: |
| // - getAllConfiguredRepositoryConsumers( String repoId ) - list all enabled consumers for the repo |
| // - getAllConfiguredDatabaseConsumers() - list all enabled db consumers |
| |
| /** |
| * Merge staging repository with the managed repository and skips if there are conflicts |
| * |
| * @param repoId |
| * @param skipConflicts |
| * @return |
| * @throws Exception |
| */ |
| boolean merge( String repoId, boolean skipConflicts ) |
| throws Exception; |
| |
| } |