1 /**
2 * Copyright (c) 2013-2023, jcabi.com
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met: 1) Redistributions of source code must retain the above
8 * copyright notice, this list of conditions and the following
9 * disclaimer. 2) Redistributions in binary form must reproduce the above
10 * copyright notice, this list of conditions and the following
11 * disclaimer in the documentation and/or other materials provided
12 * with the distribution. 3) Neither the name of the jcabi.com nor
13 * the names of its contributors may be used to endorse or promote
14 * products derived from this software without specific prior written
15 * permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
19 * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
20 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
21 * THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
22 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
24 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
26 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
28 * OF THE POSSIBILITY OF SUCH DAMAGE.
29 */
30 package com.jcabi.github;
31
32 import com.jcabi.aspects.Immutable;
33 import java.io.IOException;
34 import java.util.Map;
35
36 /**
37 * Github hooks.
38 *
39 * @author Paul Polishchuk (ppol@ua.fm)
40 * @version $Id: 1467e1e5f8481b614ca703bf68b17b13d39b6fbb $
41 * @since 0.8
42 * @see <a href="https://developer.github.com/v3/repos/hooks/">Hooks API</a>
43 */
44 @Immutable
45 public interface Hooks {
46
47 /**
48 * Owner of them.
49 * @return Repo
50 */
51 Repo repo();
52
53 /**
54 * Iterate them all.
55 * @return Iterator of hooks
56 * @see <a href="https://developer.github.com/v3/repos/hooks/#list">List</a>
57 */
58 Iterable<Hook> iterate();
59
60 /**
61 * Remove hook by ID.
62 * @param number ID of the label to remove
63 * @throws IOException If there is any I/O problem
64 * @see <a href="https://developer.github.com/v3/repos/hooks/#delete-a-hook">List</a>
65 */
66 void remove(int number) throws IOException;
67
68 /**
69 * Get specific hook by number.
70 * @param number Hook number
71 * @return Hook
72 * @see <a href="https://developer.github.com/v3/repos/hooks/#get-single-hook">Get single hook</a>
73 */
74 Hook get(int number);
75
76 /**
77 * Create new hook.
78 * @param name Hook name
79 * @param config Configuration for the hook
80 * @param events Events that trigger the hook
81 * @param active Actually trigger the hook when the events occur?
82 * @return Hook
83 * @throws IOException If there is any I/O problem
84 * @see <a href="https://developer.github.com/v3/repos/hooks/#create-a-hook">Create a hook</a>
85 * @checkstyle ParameterNumberCheck (2 lines)
86 */
87 Hook create(
88 String name, Map<String, String> config,
89 Iterable<Event> events, boolean active
90 ) throws IOException;
91 }