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