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.api;
20
21 import java.io.File;
22 import java.io.IOException;
23 import java.io.InputStream;
24 import java.io.Reader;
25 import java.net.URL;
26 import java.util.Map;
27
28 import org.apache.chemistry.opencmis.commons.endpoints.CmisAuthentication;
29 import org.apache.chemistry.opencmis.commons.endpoints.CmisEndpointsDocument;
30
31 public interface CmisEndpointDocumentReader {
32
33 /**
34 * Reads a CMIS Endpoint Document from a URL.
35 */
36 CmisEndpointsDocument read(URL url) throws IOException;
37
38 /**
39 * Reads a CMIS Endpoint Document from a file.
40 */
41 CmisEndpointsDocument read(File file) throws IOException;
42
43 /**
44 * Reads a CMIS Endpoint Document from a stream.
45 */
46 CmisEndpointsDocument read(InputStream in) throws IOException;
47
48 /**
49 * Reads a CMIS Endpoint Document from a reader.
50 */
51 CmisEndpointsDocument read(Reader in) throws IOException;
52
53 /**
54 * Reads a CMIS Endpoint Document from a String.
55 */
56 CmisEndpointsDocument read(String in);
57
58 /**
59 * Prepares session parameters based on the provides authentication
60 * information.
61 *
62 * @param authentication
63 * a CMIS authentication object
64 *
65 * @return an incomplete set of session parameters, never {@code null}
66 */
67 Map<String, String> pepareSessionParameters(CmisAuthentication authentication);
68
69 }