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.rest.api.model.FileType;
  22 import org.apache.archiva.rest.api.model.LegacyArtifactPath;
  23 import org.apache.archiva.security.common.ArchivaRoleConstants;
  24 import org.codehaus.plexus.redback.authorization.RedbackAuthorization;
  25
  26 import javax.ws.rs.Consumes;
  27 import javax.ws.rs.GET;
  28 import javax.ws.rs.POST;
  29 import javax.ws.rs.Path;
  30 import javax.ws.rs.Produces;
  31 import javax.ws.rs.QueryParam;
  32 import javax.ws.rs.core.MediaType;
  33 import java.util.List;
  34
  35 /**
  36  * @author Olivier Lamy
  37  * @since 1.4
  38  */
  39 @Path( "/archivaAdministrationService/" )
  40 public interface ArchivaAdministrationService
  41 {
  42     @Path( "getLegacyArtifactPaths" )
  43     @GET
  44     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
  45     @RedbackAuthorization( permission = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
  46     List<LegacyArtifactPath> getLegacyArtifactPaths()
  47         throws ArchivaRestServiceException;
  48
  49     @Path( "addLegacyArtifactPath" )
  50     @POST
  51     @Consumes( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
  52     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
  53     @RedbackAuthorization( permission = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
  54     void addLegacyArtifactPath( LegacyArtifactPath legacyArtifactPath )
  55         throws ArchivaRestServiceException;
  56
  57     @Path( "deleteLegacyArtifactPath" )
  58     @GET
  59     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
  60     @RedbackAuthorization( permission = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
  61     Boolean deleteLegacyArtifactPath( @QueryParam( "path" ) String path )
  62         throws ArchivaRestServiceException;
  63
  64     @Path( "addFileTypePattern" )
  65     @GET
  66     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
  67     @RedbackAuthorization( permission = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
  68     Boolean addFileTypePattern( @QueryParam( "fileTypeId" ) String fileTypeId, @QueryParam( "pattern" ) String pattern )
  69         throws ArchivaRestServiceException;
  70
  71     @Path( "removeFileTypePattern" )
  72     @GET
  73     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
  74     @RedbackAuthorization( permission = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
  75     Boolean removeFileTypePattern( @QueryParam( "fileTypeId" ) String fileTypeId,
  76                                    @QueryParam( "pattern" ) String pattern )
  77         throws ArchivaRestServiceException;
  78
  79     @Path( "getFileType" )
  80     @GET
  81     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
  82     @RedbackAuthorization( permission = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
  83     FileType getFileType( @QueryParam( "fileTypeId" ) String fileTypeId )
  84         throws ArchivaRestServiceException;
  85
  86     @Path( "addFileType" )
  87     @POST
  88     @Consumes( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
  89     @RedbackAuthorization( permission = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
  90     void addFileType( FileType fileType )
  91         throws ArchivaRestServiceException;
  92
  93     @Path( "removeFileType" )
  94     @GET
  95     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
  96     @RedbackAuthorization( permission = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
  97     Boolean removeFileType( @QueryParam( "fileTypeId" ) String fileTypeId )
  98         throws ArchivaRestServiceException;
  99
 100     @Path( "addKnownContentConsumer" )
 101     @GET
 102     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
 103     @RedbackAuthorization( permission = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
 104     Boolean addKnownContentConsumer( @QueryParam( "knownContentConsumer" ) String knownContentConsumer )
 105         throws ArchivaRestServiceException;
 106
 107     @Path( "setKnownContentConsumers" )
 108     @POST
 109     @Consumes( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
 110     @RedbackAuthorization( permission = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
 111     void setKnownContentConsumers( List<String> knownContentConsumers )
 112         throws ArchivaRestServiceException;
 113
 114
 115     @Path( "removeKnownContentConsumer" )
 116     @GET
 117     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
 118     @RedbackAuthorization( permission = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
 119     Boolean removeKnownContentConsumer( @QueryParam( "knownContentConsumer" ) String knownContentConsumer )
 120         throws ArchivaRestServiceException;
 121
 122     @Path( "addInvalidContentConsumer" )
 123     @GET
 124     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
 125     @RedbackAuthorization( permission = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
 126     Boolean addInvalidContentConsumer( @QueryParam( "invalidContentConsumer" ) String invalidContentConsumer )
 127         throws ArchivaRestServiceException;
 128
 129     @Path( "setInvalidContentConsumers" )
 130     @POST
 131     @Consumes( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
 132     @RedbackAuthorization( permission = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
 133     void setInvalidContentConsumers( List<String> invalidContentConsumers )
 134         throws ArchivaRestServiceException;
 135
 136     @Path( "removeInvalidContentConsumer" )
 137     @GET
 138     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
 139     @RedbackAuthorization( permission = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
 140     Boolean removeInvalidContentConsumer( @QueryParam( "invalidContentConsumer" ) String invalidContentConsumer )
 141         throws ArchivaRestServiceException;
 142
 143     @Path( "getFileTypes" )
 144     @GET
 145     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
 146     @RedbackAuthorization( permission = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
 147     List<FileType> getFileTypes()
 148         throws ArchivaRestServiceException;
 149
 150     @Path( "getKnownContentConsumers" )
 151     @GET
 152     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
 153     @RedbackAuthorization( permission = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
 154     List<String> getKnownContentConsumers()
 155         throws ArchivaRestServiceException;
 156
 157     @Path( "getInvalidContentConsumers" )
 158     @GET
 159     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
 160     @RedbackAuthorization( permission = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
 161     List<String> getInvalidContentConsumers()
 162         throws ArchivaRestServiceException;
 163 }