1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.maven.report.projectinfo.avatars;
20
21 import java.io.File;
22 import java.io.IOException;
23
24 /**
25 * Avatar provider API.
26 */
27 public interface AvatarsProvider {
28
29 /**
30 * Set a base URL for provider
31 *
32 * @param baseUrl for provider
33 */
34 void setBaseUrl(String baseUrl);
35
36 /**
37 * Set site output directory. Used to store avatar images in project.
38 *
39 * @param outputDirectory a site output directory
40 */
41 void setOutputDirectory(File outputDirectory);
42
43 /**
44 * Return a URL for avatar image.
45 *
46 * @param email email address for gravatar image
47 * @return a URL for avatar image
48 */
49 String getAvatarUrl(String email);
50
51 /**
52 * Return a local path to downloaded avatar image.
53 *
54 * @param email email address for gravatar image
55 * @return a local avatar path
56 * @throws IOException if problem with image downloading
57 */
58 String getLocalAvatarPath(String email) throws IOException;
59 }