1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.chemistry.opencmis.client.runtime.cache;
20
21 import java.io.Serializable;
22 import java.util.Map;
23
24 import org.apache.chemistry.opencmis.client.api.CmisObject;
25 import org.apache.chemistry.opencmis.client.api.Session;
26
27 /**
28 * Implements a session cache providing following capabilities:
29 * <ul>
30 * <li>access CmisObject by object object ID</li>
31 * <li>access CmisObject by object path</li>
32 * </ul>
33 */
34 public interface Cache extends Serializable {
35
36 void initialize(Session session, Map<String, String> parameters);
37
38 boolean containsId(String objectId, String cacheKey);
39
40 boolean containsPath(String path, String cacheKey);
41
42 void put(CmisObject object, String cacheKey);
43
44 void putPath(String path, CmisObject object, String cacheKey);
45
46 CmisObject getById(String objectId, String cacheKey);
47
48 CmisObject getByPath(String path, String cacheKey);
49
50 String getObjectIdByPath(String path);
51
52 void remove(String objectId);
53
54 void removePath(String path);
55
56 void clear();
57
58 int getCacheSize();
59 }