ApplicationHome.java
/*
* Copyright (c) 2002-2019, Mairie de 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.appcenter.business;
import fr.paris.lutece.plugins.appcenter.business.organization.OrganizationManager;
import fr.paris.lutece.plugins.appcenter.business.organization.OrganizationManagerHome;
import fr.paris.lutece.plugins.appcenter.service.AuthorizationService;
import fr.paris.lutece.portal.service.plugin.Plugin;
import fr.paris.lutece.portal.service.plugin.PluginService;
import fr.paris.lutece.portal.service.spring.SpringContextService;
import fr.paris.lutece.util.ReferenceList;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
/**
* This class provides instances management methods (create, find, ...) for Application objects
*/
public final class ApplicationHome
{
// Static variable pointed at the DAO instance
private static IApplicationDAO _dao = SpringContextService.getBean( "appcenter.applicationDAO" );
private static Plugin _plugin = PluginService.getPlugin( "appcenter" );
/**
* Private constructor - this class need not be instantiated
*/
private ApplicationHome( )
{
}
/**
* Create an instance of the application class
*
* @param application
* The instance of the Application which contains the informations to store
* @return The instance of application which has been created with its primary key.
*/
public static Application create( Application application )
{
_dao.insert( application, _plugin );
return application;
}
/**
* Update of the application which is specified in parameter
*
* @param application
* The instance of the Application which contains the data to store
* @return The instance of the application which has been updated
*/
public static Application update( Application application )
{
_dao.store( application, _plugin );
return application;
}
/**
* Update of the application data
*
* @param nApplicationId
* The application ID
*
* The instance of the Application which contains the data to store
* @param strData
* The data
*/
public static void updateData( int nApplicationId, String strData )
{
_dao.storeData( nApplicationId, strData, _plugin );
}
/**
* Remove the application whose identifier is specified in parameter
*
* @param nKey
* The application Id
*/
public static void remove( int nKey )
{
_dao.delete( nKey, _plugin );
}
/**
* Returns an instance of a application whose identifier is specified in parameter
*
* @param nKey
* The application primary key
* @return an instance of Application
*/
public static Application findByPrimaryKey( int nKey )
{
Application application = _dao.load( nKey, _plugin );
if ( application != null )
{
application.setAuthorizations( UserApplicationRoleHome.getUserApplicationRolesListByIdApplication( application.getId( ) ) );
OrganizationManager organizationManager = OrganizationManagerHome.findByPrimaryKey( application.getOrganizationManager( ).getIdOrganizationManager( ) );
application.setOrganizationManager( organizationManager );
}
return application;
}
/**
* Returns an instance of a application whose code is specified in parameter
*
* @param strCode
* The application code
* @return an instance of Application
*/
public static Application findByCode( String strCode )
{
Application application = _dao.loadByCode( strCode, _plugin );
if ( application != null )
{
application.setAuthorizations( UserApplicationRoleHome.getUserApplicationRolesListByIdApplication( application.getId( ) ) );
OrganizationManager organizationManager = OrganizationManagerHome.findByPrimaryKey( application.getOrganizationManager( ).getIdOrganizationManager( ) );
application.setOrganizationManager( organizationManager );
}
return application;
}
/**
* Load the data of all the application objects and returns them as a list
*
* @return the list which contains the data of all the application objects
*/
public static List<Application> getApplicationsList( )
{
List<Application> applicationList = _dao.selectApplicationsList( _plugin );
for ( Application application : applicationList )
{
OrganizationManager organizationManager = OrganizationManagerHome.findByPrimaryKey( application.getOrganizationManager( ).getIdOrganizationManager( ) );
application.setOrganizationManager( organizationManager );
}
return applicationList;
}
/**
* Load the data of a selection of application objects and returns them as a list
*
* @param filter
* @return the list which contains the data of the selection of application objects
*/
public static List<Application> getApplicationsListByFilter( ApplicationFilter filter )
{
List<Application> applicationList = _dao.selectApplicationsListByFilter( filter, _plugin );
for ( Application application : applicationList )
{
OrganizationManager organizationManager = OrganizationManagerHome.findByPrimaryKey( application.getOrganizationManager( ).getIdOrganizationManager( ) );
application.setOrganizationManager( organizationManager );
}
return applicationList;
}
/**
* Load the data of all the application objects and returns them as a referenceList
*
* @return the referenceList which contains the data of all the application objects
*/
public static ReferenceList getApplicationsReferenceList( )
{
return _dao.selectApplicationsReferenceList( _plugin );
}
/**
* Load the data of all the application objects and returns them as a map
*
* @return the map which contains the data of all the application objects
*/
public static Map<String, Application> getApplicationsMap( )
{
Map<String,Application> applicationMap = _dao.selectApplicationsMap( _plugin );
for ( Application application : applicationMap.values( ) )
{
OrganizationManager organizationManager = OrganizationManagerHome.findByPrimaryKey( application.getOrganizationManager( ).getIdOrganizationManager( ) );
application.setOrganizationManager( organizationManager );
}
return applicationMap;
}
/**
* Get authorized app for a given user
*
* @param strUserId
* The user ID
* @return The list of apps
*/
public static List<Application> getApplicationsByUser( String strUserId )
{
List<Application> listApplications = getApplicationsList( );
List<Application> listAuthorizedApplications = new ArrayList<>( );
for ( Application app : listApplications )
{
if ( AuthorizationService.isAuthorized( strUserId, app.getId( ), "PERMISSION_VIEW_APPLICATION", null ) )
{
listAuthorizedApplications.add( app );
}
}
return listAuthorizedApplications;
}
/**
* Get authorized app for a given user
*
* @param strUserId
* The user ID
* @return The list of apps
*/
public static List<Application> getApplicationsActiveByUser( String strUserId )
{
List<Application> listApplications = getApplicationsList( );
List<Application> listAuthorizedApplications = new ArrayList<>( );
for ( Application app : listApplications )
{
if ( app.isActive( ) && AuthorizationService.isAuthorized( strUserId, app.getId( ), "PERMISSION_VIEW_APPLICATION", null ) )
{
listAuthorizedApplications.add( app );
}
}
return listAuthorizedApplications;
}
/**
* Update of the application status
*
* @param nApplicationId
* The application ID
*
* @param strCodeApp
* The application code
*
* @param isActive
* The active
*/
public static void updateStatus( int nApplicationId, String strCodeApp, boolean isActive )
{
_dao.updateStatus( nApplicationId, strCodeApp, isActive, _plugin );
}
}