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.maven2.model.Artifact;
  import org.apache.archiva.redback.authorization.RedbackAuthorization;
  import org.apache.archiva.rest.api.model.ChecksumSearch;
  import org.apache.archiva.rest.api.model.GroupIdList;
  import org.apache.archiva.rest.api.model.SearchRequest;
  import org.apache.archiva.rest.api.model.StringList;
  
  import javax.ws.rs.DefaultValue;
  import javax.ws.rs.GET;
  import javax.ws.rs.POST;
  import javax.ws.rs.Path;
  import javax.ws.rs.Produces;
  import javax.ws.rs.QueryParam;
  import javax.ws.rs.core.MediaType;
  import javax.ws.rs.core.Response;
  import java.util.List;
  
  @Path( "/searchService/" )
  public interface SearchService
  {
      /*
      * quick/general text search which returns a list of artifacts
      * query for an artifact based on a checksum
      * query for all available versions of an artifact, sorted in version significance order
      * query for an artifact's direct dependencies
      * <b>search will be apply on all repositories the current user has karma</b>
      * TODO query for an artifact's dependency tree (as with mvn dependency:tree - no duplicates should be included)
      * TODO query for all artifacts that depend on a given artifact
      */
      @Path( "quickSearch" )
      @GET
      @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
      @RedbackAuthorization( noPermission = true, noRestriction = true )
      List<Artifact> quickSearch( @QueryParam( "queryString" ) String queryString )
          throws ArchivaRestServiceException;
  
      /**
       * <b>if not repositories in SearchRequest: search will be apply on all repositories the current user has karma</b>
       */
      @Path( "quickSearchWithRepositories" )
      @POST
      @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
      @RedbackAuthorization( noPermission = true, noRestriction = true )
      List<Artifact> quickSearchWithRepositories( SearchRequest searchRequest )
          throws ArchivaRestServiceException;
  
      /**
       * If searchRequest contains repositories, the search will be done only on those repositories.
       * <b>if no repositories, the search will be apply on all repositories the current user has karma</b>
       */
      @Path( "searchArtifacts" )
      @POST
      @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
      @RedbackAuthorization( noPermission = true, noRestriction = true )
      List<Artifact> searchArtifacts( SearchRequest searchRequest )
          throws ArchivaRestServiceException;
  
      /**
       * <b>search will be apply on all repositories the current user has karma</b>
       */
      @Path( "getArtifactVersions" )
      @GET
      @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
      @RedbackAuthorization( noPermission = true, noRestriction = true )
      List<Artifact> getArtifactVersions( @QueryParam( "groupId" ) String groupId, //
                                          @QueryParam( "artifactId" ) String artifactId, //
                                          @QueryParam( "packaging" ) String packaging )
          throws ArchivaRestServiceException;
  
  
      /**
       * <b>this method applies on Maven Indexer lucene index, so datas not yet indexed won't be available</b>
       */
      @Path( "getAllGroupIds" )
      @GET
      @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
      @RedbackAuthorization( noPermission = true, noRestriction = false )
     GroupIdList getAllGroupIds( @QueryParam( "selectedRepos" ) List<String> selectedRepos )
         throws ArchivaRestServiceException;
 
     /**
      * @since 1.4-M3
      */
     @Path( "observableRepoIds" )
     @GET
     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
     @RedbackAuthorization( noPermission = true, noRestriction = true )
     StringList getObservablesRepoIds()
         throws ArchivaRestServiceException;
 
     /*
     @Path( "getDependencies" )
     @GET
     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
     @RedbackAuthorization( noPermission = true, noRestriction = true )
     List<Dependency> getDependencies( @QueryParam( "groupId" ) String groupId,
                                       @QueryParam( "artifactId" ) String artifactId,
                                       @QueryParam( "version" ) String version )
         throws ArchivaRestServiceException;
     */
 
     /**
      * Returns a redirect to a artifact file, that matches given search parameter
      * @param repositoryId The repository id (optional)
      * @param groupId The search pattern for the group id of the artifact (required)
      * @param artifactId  The search pattern for the artifact id of the artifact (required)
      * @param version The search pattern for the version of the artifact (required)
      *                LATEST returns the latest version of the artifact.
      * @param packaging the packaging
      * @param classifier the artifact classifier
      * @param literalVersion true, if the version string should be treated literally, which means
      *                       LATEST search for versions with LATEST in the version string.
      *                       false, is default and treats v=LATEST special
      * @return the redirect response, if a artifact was found
      * @throws ArchivaRestServiceException
      */
     @GET
     @Path( "/artifact" )
     @Produces( "text/html" )
     @RedbackAuthorization( noPermission = true, noRestriction = true )
     Response redirectToArtifactFile( @QueryParam( "r" ) String repositoryId, //
                                      @QueryParam( "g" ) String groupId, //
                                      @QueryParam( "a" ) String artifactId, //
                                      @QueryParam( "v" ) String version, //
                                      @QueryParam( "p" ) String packaging, //
                                      @QueryParam( "c" ) String classifier,
                                      @DefaultValue( "false" )
                                      @QueryParam( "literalVersion" ) Boolean literalVersion)
         throws ArchivaRestServiceException;
 
 
     /**
      * If searchRequest contains repositories, the search will be done only on those repositories.
      * <b>if no repositories, the search will be apply on all repositories the current user has karma</b>
      */
     @Path( "artifactsByChecksum" )
     @POST
     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
     @RedbackAuthorization( noPermission = true, noRestriction = true )
     List<Artifact> getArtifactByChecksum( ChecksumSearch checksumSearch )
         throws ArchivaRestServiceException;
 
 
 }