package org.apache.archiva.rest.api.services;
   
   /*
    * Licensed to the Apache Software Foundation (ASF) under one
    * or more contributor license agreements.  See the NOTICE file
    * distributed with this work for additional information
    * regarding copyright ownership.  The ASF licenses this file
    * to you under the Apache License, Version 2.0 (the
    * "License"); you may not use this file except in compliance
   * with the License.  You may obtain a copy of the License at
   *
   *   http://www.apache.org/licenses/LICENSE-2.0
   *
   * Unless required by applicable law or agreed to in writing,
   * software distributed under the License is distributed on an
   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
   * KIND, either express or implied.  See the License for the
   * specific language governing permissions and limitations
   * under the License.
   */
  
  import org.apache.archiva.redback.authorization.RedbackAuthorization;
  
  import javax.ws.rs.GET;
  import javax.ws.rs.Path;
  import javax.ws.rs.Produces;
  import javax.ws.rs.core.MediaType;
  
  /**
   * @author Olivier Lamy
   * @since 1.4-M1
   */
  @Path( "/pingService/" )
  public interface PingService
  {
  
      /**
       * ping service to monitor Archiva with a nice returned message :-)
       *
       * @return Yeah Baby It rocks!
       */
      @Path( "ping" )
      @GET
      @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
      @RedbackAuthorization( noRestriction = true )
      String ping();
  
      /**
       * same as #ping but check authz
       *
       * @return
       */
      @Path( "pingWithAuthz" )
      @GET
      @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
      @RedbackAuthorization( noRestriction = false, noPermission = true )
      String pingWithAuthz();
  
  }