1 /*
2 * The MIT License (MIT)
3 *
4 * Copyright (c) 2013-2026 The Coveralls Maven Plugin Project Contributors:
5 * https://github.com/hazendaz/coveralls-maven-plugin/graphs/contributors
6 *
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
8 * of this software and associated documentation files (the "Software"), to deal
9 * in the Software without restriction, including without limitation the rights
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
13 *
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
16 *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23 * THE SOFTWARE.
24 */
25 package org.eluder.coveralls.maven.plugin.service;
26
27 import java.util.Properties;
28
29 /**
30 * Service specific mojo properties.
31 */
32 public interface ServiceSetup {
33
34 /**
35 * Checks if is selected.
36 *
37 * @return <code>true</code> if this service is selected, otherwise <code>false</code>
38 */
39 boolean isSelected();
40
41 /**
42 * Gets the name.
43 *
44 * @return service name
45 */
46 String getName();
47
48 /**
49 * Gets the job id.
50 *
51 * @return service job id, or <code>null</code> if not defined
52 */
53 String getJobId();
54
55 /**
56 * Gets the builds the number.
57 *
58 * @return service build number, or <code>null</code> if not defined
59 */
60 String getBuildNumber();
61
62 /**
63 * Gets the builds the url.
64 *
65 * @return service build url, or <code>null</code> if not defined
66 */
67 String getBuildUrl();
68
69 /**
70 * Gets the branch.
71 *
72 * @return git branch name, or <code>null</code> if not defined
73 */
74 String getBranch();
75
76 /**
77 * Gets the pull request.
78 *
79 * @return pull request identifier, or <code>null</code> if not defined
80 */
81 String getPullRequest();
82
83 /**
84 * Gets the environment.
85 *
86 * @return environment related to service, or <code>null</code> if not defined
87 */
88 Properties getEnvironment();
89
90 }