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
35 /**
36 * Github deploy keys.
37 *
38 * @author Andres Candal (andres.candal@rollasolution.com)
39 * @version $Id: 1d54b545c30744dff2a44adad9eccdf9192db6bd $
40 * @since 0.8
41 * @see <a href="https://developer.github.com/v3/repos/keys/">Deploy Keys API</a>
42 */
43 @Immutable
44 public interface DeployKeys {
45
46 /**
47 * Owner of them.
48 * @return Repo
49 */
50 Repo repo();
51
52 /**
53 * Iterate them all.
54 * @return Iterator of deploy keys
55 * @see <a href="https://developer.github.com/v3/repos/keys/#list">List</a>
56 */
57 Iterable<DeployKey> iterate();
58
59 /**
60 * Get a single deploy key.
61 * @param number Id of a deploy key
62 * @return Deploy key
63 * @see <a href="https://developer.github.com/v3/repos/keys/#get">Get a deploy key</a>
64 */
65 DeployKey get(int number);
66
67 /**
68 * Create a deploy key.
69 * @param title Title
70 * @param key Key
71 * @return A new deploy key
72 * @throws IOException If there is any I/O problem
73 * @see <a href="https://developer.github.com/v3/repos/keys/#create">Add a new deploy key</a>
74 */
75 DeployKey create(String title, String key) throws IOException;
76
77 }