This project has retired. For details please refer to its Attic page.
ManagedRepositoriesService xref
View Javadoc
1   package org.apache.archiva.rest.api.services;
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.archiva.admin.model.beans.ManagedRepository;
23  import org.apache.archiva.rest.api.model.ArchivaRepositoryStatistics;
24  import org.apache.archiva.security.common.ArchivaRoleConstants;
25  import org.apache.archiva.redback.authorization.RedbackAuthorization;
26  
27  import javax.ws.rs.Consumes;
28  import javax.ws.rs.GET;
29  import javax.ws.rs.POST;
30  import javax.ws.rs.Path;
31  import javax.ws.rs.PathParam;
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-M1
40   */
41  @Path( "/managedRepositoriesService/" )
42  public interface ManagedRepositoriesService
43  {
44      @Path( "getManagedRepositories" )
45      @GET
46      @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
47      @RedbackAuthorization( permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
48      List<ManagedRepository> getManagedRepositories()
49          throws ArchivaRestServiceException;
50  
51      @Path( "getManagedRepository/{repositoryId}" )
52      @GET
53      @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
54      @RedbackAuthorization( permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
55      ManagedRepository getManagedRepository( @PathParam( "repositoryId" ) String repositoryId )
56          throws ArchivaRestServiceException;
57  
58      @Path( "deleteManagedRepository" )
59      @GET
60      @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
61      @RedbackAuthorization( permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
62      Boolean deleteManagedRepository( @QueryParam( "repositoryId" ) String repositoryId,
63                                       @QueryParam( "deleteContent" ) boolean deleteContent )
64          throws ArchivaRestServiceException;
65  
66  
67      @Path( "addManagedRepository" )
68      @POST
69      @Consumes( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
70      @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
71      @RedbackAuthorization( permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
72      ManagedRepository addManagedRepository( ManagedRepository managedRepository )
73          throws ArchivaRestServiceException;
74  
75  
76      @Path( "updateManagedRepository" )
77      @POST
78      @Consumes( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
79      @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
80      @RedbackAuthorization( permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
81      Boolean updateManagedRepository( ManagedRepository managedRepository )
82          throws ArchivaRestServiceException;
83  
84      /**
85       * @since 1.4-M3
86       */
87      @Path( "fileLocationExists" )
88      @GET
89      @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
90      @RedbackAuthorization( permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
91      Boolean fileLocationExists( @QueryParam( "fileLocation" ) String fileLocation )
92          throws ArchivaRestServiceException;
93  
94      /**
95       * @since 1.4-M3
96       */
97      @Path( "getManagedRepositoryStatistics/{repositoryId}/{lang}" )
98      @GET
99      @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
100     @RedbackAuthorization( permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
101     ArchivaRepositoryStatistics getManagedRepositoryStatistics( @PathParam( "repositoryId" ) String repositoryId,
102                                                                 @PathParam( "lang" ) String lang )
103         throws ArchivaRestServiceException;
104 
105     /**
106      * return a pom snippet to use this repository with entities escaped (&lt; &gt;)
107      * @since 1.4-M3
108      */
109     @Path( "getPomSnippet/{repositoryId}" )
110     @GET
111     @Produces( { MediaType.TEXT_PLAIN } )
112     @RedbackAuthorization( permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
113     String getPomSnippet( @PathParam( "repositoryId" ) String repositoryId )
114         throws ArchivaRestServiceException;
115 
116 
117 }