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.ArchivaRuntimeInfo;
  22 import org.codehaus.plexus.redback.authorization.RedbackAuthorization;
  23
  24 import javax.ws.rs.GET;
  25 import javax.ws.rs.Path;
  26 import javax.ws.rs.Produces;
  27 import javax.ws.rs.QueryParam;
  28 import javax.ws.rs.core.MediaType;
  29
  30 /**
  31  * contains some "free" services (i18n)
  32  *
  33  * @author Olivier Lamy
  34  * @since 1.4-M3
  35  */
  36 @Path( "/commonServices/" )
  37 public interface CommonServices
  38 {
  39     @Path( "getI18nResources" )
  40     @GET
  41     @Produces( { MediaType.TEXT_PLAIN } )
  42     @RedbackAuthorization( noRestriction = true )
  43     /**
  44      * will return properties available in org/apache/archiva/i18n/default.properties
  45      * load default (en) then override with locale used so at least en are returned if no
  46      * translation in the locale asked.
  47      */
  48     String getI18nResources( @QueryParam( "locale" ) String locale )
  49         throws ArchivaRestServiceException;
  50
  51     @Path( "getAllI18nResources" )
  52     @GET
  53     @Produces( { MediaType.TEXT_PLAIN } )
  54     @RedbackAuthorization( noRestriction = true )
  55     /**
  56      * will return properties available in org/apache/archiva/i18n/default.properties
  57      * load default (en) then override with locale used so at least en are returned if no
  58      * translation in the locale asked.
  59      * This method will add redback resources too. note Archva wins
  60      */
  61     String getAllI18nResources( @QueryParam( "locale" ) String locale )
  62         throws ArchivaRestServiceException;
  63
  64     @Path( "archivaRuntimeInfo" )
  65     @GET
  66     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
  67     @RedbackAuthorization( noRestriction = true )
  68     ArchivaRuntimeInfo archivaRuntimeInfo();
  69
  70
  71     @Path( "validateCronExpression" )
  72     @GET
  73     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
  74     @RedbackAuthorization( noRestriction = true )
  75     Boolean validateCronExpression( @QueryParam( "cronExpression" ) String cronExpression )
  76         throws ArchivaRestServiceException;
  77
  78 }