This project has retired. For details please refer to its Attic page.
PingService 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.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.core.MediaType;
28  
29  /**
30   * @author Olivier Lamy
31   * @since 1.4-M1
32   */
33  @Path( "/pingService/" )
34  public interface PingService
35  {
36  
37      /**
38       * ping service to monitor Archiva with a nice returned message :-)
39       *
40       * @return Yeah Baby It rocks!
41       */
42      @Path( "ping" )
43      @GET
44      @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
45      @RedbackAuthorization( noRestriction = true )
46      String ping();
47  
48      /**
49       * same as #ping but check authz
50       *
51       * @return
52       */
53      @Path( "pingWithAuthz" )
54      @GET
55      @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
56      @RedbackAuthorization( noRestriction = false, noPermission = true )
57      String pingWithAuthz();
58  
59  }