1 /*
2 * Copyright (c) 2002-2022, 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.portal.business.securityheader;
35
36
37 import java.util.Collection;
38
39 import fr.paris.lutece.portal.service.spring.SpringContextService;
40
41 /**
42 * This class provides instances management methods (create, find, ...) for SecurityHeader objects
43 */
44 public final class SecurityHeaderHome
45 {
46 // Static variable pointed at the DAO instance
47 private static ISecurityHeaderDAO _dao = SpringContextService.getBean( "securityHeaderDAO" );
48
49 /**
50 * Private constructor - this class need not be instantiated
51 */
52 private SecurityHeaderHome( )
53 {
54 }
55
56 /**
57 * Creation of an instance of Security header
58 *
59 * @param securityHeader
60 * The instance of the security header which contains the informations to store
61 * @return The instance of security header which has been created with its primary key.
62 */
63 public static SecurityHeader../../../../fr/paris/lutece/portal/business/securityheader/SecurityHeader.html#SecurityHeader">SecurityHeader create( SecurityHeader securityheader )
64 {
65 _dao.insert( securityheader );
66
67 return securityheader;
68 }
69
70 /**
71 * Update of the security header which is specified in parameter
72 *
73 * @param securityHeader
74 * The instance of the Security header which contains the data to store
75 * @return The instance of the security header which has been updated
76 */
77 public static void update( SecurityHeader securityHeader )
78 {
79 _dao.store( securityHeader );
80 }
81
82 /**
83 * Update of the is_active column value of the security header which is specified in parameter
84 *
85 * @param nSecurityHeaderId
86 * The securityHeader Id
87 * @param isActiveValue
88 * The value to set to is_active column
89 */
90 public static void updateIsActive( int nSecurityHeaderId, boolean isActiveValue )
91 {
92 _dao.updateIsActive( nSecurityHeaderId, isActiveValue );
93 }
94
95 /**
96 * Remove the security header whose identifier is specified in parameter
97 *
98 * @param nSecurityHeaderId
99 * The securityHeader Id
100 */
101 public static void remove( int nSecurityHeaderId )
102 {
103 _dao.delete( nSecurityHeaderId );
104 }
105
106 // /////////////////////////////////////////////////////////////////////////
107 // Finders
108
109 /**
110 * Returns an instance of a security header whose identifier is specified in parameter
111 *
112 * @param nKey
113 * The security header primary key
114 * @return an instance of SecurityHeader
115 */
116 public static SecurityHeader findByPrimaryKey( int nKey )
117 {
118 return _dao.load( nKey );
119 }
120
121 /**
122 * Loads the data of all the security headers and returns them in form of a collection.
123 *
124 * @return the collection which contains the data of all the security headers
125 */
126 public static Collection<SecurityHeader> findAll( )
127 {
128 return _dao.selectAll( );
129 }
130
131 /**
132 * Find all active security headers by type (page or REST api).
133 *
134 * @param strType
135 * The type
136 * @return A security headers collection
137 */
138 public static Collection<SecurityHeader> findActiveByType( String strType )
139 {
140 return _dao.selectActiveByType( strType );
141 }
142 }