1 /*
2 * Copyright (c) 2002-2024, City of 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.rest.util.xml;
35
36 import fr.paris.lutece.portal.service.util.AppPropertiesService;
37 import fr.paris.lutece.util.xml.XmlUtil;
38
39 /**
40 * Xml Response Util
41 */
42 public final class XMLUtil
43 {
44 private static final String TAG_ERROR = "error";
45 private static final String TAG_MESSAGE = "error-message";
46 private static final String TAG_CODE = "error-code";
47 private static String _strHeader = AppPropertiesService.getProperty( XmlUtil.PROPERTIES_XML_HEADER );
48
49 /**
50 * Private constructor
51 */
52 private XMLUtil( )
53 {
54 }
55
56 /**
57 * Format an error response
58 *
59 * @param strMessage
60 * The message
61 * @param nCode
62 * The error code
63 * @return An XML response
64 */
65 public static String formatError( String strMessage, int nCode )
66 {
67 StringBuffer sbXMl = new StringBuffer( _strHeader );
68 XmlUtil.beginElement( sbXMl, TAG_ERROR );
69 XmlUtil.addElement( sbXMl, TAG_MESSAGE, strMessage );
70 XmlUtil.addElement( sbXMl, TAG_CODE, "" + nCode );
71 XmlUtil.endElement( sbXMl, TAG_ERROR );
72
73 return sbXMl.toString( );
74 }
75 }