View Javadoc
1   /*
2    * Copyright (c) 2002-2023, 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.workflow.modules.appointmentants.service.rest;
35  
36  import java.util.HashMap;
37  import java.util.Map;
38  
39  import fr.paris.lutece.portal.service.util.AppPropertiesService;
40  import fr.paris.lutece.util.httpaccess.HttpAccess;
41  import fr.paris.lutece.util.httpaccess.HttpAccessException;
42  
43  /**
44   * 
45   * Class containing all the ANTS REST calls
46   *
47   */
48  public class TaskAntsAppointmentRest {
49  
50  	private TaskAntsAppointmentRest( )
51  	{
52  	}
53  	
54  	/**
55  	 * Add an appointment to the ANTS database through their API, by using
56  	 * a POST method
57  	 * 
58  	 * @param addAppointmentUrl
59  	 * 				The URL used to make the REST call
60  	 * @param token
61  	 * 				The API key to use in the REST call
62  	 * @return
63  	 * 				The content of the call's response
64  	 * @throws HttpAccessException
65  	 */
66  	public static String addAntsAppointment( String addAppointmentUrl, String token )
67  			throws HttpAccessException
68  	{		
69  		HttpAccess httpAccess = new HttpAccess(  );
70  		
71  		Map<String, String> headersRequest = new HashMap<>( );
72          headersRequest.put( AppPropertiesService.getProperty( TaskAntsAppointmentRestConstants.ANTS_TOKEN_HEADER ), token );
73  
74          return httpAccess.doPost( addAppointmentUrl, null, null, null, headersRequest );
75  	}
76  	
77  	/**
78  	 * Delete an appointment from the ANTS database with their API, by using
79  	 * a DELETE method
80  	 * 
81  	 * @param deleteAppointmentUrl
82  	 * 				The URL used to make the REST call
83  	 * @param token
84  	 * 				The API key to use in the REST call
85  	 * @return
86  	 * 				The content of the call's response
87  	 * @throws HttpAccessException
88  	 */
89  	public static String deleteAntsAppointment( String deleteAppointmentUrl, String token )
90  			throws HttpAccessException
91  	{		
92  		HttpAccess httpAccess = new HttpAccess(  );
93  		
94  		Map<String, String> headersRequest = new HashMap<>( );
95          headersRequest.put( AppPropertiesService.getProperty( TaskAntsAppointmentRestConstants.ANTS_TOKEN_HEADER ), token );
96  
97          return httpAccess.doDelete( deleteAppointmentUrl, null, null, headersRequest, null );
98  	}
99  	
100 	/**
101 	 * Get the status of 1 or more appointments from the ANTS database
102 	 * through their API, by using a GET method
103 	 * 
104 	 * @param getStatusUrl
105 	 * 				The URL used to make the REST call
106 	 * @param token
107 	 * 				The API key to use in the REST call
108 	 * @return
109 	 * 				The content of the call's response
110 	 * @throws HttpAccessException
111 	 */
112 	public static String getAntsAppointmentStatus( String getStatusUrl, String token ) 
113 			throws HttpAccessException
114 	{
115 		HttpAccess httpAccess = new HttpAccess(  );
116 		
117 		Map<String, String> headersRequest = new HashMap<>( );
118         headersRequest.put( AppPropertiesService.getProperty( TaskAntsAppointmentRestConstants.ANTS_TOKEN_HEADER ), token );
119 
120         return httpAccess.doGet( getStatusUrl, null, null, headersRequest );
121 	}
122 }