001    package org.apache.archiva.rest.api.services;
002    
003    /*
004     * Licensed to the Apache Software Foundation (ASF) under one
005     * or more contributor license agreements.  See the NOTICE file
006     * distributed with this work for additional information
007     * regarding copyright ownership.  The ASF licenses this file
008     * to you under the Apache License, Version 2.0 (the
009     * "License"); you may not use this file except in compliance
010     * with the License.  You may obtain a copy of the License at
011     *
012     *   http://www.apache.org/licenses/LICENSE-2.0
013     *
014     * Unless required by applicable law or agreed to in writing,
015     * software distributed under the License is distributed on an
016     * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017     * KIND, either express or implied.  See the License for the
018     * specific language governing permissions and limitations
019     * under the License.
020     */
021    
022    import org.apache.archiva.redback.authorization.RedbackAuthorization;
023    
024    import javax.ws.rs.GET;
025    import javax.ws.rs.Path;
026    import javax.ws.rs.Produces;
027    import javax.ws.rs.core.MediaType;
028    
029    /**
030     * @author Olivier Lamy
031     * @since 1.4-M1
032     */
033    @Path( "/pingService/" )
034    public interface PingService
035    {
036    
037        /**
038         * ping service to monitor Archiva with a nice returned message :-)
039         *
040         * @return Yeah Baby It rocks!
041         */
042        @Path( "ping" )
043        @GET
044        @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
045        @RedbackAuthorization( noRestriction = true )
046        String ping();
047    
048        /**
049         * same as #ping but check authz
050         *
051         * @return
052         */
053        @Path( "pingWithAuthz" )
054        @GET
055        @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
056        @RedbackAuthorization( noRestriction = false, noPermission = true )
057        String pingWithAuthz();
058    
059    }