1 /*
2 * Copyright (c) 2002-2017, Mairie de Paris
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright notice
10 * and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright notice
13 * and the following disclaimer in the documentation and/or other materials
14 * provided with the distribution.
15 *
16 * 3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 *
32 * License 1.0
33 */
34 package fr.paris.lutece.plugins.gru.utils;
35
36 import fr.paris.lutece.plugins.gru.web.Constants;
37 import fr.paris.lutece.plugins.grubusiness.business.customer.Customer;
38 import fr.paris.lutece.portal.service.util.AppLogService;
39 import fr.paris.lutece.portal.util.mvc.utils.MVCUtils;
40 import fr.paris.lutece.util.url.UrlItem;
41
42 import java.io.UnsupportedEncodingException;
43
44 import java.util.HashMap;
45 import java.util.Map;
46
47 /**
48 * This class provides utility methods for URLs
49 *
50 */
51 public final class UrlUtils
52 {
53 private static final String URL_ENCODING = "UTF-8";
54
55 /**
56 * Default constructor
57 */
58 private UrlUtils( )
59 {
60 }
61
62 /**
63 * Encodes a URL
64 *
65 * @param strUrl
66 * the URL
67 * @return the encoded URL or the original URL if there is an exception during the encoding
68 */
69 public static String encodeUrl( String strUrl )
70 {
71 String strUrlEncoded = strUrl;
72
73 try
74 {
75 strUrlEncoded = java.net.URLEncoder.encode( strUrl, URL_ENCODING );
76 }
77 catch( UnsupportedEncodingException e1 )
78 {
79 AppLogService.error( e1 );
80 }
81
82 return strUrlEncoded;
83 }
84
85 /**
86 * Builds the URL to return to plugin gru after action on another plugin
87 *
88 * @param strControllerUrl
89 * the controller URL
90 * @param strView
91 * the view to display
92 * @param mapParameters
93 * the map of parameters
94 * @return the return URL
95 */
96 public static String buildReturnUrl( String strControllerUrl, String strView, Map<String, String> mapParameters )
97 {
98 UrlItem url = new UrlItem( strControllerUrl );
99 url.addParameter( MVCUtils.PARAMETER_VIEW, strView );
100
101 for ( Map.Entry<String, String> entry : mapParameters.entrySet( ) )
102 {
103 url.addParameter( entry.getKey( ), entry.getValue( ) );
104 }
105
106 return url.getUrl( );
107 }
108
109 /**
110 * Builds the URL to return to plugin gru after action on another plugin
111 *
112 * @param strControllerUrl
113 * the controller URL
114 * @param strView
115 * the view to display
116 * @param customer
117 * the customer
118 * @return the return URL
119 */
120 public static String buildReturnUrl( String strControllerUrl, String strView, Customer customer )
121 {
122 Map<String, String> mapParameters = new HashMap<String, String>( );
123
124 if ( customer != null )
125 {
126 mapParameters.put( Constants.PARAMETER_ID_CUSTOMER, customer.getId( ) );
127 }
128
129 return buildReturnUrl( strControllerUrl, strView, mapParameters );
130 }
131 }