/
Memo.java
102 lines (95 loc) · 3.36 KB
/
Memo.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
/**
* Copyright (c) 2014-2015, Thindeck.com
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met: 1) Redistributions of source code must retain the above
* copyright notice, this list of conditions and the following
* disclaimer. 2) Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials provided
* with the distribution. 3) Neither the name of the thindeck.com nor
* the names of its contributors may be used to endorse or promote
* products derived from this software without specific prior written
* permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
* NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
* FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
* THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
* OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package com.thindeck.api;
import com.jcabi.aspects.Immutable;
import com.jcabi.xml.XML;
import com.jcabi.xml.XSD;
import com.jcabi.xml.XSDDocument;
import com.jcabi.xml.XSL;
import com.jcabi.xml.XSLDocument;
import java.io.IOException;
import javax.validation.constraints.NotNull;
import org.xembly.Directive;
/**
* Memo of a {@link Repo}.
*
* <p>Memo is an XML document with data about the current
* state of the repository. A memo can contain, for example, the
* list of Docker containers that are running the repo at
* the moment.
*
* <p>Full description of what information a memo should (and can)
* include you can get from its XSD schema.
*
* <p>Memo should not guarantee any thread-safety. It is assumed
* that the client calls {@link #read()} and {@link #update(Iterable)}
* methods consequently. If two threads will update in parallel,
* the result may be unpredictable.
*
* @author Yegor Bugayenko (yegor@tpc2.com)
* @version $Id$
* @since 0.1
*/
@Immutable
public interface Memo {
/**
* Schema.
*/
XSD SCHEMA = XSDDocument.make(
Memo.class.getResourceAsStream("memo.xsd")
);
/**
* Clean-up XSL.
*/
XSL CLEANUP = XSLDocument.make(
Memo.class.getResourceAsStream("memo-cleanup.xsl")
);
/**
* Read XML.
*
* <p>The method must guarantee that the XML document it
* returns complies to the XSD schema.
*
* @return XML
* @throws IOException If fails
*/
@NotNull(message = "XML can't be null")
XML read() throws IOException;
/**
* Update.
*
* <p>The method must throw a runtime exception if,
* after applying the changes to the XML, it violates the XSD schema.
*
* @param dirs Directives
* @throws IOException If fails
*/
void update(Iterable<Directive> dirs) throws IOException;
}