Package: MetadataCache

MetadataCache

Coverage

1: /*
2: * #%L
3: * *********************************************************************************************************************
4: *
5: * NorthernWind - lightweight CMS
6: * http://northernwind.tidalwave.it - git clone https://bitbucket.org/tidalwave/northernwind-src.git
7: * %%
8: * Copyright (C) 2011 - 2023 Tidalwave s.a.s. (http://tidalwave.it)
9: * %%
10: * *********************************************************************************************************************
11: *
12: * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
13: * the License. You may obtain a copy of the License at
14: *
15: * http://www.apache.org/licenses/LICENSE-2.0
16: *
17: * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
18: * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
19: * specific language governing permissions and limitations under the License.
20: *
21: * *********************************************************************************************************************
22: *
23: *
24: * *********************************************************************************************************************
25: * #L%
26: */
27: package it.tidalwave.northernwind.frontend.media.impl;
28:
29: import javax.annotation.Nonnull;
30: import java.io.IOException;
31: import it.tidalwave.util.Id;
32: import it.tidalwave.util.NotFoundException;
33: import it.tidalwave.northernwind.core.model.ResourceProperties;
34:
35: /***********************************************************************************************************************
36: *
37: * This service implements a {@link Metadata} provider with a cache policy for reducing the accesses to the actual data
38: * provider.
39: *
40: * @author Fabrizio Giudici
41: *
42: **********************************************************************************************************************/
43: @FunctionalInterface
44: public interface MetadataCache
45: {
46: /*******************************************************************************************************************
47: *
48: * Finds a {@link Metadata} item for the given id. The returned item could be cached.
49: *
50: * @param mediaId the media id
51: * @param properties some configuration properties
52: * @return the {@code Metadata}
53: * @throws NotFoundException if no {@code Metadata} is found
54: *
55: ******************************************************************************************************************/
56: @Nonnull
57: public Metadata findMetadataById (@Nonnull Id mediaId, @Nonnull ResourceProperties properties)
58: throws NotFoundException, IOException;
59: }