-
Notifications
You must be signed in to change notification settings - Fork 4.6k
/
BuildCacheService.java
68 lines (63 loc) · 2.82 KB
/
BuildCacheService.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
/*
* Copyright 2016 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.gradle.caching;
import java.io.Closeable;
import java.io.IOException;
/**
* Protocol interface to be implemented by a client to a build cache backend.
*
* <p>
* Build cache implementations should report a non-fatal failure as a {@link BuildCacheException}.
* Non-fatal failures could include failing to retrieve a cache entry or unsuccessfully completing an upload a new cache entry.
* Gradle will not fail the build when catching a {@code BuildCacheException}, but it may disable caching for the build if too
* many failures occur.
* </p>
* <p>
* All other failures will be considered fatal and cause the Gradle build to fail.
* Fatal failures could include failing to read or write cache entries due to file permissions, authentication or corruption errors.
* </p>
* <p>
* Every build cache implementation should define a {@code org.gradle.caching.configuration.BuildCache} configuration and {@code BuildCacheServiceFactory} factory.
* </p>
*
* @since 3.5
*/
public interface BuildCacheService extends Closeable {
/**
* Load the cached entry corresponding to the given cache key. The {@code reader} will be called if an entry is found in the cache.
*
* @param key the cache key.
* @param reader the reader to read the data corresponding to the cache key.
* @return {@code true} if an entry was found, {@code false} otherwise.
* @throws BuildCacheException if the cache fails to load a cache entry for the given key
*/
boolean load(BuildCacheKey key, BuildCacheEntryReader reader) throws BuildCacheException;
/**
* Store the cache entry with the given cache key. The {@code writer} will be called to actually write the data.
*
* @param key the cache key.
* @param writer the writer to write the data corresponding to the cache key.
* @throws BuildCacheException if the cache fails to store a cache entry for the given key
*/
void store(BuildCacheKey key, BuildCacheEntryWriter writer) throws BuildCacheException;
/**
* Clean up any resources held by the cache once it's not used anymore.
*
* @throws IOException if the cache fails to close cleanly.
*/
@Override
void close() throws IOException;
}