1 /*
2 * Licensed to The Apereo Foundation under one or more contributor license
3 * agreements. See the NOTICE file distributed with this work for additional
4 * information regarding copyright ownership.
5 *
6 *
7 * The Apereo Foundation licenses this file to you under the Educational
8 * Community License, Version 2.0 (the "License"); you may not use this file
9 * except in compliance with the License. You may obtain a copy of the License
10 * at:
11 *
12 * http://opensource.org/licenses/ecl2.txt
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
17 * License for the specific language governing permissions and limitations under
18 * the License.
19 *
20 */
21
22 package org.opencastproject.mediapackage;
23
24 import java.net.URI;
25 import java.net.URISyntaxException;
26
27 public interface MediaPackageSerializer {
28
29 /**
30 * This method is called every time a url is being written to a media package manifest. By implementing this method,
31 * serializers are able to store package elements in directories relative to some common root folder, thereby making
32 * it movable.
33 *
34 * @param uri
35 * the url to encode
36 * @return the encoded path
37 * @throws URISyntaxException
38 * if the resulting URI contains syntax errors
39 */
40 URI encodeURI(URI uri) throws URISyntaxException;
41
42 /**
43 * This method is called every time a url is being read from a media package manifest. By implementing this method,
44 * serializers are able to redirect urls to local caches which might make sense when it comes to dealing with huge
45 * media files.
46 *
47 * @param path
48 * the original path from the manifest
49 * @return the resolved url
50 * @throws URISyntaxException
51 * if the path cannot be converted into a url
52 * @throws URISyntaxException
53 * if the resulting URI contains syntax errors
54 */
55 URI decodeURI(URI path) throws URISyntaxException;
56
57 /**
58 * Identifies the serializer ranking number. The ranking is respected when multiple serializers are chained. When
59 * encoding an URI, the serializer with the highest ranking is used first. If an URI needs to be decoded, the ranking
60 * is used in the opposite direction.
61 *
62 * @return The service ranking number.
63 */
64 int getRanking();
65
66 }