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.CacheEntry;
  22 import org.apache.archiva.rest.api.model.QueueEntry;
  23 import org.apache.archiva.rest.api.model.RepositoryScannerStatistics;
  24 import org.apache.archiva.security.common.ArchivaRoleConstants;
  25 import org.codehaus.plexus.redback.authorization.RedbackAuthorization;
  26
  27 import javax.ws.rs.GET;
  28 import javax.ws.rs.Path;
  29 import javax.ws.rs.PathParam;
  30 import javax.ws.rs.Produces;
  31 import javax.ws.rs.core.MediaType;
  32 import java.util.List;
  33
  34 /**
  35  * @author Olivier Lamy
  36  * @since 1.4-M3
  37  */
  38 @Path( "/systemStatusService/" )
  39 public interface SystemStatusService
  40 {
  41     @Path( "memoryStatus" )
  42     @GET
  43     @Produces( MediaType.TEXT_PLAIN )
  44     @RedbackAuthorization( permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
  45     String getMemoryStatus()
  46         throws ArchivaRestServiceException;
  47
  48     @Path( "currentServerTime/{locale}" )
  49     @GET
  50     @Produces( MediaType.TEXT_PLAIN )
  51     @RedbackAuthorization( permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
  52     String getCurrentServerTime( @PathParam( "locale" ) String locale )
  53         throws ArchivaRestServiceException;
  54
  55     @Path( "queueEntries" )
  56     @GET
  57     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
  58     @RedbackAuthorization( permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
  59     List<QueueEntry> getQueueEntries()
  60         throws ArchivaRestServiceException;
  61
  62     @Path( "cacheEntries" )
  63     @GET
  64     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
  65     @RedbackAuthorization( permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
  66     List<CacheEntry> getCacheEntries()
  67         throws ArchivaRestServiceException;
  68
  69     @Path( "clearCache/{key}" )
  70     @GET
  71     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
  72     @RedbackAuthorization( permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
  73     Boolean clearCache( @PathParam( "key" ) String cacheKey )
  74         throws ArchivaRestServiceException;
  75
  76     @Path( "clearAllCaches" )
  77     @GET
  78     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
  79     @RedbackAuthorization( permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
  80     Boolean clearAllCaches()
  81         throws ArchivaRestServiceException;
  82
  83
  84     @Path( "repositoryScannerStatistics" )
  85     @GET
  86     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
  87     @RedbackAuthorization( permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
  88     List<RepositoryScannerStatistics> getRepositoryScannerStatistics()
  89         throws ArchivaRestServiceException;
  90
  91 }