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

   1 package org.apache.archiva.rest.api.services;
   2 /*
   3  * Licensed to the Apache Software Foundation (ASF) under one
   4  * or more contributor license agreements.  See the NOTICE file
   5  * distributed with this work for additional information
   6  * regarding copyright ownership.  The ASF licenses this file
   7  * to you under the Apache License, Version 2.0 (the
   8  * "License"); you may not use this file except in compliance
   9  * with the License.  You may obtain a copy of the License at
  10  *
  11  *   http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing,
  14  * software distributed under the License is distributed on an
  15  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  16  * KIND, either express or implied.  See the License for the
  17  * specific language governing permissions and limitations
  18  * under the License.
  19  */
  20
  21 import org.apache.archiva.admin.repository.RepositoryAdminException;
  22 import org.apache.archiva.rest.api.model.FileType;
  23 import org.apache.archiva.rest.api.model.LegacyArtifactPath;
  24 import org.apache.archiva.rest.api.model.RepositoryScanning;
  25 import org.apache.archiva.security.common.ArchivaRoleConstants;
  26 import org.codehaus.plexus.redback.authorization.RedbackAuthorization;
  27
  28 import javax.ws.rs.Consumes;
  29 import javax.ws.rs.GET;
  30 import javax.ws.rs.POST;
  31 import javax.ws.rs.Path;
  32 import javax.ws.rs.Produces;
  33 import javax.ws.rs.QueryParam;
  34 import javax.ws.rs.core.MediaType;
  35 import java.util.List;
  36
  37 /**
  38  * @author Olivier Lamy
  39  * @since 1.4
  40  */
  41 @Path( "/archivaAdministrationService/" )
  42 public interface ArchivaAdministrationService
  43 {
  44     @Path( "getLegacyArtifactPaths" )
  45     @GET
  46     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
  47     @RedbackAuthorization( permission = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
  48     List<LegacyArtifactPath> getLegacyArtifactPaths()
  49         throws RepositoryAdminException;
  50
  51     @Path( "addLegacyArtifactPath" )
  52     @POST
  53     @Consumes( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
  54     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
  55     @RedbackAuthorization( permission = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
  56     void addLegacyArtifactPath( LegacyArtifactPath legacyArtifactPath )
  57         throws RepositoryAdminException;
  58
  59     @Path( "deleteLegacyArtifactPath" )
  60     @GET
  61     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
  62     @RedbackAuthorization( permission = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
  63     Boolean deleteLegacyArtifactPath( @QueryParam( "path" ) String path )
  64         throws RepositoryAdminException;
  65
  66     @Path( "getRepositoryScanning" )
  67     @GET
  68     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
  69     @RedbackAuthorization( permission = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
  70     RepositoryScanning getRepositoryScanning()
  71         throws RepositoryAdminException;
  72
  73     @Path( "updateRepositoryScanning" )
  74     @POST
  75     @Consumes( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
  76     @RedbackAuthorization( permission = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
  77     void updateRepositoryScanning( RepositoryScanning repositoryScanning )
  78         throws RepositoryAdminException;
  79
  80     @Path( "addFileTypePattern" )
  81     @GET
  82     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
  83     @RedbackAuthorization( permission = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
  84     Boolean addFileTypePattern( @QueryParam( "fileTypeId" ) String fileTypeId, @QueryParam( "pattern" ) String pattern )
  85         throws RepositoryAdminException;
  86
  87     @Path( "removeFileTypePattern" )
  88     @GET
  89     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
  90     @RedbackAuthorization( permission = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
  91     Boolean removeFileTypePattern( @QueryParam( "fileTypeId" ) String fileTypeId,
  92                                    @QueryParam( "pattern" ) String pattern )
  93         throws RepositoryAdminException;
  94
  95     @Path( "getFileType" )
  96     @GET
  97     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
  98     @RedbackAuthorization( permission = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
  99     FileType getFileType( String fileTypeId )
 100         throws RepositoryAdminException;
 101
 102     @Path( "addFileType" )
 103     @POST
 104     @Consumes( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
 105     @RedbackAuthorization( permission = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
 106     void addFileType( FileType fileType )
 107         throws RepositoryAdminException;
 108
 109     @Path( "removeFileType" )
 110     @GET
 111     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
 112     @RedbackAuthorization( permission = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
 113     Boolean removeFileType( @QueryParam( "fileTypeId" ) String fileTypeId )
 114         throws RepositoryAdminException;
 115
 116     @Path( "addKnownContentConsumer" )
 117     @GET
 118     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
 119     @RedbackAuthorization( permission = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
 120     Boolean addKnownContentConsumer( @QueryParam( "knownContentConsumer" ) String knownContentConsumer )
 121         throws RepositoryAdminException;
 122
 123     @Path( "setKnownContentConsumers" )
 124     @POST
 125     @Consumes( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
 126     @RedbackAuthorization( permission = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
 127     void setKnownContentConsumers( List<String> knownContentConsumers )
 128         throws RepositoryAdminException;
 129
 130
 131     @Path( "removeKnownContentConsumer" )
 132     @GET
 133     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
 134     @RedbackAuthorization( permission = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
 135     Boolean removeKnownContentConsumer( @QueryParam( "knownContentConsumer" )  String knownContentConsumer )
 136         throws RepositoryAdminException;
 137
 138     @Path( "addInvalidContentConsumer" )
 139     @GET
 140     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
 141     @RedbackAuthorization( permission = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
 142     Boolean addInvalidContentConsumer(@QueryParam( "invalidContentConsumer" ) String invalidContentConsumer )
 143         throws RepositoryAdminException;
 144
 145     @Path( "setInvalidContentConsumers" )
 146     @POST
 147     @Consumes( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
 148     @RedbackAuthorization( permission = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
 149     void setInvalidContentConsumers( List<String> invalidContentConsumers )
 150         throws RepositoryAdminException;
 151
 152     @Path( "removeInvalidContentConsumer" )
 153     @GET
 154     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
 155     @RedbackAuthorization( permission = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
 156     Boolean removeInvalidContentConsumer(@QueryParam( "invalidContentConsumer" )  String invalidContentConsumer )
 157         throws RepositoryAdminException;
 158 }