View Javadoc
1   /*
2    * This file is part of dependency-check-core.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *     http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   *
16   * Copyright (c) 2023 Jeremy Long. All Rights Reserved.
17   */
18  package org.owasp.dependencycheck.data.nexus;
19  
20  import java.io.IOException;
21  
22  public interface NexusSearch {
23      /**
24       * Searches the configured Nexus repository for the given sha1 hash. If the
25       * artifact is found, a <code>MavenArtifact</code> is populated with the
26       * coordinate information.
27       *
28       * @param sha1 The SHA-1 hash string for which to search
29       * @return the populated Maven coordinates
30       * @throws IOException if it's unable to connect to the specified repository
31       *                     or if the specified artifact is not found.
32       */
33      MavenArtifact searchSha1(String sha1) throws IOException;
34  
35      /**
36       * Do a preflight request to see if the repository is actually working.
37       *
38       * @return whether the repository is listening and returns the expected status response
39       */
40      boolean preflightRequest();
41  }