1 /*
2 * Copyright (c) 2002-2014, 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.formengine.web;
35
36 import fr.paris.lutece.portal.service.util.AppPropertiesService;
37
38 import java.text.MessageFormat;
39
40 import java.util.ArrayList;
41
42 import javax.servlet.http.HttpServletRequest;
43
44
45 /**
46 * This class provides a list of errors for error management
47 */
48 public class FormErrorsList extends ArrayList<String>
49 {
50 private static final long serialVersionUID = -224390005524091311L;
51 private static final String DIESE = "#";
52 private static final String LINK_PREFIX = "href=\"#";
53 private static final String LINK_PREFIX_CLEANED = "href=\"";
54
55 /**
56 * The constructor
57 */
58 public FormErrorsList( )
59 {
60 }
61
62 /**
63 * Add an error to the list
64 * @param strMessage the string message to display
65 * @param strParameter the parameter to complete the message
66 */
67 public void addErrorMessage( String strMessage )
68 {
69 this.add( strMessage );
70 }
71
72 /**
73 * Add an error to the list
74 * @param strErrorKey the property giving the message associated with the error
75 */
76 public void addError( String strErrorKey )
77 {
78 String strErrorMessage = AppPropertiesService.getProperty( strErrorKey );
79
80 this.add( strErrorMessage );
81 }
82
83 /**
84 * Add an error to the list
85 * @param strErrorKey the property giving the message associated with the error
86 * @param strParameter the parameter to complete the message
87 */
88 public void addError( String strErrorKey, String strParameter )
89 {
90 String strErrorMessage = AppPropertiesService.getProperty( strErrorKey );
91
92 if ( strParameter == null )
93 {
94 this.addErrorMessage( strErrorMessage );
95 }
96 else
97 {
98 String[] messageFormatParam = new String[1];
99 messageFormatParam[0] = strParameter;
100 addError( strErrorKey, messageFormatParam );
101 }
102 }
103
104 /**
105 * Add an error to the list
106 * @param strErrorKey the property giving the message associated with the error
107 * @param parameters the array of parameters to complete the message
108 */
109 public void addError( String strErrorKey, String[] parameters )
110 {
111 String strErrorMessage = AppPropertiesService.getProperty( strErrorKey );
112
113 if ( parameters == null )
114 {
115 this.add( strErrorMessage );
116 }
117 else
118 {
119 String strErrorMessageWithParam = MessageFormat.format( strErrorMessage, (Object[]) parameters );
120 this.add( strErrorMessageWithParam );
121 }
122 }
123
124 /**
125 * For each message, convert anchors with the full URL
126 * @param request The HTTP request
127 * @param strSubFormName The subform name
128 */
129 public void convertAnchorsToFullUrl( HttpServletRequest request, String strSubFormName )
130 {
131 for ( int i = 0; i < this.size( ); i++ )
132 {
133 this.set( i,
134 this.get( i )
135 .replace( LINK_PREFIX, LINK_PREFIX_CLEANED + FormEngineApp.setUrl( request, strSubFormName ) +
136 DIESE ) );
137 }
138 }
139 }