1 /*
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements. See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership. The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License. You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied. See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 */
21 package org.apache.chemistry.opencmis.commons.server;
22
23 import java.io.File;
24 import java.util.Map;
25
26 /**
27 * Factory for {@link CmisService} objects.
28 */
29 public interface CmisServiceFactory {
30
31 /**
32 * Initializes the factory instance.
33 */
34 void init(Map<String, String> parameters);
35
36 /**
37 * Cleans up the the factory instance.
38 */
39 void destroy();
40
41 /**
42 * Returns a {@link CmisService} object for the given {@link CallContext}.
43 *
44 * When the {@link CmisService} object is not longer needed
45 * {@link CmisService#close()} will be called.
46 */
47 CmisService getService(CallContext context);
48
49 /**
50 * Returns the absolute path of the directory that should be used for
51 * temporary files.
52 *
53 * @return absolute path of temp directory
54 */
55 File getTempDirectory();
56
57 /**
58 * Returns up to which size content should be kept in memory. Documents
59 * bigger than this threshold will be cached in a temporary directory.
60 *
61 * @return the threshold in bytes
62 *
63 * @see CmisServiceFactory#getTempDirectory()
64 */
65 int getMemoryThreshold();
66 }