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.grubusiness.service.encryption;
35
36 import fr.paris.lutece.plugins.grubusiness.business.customer.Customer;
37 import fr.paris.lutece.plugins.grubusiness.business.demand.Demand;
38
39 /**
40 * This interface enables to encrypt / decrypt a {@code Customer}
41 *
42 */
43 public interface ICustomerEncryptionService
44 {
45 /**
46 * <p>
47 * Encrypts a {@link Customer} from the specified {@code Customer}.
48 * <p>
49 * <p>
50 * The provided {@code Customer} is not modified.
51 * </p>
52 *
53 * @param customer
54 * the customer from which the {@code Customer} is encrypted. Must not be {@code null}
55 * @param demand
56 * the demand for which the {@code Customer} is encrypted. Must not be {@code null}
57 * @return the encrypted {@code Customer}
58 */
59 Customer./../../../../../../fr/paris/lutece/plugins/grubusiness/business/customer/Customer.html#Customer">Customer encrypt( Customer customer, Demand demand );
60
61 /**
62 * <p>
63 * Encrypts a {@link Customer} from the specified {@code Customer}.
64 * <p>
65 * <p>
66 * The provided {@code Customer} is not modified.
67 * </p>
68 *
69 * @param customer
70 * the customer from which the {@code Customer} is encrypted. Must not be {@code null}
71 * @param strCode
72 * the code used to encrypt the {@code Customer}. Must not be {@code null}
73 * @return the encrypted {@code Customer}
74 */
75 Customer./../../../../../../fr/paris/lutece/plugins/grubusiness/business/customer/Customer.html#Customer">Customer encrypt( Customer customer, String strCode );
76
77 /**
78 * <p>
79 * Decrypts a {@link Customer} from the specified {@code Customer}.
80 * <p>
81 * <p>
82 * The provided {@code Customer} is not modified.
83 * </p>
84 *
85 * @param customer
86 * the customer from which the {@code Customer} is decrypted. Must not be {@code null}
87 * @param demand
88 * the demand for which the {@code Customer} is decrypted. Must not be {@code null}
89 * @return the decrypted {@code Customer}
90 */
91 Customer./../../../../../../fr/paris/lutece/plugins/grubusiness/business/customer/Customer.html#Customer">Customer decrypt( Customer customer, Demand demand );
92
93 /**
94 * <p>
95 * Decrypts a {@link Customer} from the specified {@code Customer}.
96 * <p>
97 * <p>
98 * The provided {@code Customer} is not modified.
99 * </p>
100 *
101 * @param customer
102 * the customer from which the {@code Customer} is decrypted. Must not be {@code null}
103 * @param strCode
104 * the code used to decrypt the {@code Customer}. Must not be {@code null}
105 * @return the decrypted {@code Customer}
106 */
107 Customer./../../../../../../fr/paris/lutece/plugins/grubusiness/business/customer/Customer.html#Customer">Customer decrypt( Customer customer, String strCode );
108 }