1 /**
2 * This file Copyright (c) 2003-2010 Magnolia International
3 * Ltd. (http://www.magnolia-cms.com). All rights reserved.
4 *
5 *
6 * This file is dual-licensed under both the Magnolia
7 * Network Agreement and the GNU General Public License.
8 * You may elect to use one or the other of these licenses.
9 *
10 * This file is distributed in the hope that it will be
11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12 * implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14 * Redistribution, except as permitted by whichever of the GPL
15 * or MNA you select, is prohibited.
16 *
17 * 1. For the GPL license (GPL), you can redistribute and/or
18 * modify this file under the terms of the GNU General
19 * Public License, Version 3, as published by the Free Software
20 * Foundation. You should have received a copy of the GNU
21 * General Public License, Version 3 along with this program;
22 * if not, write to the Free Software Foundation, Inc., 51
23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24 *
25 * 2. For the Magnolia Network Agreement (MNA), this file
26 * and the accompanying materials are made available under the
27 * terms of the MNA which accompanies this distribution, and
28 * is available at http://www.magnolia-cms.com/mna.html
29 *
30 * Any modifications to this file must keep this entire header
31 * intact.
32 *
33 */
34 package info.magnolia.cms.link;
35
36 import info.magnolia.objectfactory.Components;
37
38 /**
39 * Use to transform links
40 * <ul>
41 * <li> uuid pattern --> absolute links
42 * <li> uuid pattern --> relative links
43 * <li> internal links --> uuid pattern
44 * </ul>
45 * <p>
46 * The internal links are for example used in the fck editor.<br/>
47 * website:/home.html
48 * </p>
49 * <p>
50 * The uuid pattern stores all the needed information like repository, uuid, path, filename (for binaries), ...
51 * </p>
52 * <p>
53 * The absolute links are the links used for the request including all transformations like adding context, i18n content support, repository to uri mapping, ...
54 * </p>
55 *
56 * @author philipp
57 * @version $Id: LinkResolver.java 32667 2010-03-13 00:37:06Z gjoseph $
58 * @deprecated since 4.0 use {@link LinkHelper} instead
59 *
60 */
61 public interface LinkResolver {
62
63 public static class Factory{
64 public static LinkResolver getInstance(){
65 return Components.getSingleton(LinkResolver.class);
66 }
67 }
68
69 public String convertToRelativeLinks(String str, String currentPath);
70
71 public String convertToEditorLinks(String str);
72
73 /**
74 * This method is used to create the public links. So it is used by the cms:out tag for example.
75 */
76 public String convertToBrowserLinks(String str, String currentPath);
77
78 public String convertToAbsoluteLinks(String str, boolean addContextPath);
79
80 /**
81 * Used to render links usable from external (like sending an email, ...)
82 */
83 public String convertToExternalLinks(String str);
84
85 /**
86 * Parses the internal links (used mainly by the fckeditor) and creates the uuid pattern instead.
87 */
88 public String parseLinks(String str);
89
90 }