PhraseanetService.java

  1. /*
  2.  * Copyright (c) 2002-2014, Mairie de 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.phraseanet.service;


  37. import fr.paris.lutece.plugins.phraseanet.business.databox.Collection;
  38. import fr.paris.lutece.plugins.phraseanet.business.databox.Databox;
  39. import fr.paris.lutece.plugins.phraseanet.business.record.Record;
  40. import fr.paris.lutece.plugins.phraseanet.service.api.PhraseanetApiCallService;
  41. import fr.paris.lutece.plugins.phraseanet.service.parsers.CollectionsJsonParser;
  42. import fr.paris.lutece.plugins.phraseanet.service.parsers.DataboxesJsonParser;
  43. import fr.paris.lutece.plugins.phraseanet.service.parsers.EmbedJsonParser;
  44. import fr.paris.lutece.plugins.phraseanet.service.parsers.MetadatasJsonParser;
  45. import fr.paris.lutece.plugins.phraseanet.service.parsers.RecordJsonParser;
  46. import fr.paris.lutece.plugins.phraseanet.service.parsers.SearchResultsJsonParser;
  47. import java.text.MessageFormat;
  48. import java.util.ArrayList;
  49. import java.util.StringTokenizer;
  50. import net.sf.json.JSONObject;
  51. import net.sf.json.JSONArray;
  52. import net.sf.json.JSONException;
  53. import fr.paris.lutece.plugins.phraseanet.business.account.Account;
  54. import fr.paris.lutece.plugins.phraseanet.business.embed.Embed;
  55. import fr.paris.lutece.plugins.phraseanet.business.record.Metadata;
  56. import fr.paris.lutece.plugins.phraseanet.business.search.SearchResults;
  57. import fr.paris.lutece.plugins.phraseanet.service.api.PhraseanetApiCallException;
  58. import fr.paris.lutece.portal.service.util.AppPropertiesService;
  59. import java.util.HashMap;
  60. import java.util.List;
  61. import java.util.Map;

  63. import org.apache.log4j.Logger;



  67. /**
  68.  * PhraseanetService
  69.  */
  70. public final class PhraseanetService
  71. {
  72.     private static final String PROPERTY_ITEMS_PER_PAGE_VALUES = "phraseanet.itemsPerPageValues";
  73.     private static final String PROPERTY_MEDIA_TYPE_VALUES = "phraseanet.mediaTypeValues";
  74.     private static final String PATH_GET_RECORD = "/api/v1/records/{0}/{1}/";
  75.     private static final String PATH_GET_DATABOXE_METADATAS = "/api/v1/databoxes/{0}/metadatas/";
  76.     private static final String PATH_GET_RECORD_METADATAS = "/api/v1/records/{0}/{1}/metadatas/";
  77.     private static final String PATH_SEARCH = "/api/v1/records/search/?";
  78.     private static final String PATH_DATABOXES = "/api/v1/databoxes/list/";
  79.     private static final String PATH_COLLECTIONS = "/api/v1/databoxes/{0}/collections/";
  80.     private static final String PATH_EMBED = "/api/v1/records/{0}/{1}/embed/";
  81.     private static final String PARAMETER_QUERY = "query";
  82.     private static final String PARAMETER_PAGE = "page";
  83.     private static final String PARAMETER_PER_PAGE = "per_page";
  84.     private static final String PARAMETER_RECORD_TYPE = "record_type";
  85.     private static final String PARAMETER_BASES = "bases[]";
  86.     private static final String DELIMITER = ",";
  87.     private static final String SEARCH_ALL = "< All >";
  88.     private static List<String> _listItemsPerPageValues;
  89.     private static List<String> _listMediaTypeValues;
  90.     private static Logger _logger = Logger.getLogger( Constants.LOGGER );
  91.     
  92.     /** private constructor */
  93.     private PhraseanetService()
  94.     {
  95.         
  96.     }
  97.     

  99.     /**
  100.      * Gets a record
  101.      * @param nDataboxId The databox id
  102.      * @param nRecordId The record id
  103.      * @param account the user phraseanet account
  104.      * @return The record
  105.      * @throws PhraseanetApiCallException if an error occurs
  106.      */
  107.     public static Record getRecord( int nDataboxId, int nRecordId, Account account )
  108.         throws PhraseanetApiCallException
  109.     {
  110.         _logger.debug( "getRecord" );
  111.         Object[] arguments = { Integer.toString( nDataboxId ), Integer.toString( nRecordId ) };
  112.         String url = account.getAccessURL(  ) + MessageFormat.format( PATH_GET_RECORD, arguments );
  113.         JSONObject jsonResponse = PhraseanetApiCallService.getResponse( url, account );
  114.         JSONObject jsonRecord = jsonResponse.getJSONObject( "record" );

  116.         return RecordJsonParser.parse( jsonRecord );
  117.     }
  118.     
  119.     /**
  120.      * Get metadatas for a given databoxe
  121.      * @param nDataboxId The databox id
  122.      * @param account the user phraseanet account
  123.      * @return Metadatas
  124.      * @throws PhraseanetApiCallException if an error occurs
  125.      */
  126.     public static List<Metadata> getDataboxeMetadatas( int nDataboxId, Account account )
  127.         throws PhraseanetApiCallException
  128.     {
  129.         Object[] arguments = { Integer.toString( nDataboxId ) };
  130.         String url = account.getAccessURL(  ) + MessageFormat.format( PATH_GET_DATABOXE_METADATAS, arguments );
  131.         _logger.debug("getDataboxeMetadatas : " + url ) ;
  132.         JSONObject jsonResponse = PhraseanetApiCallService.getResponse( url, account );
  133.         _logger.debug("getDataboxeMetadatas (response) : " + jsonResponse ) ;

  135.         return MetadatasJsonParser.parseByDataboxe( jsonResponse );
  136.     }

  138.     /**
  139.      * Get metadatas for a given record
  140.      * @param nDataboxId The databox id
  141.      * @param nRecordId The record id
  142.      * @param account the user phraseanet account
  143.      * @return Metadatas
  144.      * @throws PhraseanetApiCallException if an error occurs
  145.      */
  146.     public static List<Metadata> getRecordMetadatas( int nDataboxId, int nRecordId, Account account )
  147.         throws PhraseanetApiCallException
  148.     {
  149.         Object[] arguments = { Integer.toString( nDataboxId ), Integer.toString( nRecordId ) };
  150.         String url = account.getAccessURL(  ) + MessageFormat.format( PATH_GET_RECORD_METADATAS, arguments );
  151.         JSONObject jsonResponse = PhraseanetApiCallService.getResponse( url, account );
  152.         
  153.         return MetadatasJsonParser.parse( jsonResponse );
  154.     }
  155.      
  156.     /**
  157.      * Searc results
  158.      * @param strQuery Query terms
  159.      * @param nPage Page number
  160.      * @param nPerPage Number of items per page
  161.      * @param criterias Criterias
  162.      * @param account the user phraseanet account
  163.      * @return search results
  164.      * @throws PhraseanetApiCallException if an error occurs
  165.      */
  166.     public static SearchResults search( String strQuery, int nPage, int nPerPage, SearchCriterias criterias, Account account )
  167.         throws PhraseanetApiCallException
  168.     {
  169.         String strUrl = account.getAccessURL(  ) + PATH_SEARCH ;
  170.         _logger.debug("URL de la reqette API : " + strUrl);
  171.         Map<String, List<String>> mapParameters = new HashMap<String, List<String>>(  );
  172.         putParameter( mapParameters, PARAMETER_QUERY, strQuery );
  173.         putParameter( mapParameters, PARAMETER_PAGE, String.valueOf( nPage ) );
  174.         putParameter( mapParameters, PARAMETER_PER_PAGE, String.valueOf( nPerPage ) );
  175.         _logger.debug("Parametres de la requette : " + mapParameters);

  177.         if ( ( criterias.getRecordType(  ) != null ) || !criterias.getRecordType(  ).equals( SEARCH_ALL ) )
  178.         {
  179.             putParameter( mapParameters, PARAMETER_RECORD_TYPE, criterias.getRecordType(  ) );
  180.         }

  182.         mapParameters.put( PARAMETER_BASES, criterias.getBases(  ) );

  184.         // TODO add other criterias
  185.         JSONObject jsonResponse = PhraseanetApiCallService.getPostResponse( strUrl, mapParameters, account );

  187.         return SearchResultsJsonParser.parse( jsonResponse );
  188.     }

  190.     /**
  191.      * Get databoxes
  192.      * @param account the user phraseanet account
  193.      * @return The lis of databoxes
  194.      * @throws PhraseanetApiCallException if an error occurs
  195.      */
  196.     public static List<Databox> getDataboxes( Account account ) throws PhraseanetApiCallException
  197.     {
  198.         String strUrl = account.getAccessURL(  ) + PATH_DATABOXES;
  199.         JSONObject jsonResponse = PhraseanetApiCallService.getResponse( strUrl, account );
  200.         JSONObject jsonDataboxes;
  201.         
  202.         try
  203.         {
  204.             jsonDataboxes = jsonResponse.getJSONObject( "databoxes" );
  205.         }
  206.         catch ( JSONException e )
  207.         {
  208.             // maybe api_version 2
  209.             JSONArray jsonDataboxesList = jsonResponse.getJSONArray( "databoxes" );
  210.             jsonDataboxes = jsonDataboxesList.toJSONObject( jsonDataboxesList ) ;
  211.         }   

  213.         return DataboxesJsonParser.parse( jsonDataboxes );
  214.     }

  216.     /**
  217.      * Get all collections of databox
  218.      * @param nDataboxId The databox id
  219.      * @param account the user phraseanet account
  220.      * @return a collection list
  221.      * @throws PhraseanetApiCallException if an error occurs
  222.      */
  223.     public static List<Collection> getColletions( int nDataboxId, Account account )
  224.         throws PhraseanetApiCallException
  225.     {
  226.         Object[] arguments = { nDataboxId };
  227.         String strUrl = account.getAccessURL(  ) + MessageFormat.format( PATH_COLLECTIONS, arguments );
  228.         JSONObject jsonResponse = PhraseanetApiCallService.getResponse( strUrl, account );
  229.         _logger.debug("Collections : " + jsonResponse);

  231.         return CollectionsJsonParser.parse( jsonResponse );
  232.     }

  234.     /**
  235.      * Get embed data of a record
  236.      * @param nDataboxId The databox id
  237.      * @param nRecordId The record id
  238.      * @param account the user phraseanet account
  239.      * @return embed data
  240.      * @throws PhraseanetApiCallException if an error occurs
  241.      */
  242.     public static Embed getEmbed( int nDataboxId, int nRecordId, Account account )
  243.         throws PhraseanetApiCallException
  244.     {
  245.         Object[] arguments = { Integer.toString( nDataboxId ), Integer.toString( nRecordId ) };
  246.         String url = account.getAccessURL(  ) + MessageFormat.format( PATH_EMBED, arguments );
  247.         JSONObject jsonResponse = PhraseanetApiCallService.getResponse( url, account );
  248.         JSONArray jsonEmbedList = jsonResponse.getJSONArray( "embed" );
  249.         JSONObject jsonEmbed = jsonEmbedList.toJSONObject( jsonEmbedList ) ;

  251.         return EmbedJsonParser.parse( jsonEmbed );
  252.     }

  254.     /**
  255.      * Gets items per page values
  256.      * @return items per page values
  257.      */
  258.     public static synchronized List<String> getItemsPerPageValues(  )
  259.     {
  260.         if ( _listItemsPerPageValues == null )
  261.         {
  262.             _listItemsPerPageValues = new ArrayList<String>(  );

  264.             String strItemsPerPageValues = AppPropertiesService.getProperty( PROPERTY_ITEMS_PER_PAGE_VALUES );
  265.             StringTokenizer st = new StringTokenizer( strItemsPerPageValues, DELIMITER );

  267.             while ( st.hasMoreTokens(  ) )
  268.             {
  269.                 String strValue = st.nextToken(  );
  270.                 _listItemsPerPageValues.add( strValue.trim(  ) );
  271.             }
  272.         }

  274.         return _listItemsPerPageValues;
  275.     }

  277.     /**
  278.      * Get media types values
  279.      * @return media types values
  280.      */
  281.     public static synchronized List<String> getMediaTypeValues(  )
  282.     {
  283.         if ( _listMediaTypeValues == null )
  284.         {
  285.             _listMediaTypeValues = new ArrayList<String>(  );

  287.             String strMediaTypeValues = AppPropertiesService.getProperty( PROPERTY_MEDIA_TYPE_VALUES );
  288.             StringTokenizer st = new StringTokenizer( strMediaTypeValues, DELIMITER );

  290.             while ( st.hasMoreTokens(  ) )
  291.             {
  292.                 String strValue = st.nextToken(  );
  293.                 _listMediaTypeValues.add( strValue.trim(  ) );
  294.             }
  295.         }

  297.         return _listMediaTypeValues;
  298.     }

  300.     /**
  301.      * Add parameters to a map
  302.      * @param map The map
  303.      * @param strKey The parameter key
  304.      * @param strValue The parameter value
  305.      */
  306.     private static void putParameter( Map<String, List<String>> map, String strKey, String strValue )
  307.     {
  308.         List<String> listValue = new ArrayList<String>(  );
  309.         listValue.add( strValue );
  310.         map.put( strKey, listValue );
  311.     }
  312.     
  313.     /**
  314.      * Get embed data of a record
  315.      * @param nDataboxId The databox id
  316.      * @param nRecordId The record id
  317.      * @return embed data
  318.      * @throws PhraseanetApiCallException if an error occurs
  319.      */
  320.     /**
  321.     public static Record getBasesRecords( List<Integer> listIdBases, Account account )
  322.         throws PhraseanetApiCallException
  323.     {
  324.         Object[] arguments = { Integer.toString( nDataboxId ), Integer.toString( nRecordId ) };
  325.         String url = account.getAccessURL(  ) + PATH_SEARCH ;
  326.         Map<String, List<String>> mapParameters = new HashMap<String, List<String>>(  );
  327.         putParameter( mapParameters, PARAMETER_QUERY, strQuery );
  328.         JSONObject jsonResponse = PhraseanetApiCallService.getPostResponse( strUrl, mapParameters, account );
  329.         
  330.         return EmbedJsonParser.parse( jsonEmbed );
  331.     }
  332.     */
  333. }
Created with JaCoCo 0.7.9.201702052155