ClientDAO.java
/*
* Copyright (c) 2002-2024, City of Paris
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright notice
* and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice
* and the following disclaimer in the documentation and/or other materials
* provided with the distribution.
*
* 3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* License 1.0
*/
package fr.paris.lutece.plugins.identityimport.business;
import fr.paris.lutece.portal.service.plugin.Plugin;
import fr.paris.lutece.util.ReferenceList;
import fr.paris.lutece.util.sql.DAOUtil;
import java.sql.Statement;
import java.util.ArrayList;
import java.util.List;
import java.util.Optional;
/**
* This class provides Data Access methods for Client objects
*/
public final class ClientDAO implements IClientDAO
{
// Constants
private static final String SELECT_COLUMNS = "id_client, name, app_code, token, data_retention_period_in_months";
private static final String SQL_QUERY_SELECT = "SELECT " + SELECT_COLUMNS + " FROM identityimport_client WHERE id_client = ?";
private static final String SQL_QUERY_INSERT = "INSERT INTO identityimport_client ( name, app_code, token, data_retention_period_in_months ) VALUES ( ?, ?, ?, ? ) ";
private static final String SQL_QUERY_DELETE = "DELETE FROM identityimport_client WHERE id_client = ? ";
private static final String SQL_QUERY_UPDATE = "UPDATE identityimport_client SET id_client = ?, name = ?, app_code = ?, token = ?, data_retention_period_in_months = ? WHERE id_client = ?";
private static final String SQL_QUERY_SELECTALL = "SELECT " + SELECT_COLUMNS + " FROM identityimport_client";
private static final String SQL_QUERY_SELECTALL_ID = "SELECT id_client FROM identityimport_client";
private static final String SQL_QUERY_SELECTALL_BY_IDS = "SELECT " + SELECT_COLUMNS + " FROM identityimport_client WHERE id_client IN ( ";
private static final String SQL_QUERY_SELECT_BY_TOKEN = "SELECT " + SELECT_COLUMNS + " FROM identityimport_client WHERE token = ?";
/**
* {@inheritDoc }
*/
@Override
public void insert( Client client, Plugin plugin )
{
try ( final DAOUtil daoUtil = new DAOUtil( SQL_QUERY_INSERT, Statement.RETURN_GENERATED_KEYS, plugin ) )
{
int nIndex = 1;
daoUtil.setString( nIndex++, client.getName( ) );
daoUtil.setString( nIndex++, client.getAppCode( ) );
daoUtil.setString( nIndex++, client.getToken( ) );
daoUtil.setInt( nIndex++, client.getDataRetentionPeriodInMonths( ) );
daoUtil.executeUpdate( );
if ( daoUtil.nextGeneratedKey( ) )
{
client.setId( daoUtil.getGeneratedKeyInt( 1 ) );
}
}
}
/**
* {@inheritDoc }
*/
@Override
public Optional<Client> load( int nKey, Plugin plugin )
{
try ( final DAOUtil daoUtil = new DAOUtil( SQL_QUERY_SELECT, plugin ) )
{
daoUtil.setInt( 1, nKey );
daoUtil.executeQuery( );
Client client = null;
if ( daoUtil.next( ) )
{
client = this.getClient( daoUtil );
}
return Optional.ofNullable( client );
}
}
/**
* {@inheritDoc }
*/
@Override
public void delete( int nKey, Plugin plugin )
{
try ( final DAOUtil daoUtil = new DAOUtil( SQL_QUERY_DELETE, plugin ) )
{
daoUtil.setInt( 1, nKey );
daoUtil.executeUpdate( );
}
}
/**
* {@inheritDoc }
*/
@Override
public void store( Client client, Plugin plugin )
{
try ( final DAOUtil daoUtil = new DAOUtil( SQL_QUERY_UPDATE, plugin ) )
{
int nIndex = 1;
daoUtil.setInt( nIndex++, client.getId( ) );
daoUtil.setString( nIndex++, client.getName( ) );
daoUtil.setString( nIndex++, client.getAppCode( ) );
daoUtil.setString( nIndex++, client.getToken( ) );
daoUtil.setInt( nIndex++, client.getDataRetentionPeriodInMonths( ) );
daoUtil.setInt( nIndex, client.getId( ) );
daoUtil.executeUpdate( );
}
}
/**
* {@inheritDoc }
*/
@Override
public List<Client> selectClientsList( Plugin plugin )
{
final List<Client> clientList = new ArrayList<>( );
try ( final DAOUtil daoUtil = new DAOUtil( SQL_QUERY_SELECTALL, plugin ) )
{
daoUtil.executeQuery( );
while ( daoUtil.next( ) )
{
clientList.add( this.getClient( daoUtil ) );
}
return clientList;
}
}
/**
* {@inheritDoc }
*/
@Override
public List<Integer> selectIdClientsList( Plugin plugin )
{
final List<Integer> clientList = new ArrayList<>( );
try ( final DAOUtil daoUtil = new DAOUtil( SQL_QUERY_SELECTALL_ID, plugin ) )
{
daoUtil.executeQuery( );
while ( daoUtil.next( ) )
{
clientList.add( daoUtil.getInt( 1 ) );
}
return clientList;
}
}
/**
* {@inheritDoc }
*/
@Override
public ReferenceList selectClientsReferenceList( Plugin plugin )
{
final ReferenceList clientList = new ReferenceList( );
try ( final DAOUtil daoUtil = new DAOUtil( SQL_QUERY_SELECTALL, plugin ) )
{
daoUtil.executeQuery( );
while ( daoUtil.next( ) )
{
clientList.addItem( daoUtil.getInt( 1 ), daoUtil.getString( 2 ) );
}
return clientList;
}
}
/**
* {@inheritDoc }
*/
@Override
public List<Client> selectClientsListByIds( Plugin plugin, List<Integer> listIds )
{
final List<Client> clientList = new ArrayList<>( );
final StringBuilder builder = new StringBuilder( );
if ( !listIds.isEmpty( ) )
{
for ( int i = 0; i < listIds.size( ); i++ )
{
builder.append( "?," );
}
final String placeHolders = builder.deleteCharAt( builder.length( ) - 1 ).toString( );
final String stmt = SQL_QUERY_SELECTALL_BY_IDS + placeHolders + ")";
try ( final DAOUtil daoUtil = new DAOUtil( stmt, plugin ) )
{
int index = 1;
for ( Integer n : listIds )
{
daoUtil.setInt( index++, n );
}
daoUtil.executeQuery( );
while ( daoUtil.next( ) )
{
clientList.add( this.getClient( daoUtil ) );
}
daoUtil.free( );
}
}
return clientList;
}
private Client getClient( final DAOUtil daoUtil )
{
final Client client = new Client( );
client.setId( daoUtil.getInt( 1 ) );
client.setName( daoUtil.getString( 2 ) );
client.setAppCode( daoUtil.getString( 3 ) );
client.setToken( daoUtil.getString( 4 ) );
client.setDataRetentionPeriodInMonths( daoUtil.getInt( 5 ) );
return client;
}
@Override
public Optional<Client> selectClientByToken( final Plugin plugin, final String token )
{
try ( final DAOUtil daoUtil = new DAOUtil( SQL_QUERY_SELECT_BY_TOKEN, plugin ) )
{
daoUtil.setString( 1, token );
daoUtil.executeQuery( );
Client client = null;
if ( daoUtil.next( ) )
{
client = this.getClient( daoUtil );
}
return Optional.ofNullable( client );
}
}
}