Changeset 10716 for extensions/jiwigo-ws-api

Timestamp:

May 1, 2011, 12:44:59 PM (13 years ago)

Author:

mlg

Message:

Adds support for pwg.images.delete function
(deletes image).

Location:

extensions/jiwigo-ws-api/src/main/java/fr/mael/jiwigo

Files:

• dao/ImageDao.java (modified) (1 diff)
• dao/impl/CategoryDaoImpl.java (modified) (1 diff)
• dao/impl/ImageDaoImpl.java (modified) (2 diffs)
• service/ImageService.java (modified) (2 diffs)
• service/impl/ImageServiceImpl.java (modified) (2 diffs)
• transverse/enumeration/MethodsEnum.java (modified) (1 diff)
• transverse/session/SessionManager.java (modified) (1 diff)
• transverse/session/impl/SessionManagerImpl.java (modified) (1 diff)

extensions/jiwigo-ws-api/src/main/java/fr/mael/jiwigo/dao/ImageDao.java

@@ -82 +82 @@
     public void addSimple(File file, Integer category, String title) throws JiwigoException;
 
+    /**
+     * Deletes an image
+     * @param image the image to delete
+     * @throws JiwigoException
+     */
+    public boolean delete(Image image) throws JiwigoException;
+
 }

extensions/jiwigo-ws-api/src/main/java/fr/mael/jiwigo/dao/impl/CategoryDaoImpl.java

@@ -116 +116 @@
     public boolean delete(Category category) throws JiwigoException {
         //this document will allow to get pwg_token. it is necessary to delete a category
-        Document docStatus = sessionManager.executeReturnDocument(MethodsEnum.SESSION_STATUS.getLabel());
-        String pwgToken = Tools.getStringValueDom(docStatus.getDocumentElement(), "pwg_token");
-        if (pwgToken.equals("")) {
-            throw new JiwigoException("Error getting pwg_token. Returned document was : "
-                    + Tools.documentToString(docStatus));
+        String pwgToken = sessionManager.getPwgToken();
+        if (pwgToken == null) {
+            throw new JiwigoException("Error : received a null pwg_token");
         }
         if (LOG.isDebugEnabled()) {

extensions/jiwigo-ws-api/src/main/java/fr/mael/jiwigo/dao/impl/ImageDaoImpl.java

@@ -356 +356 @@
     }
 
+    /** 
+     * @see fr.mael.jiwigo.dao.ImageDao#delete(fr.mael.jiwigo.om.Image)
+     */
+    public boolean delete(Image image) throws JiwigoException {
+        //this document will allow to get pwg_token. it is necessary to delete an image
+        String pwgToken = sessionManager.getPwgToken();
+        if (pwgToken == null) {
+            throw new JiwigoException("Error : received a null pwg_token");
+        }
+        if (LOG.isDebugEnabled()) {
+            LOG.debug("Deletes image " + image.getIdentifier() + " with pwg_token = " + pwgToken);
+        }
+
+        Document doc = sessionManager.executeReturnDocument(MethodsEnum.DELETE_IMAGE.getLabel(), "image_id",
+                String.valueOf(image.getIdentifier()), "pwg_token", pwgToken);
+
+        if (LOG.isDebugEnabled()) {
+            LOG.debug(Tools.documentToString(doc));
+        }
+        try {
+            return Tools.checkOk(doc);
+        } catch (FileAlreadyExistsException e) {
+            e.printStackTrace();
+        }
+        return false;
+
+    }
+
     public SessionManager getSessionManager() {
         return sessionManager;
@@ -363 +391 @@
         this.sessionManager = sessionManager;
     }
+
 }

extensions/jiwigo-ws-api/src/main/java/fr/mael/jiwigo/service/ImageService.java

@@ -40 +40 @@
     public boolean create(String filePath, Integer idCategory, Integer originalWidth, Integer originalHeight,
             Double chunckSize, Integer privacyLevel) throws IOException, NoSuchAlgorithmException,
-            FileAlreadyExistsException, ProxyAuthenticationException, WrongChunkSizeException,
-            JiwigoException;
+            FileAlreadyExistsException, ProxyAuthenticationException, WrongChunkSizeException, JiwigoException;
 
     /**
@@ -74 +73 @@
     public void addSimple(File file, Integer category, String title) throws JiwigoException;
 
+    /**
+     * Deletes an image
+     * @param image the image to delete
+     * @throws JiwigoException
+     */
+    public boolean delete(Image image) throws JiwigoException;
+
 }

extensions/jiwigo-ws-api/src/main/java/fr/mael/jiwigo/service/impl/ImageServiceImpl.java

@@ -73 +73 @@
     public boolean create(String filePath, Integer idCategory, Integer originalWidth, Integer originalHeight,
             Double chunckSize, Integer privacyLevel) throws IOException, NoSuchAlgorithmException,
-            FileAlreadyExistsException, ProxyAuthenticationException, WrongChunkSizeException,
-            JiwigoException {
+            FileAlreadyExistsException, ProxyAuthenticationException, WrongChunkSizeException, JiwigoException {
         File originalFile = new File(filePath);
         //get the byte array of the original file, to keep metadata
@@ -151 +150 @@
     }
 
+    public boolean delete(Image image) throws JiwigoException {
+        if (image.getIdentifier() == null) {
+            throw new JiwigoException("The identifier of the image cannot be null");
+        } else {
+            return dao.delete(image);
+        }
+
+    }
+
     public ImageDao getDao() {
         return dao;

extensions/jiwigo-ws-api/src/main/java/fr/mael/jiwigo/transverse/enumeration/MethodsEnum.java

@@ -28 +28 @@
             "pwg.images.setInfo"), SEARCH("pwg.images.search"), SET_PRIVACY_LEVEL("pwg.images.setPrivacyLevel"), ADD_SIMPLE(
             "pwg.images.addSimple"), ADD_IMAGE("pwg.images.add"), ADD_CHUNK("pwg.images.addChunk"), DELETE_CATEGORY(
-            "pwg.categories.delete"), SESSION_STATUS("pwg.session.getStatus");
+            "pwg.categories.delete"), DELETE_IMAGE("pwg.images.delete"), SESSION_STATUS("pwg.session.getStatus");
 
     protected String label;

extensions/jiwigo-ws-api/src/main/java/fr/mael/jiwigo/transverse/session/SessionManager.java

@@ -127 +127 @@
      */
     public InputStream getInputStreamFromUrl(String url) throws Exception;
+
+    /**
+     * This method allows to get pwg_token. This string is necessary
+     * to call web service functions like pwg.images.delete and pwg.categories.delete
+     * @return pwg_token
+     */
+    public String getPwgToken() throws JiwigoException;
+
 }

extensions/jiwigo-ws-api/src/main/java/fr/mael/jiwigo/transverse/session/impl/SessionManagerImpl.java

@@ -266 +266 @@
 
     /**
+     * @see fr.mael.jiwigo.transverse.session.SessionManager#getPwgToken()
+     */
+    public String getPwgToken() throws JiwigoException {
+        Document docStatus = executeReturnDocument(MethodsEnum.SESSION_STATUS.getLabel());
+        String pwgToken = Tools.getStringValueDom(docStatus.getDocumentElement(), "pwg_token");
+        if ("".equals(pwgToken)) {
+            throw new JiwigoException("Error getting pwg_token. Returned document was : "
+                    + Tools.documentToString(docStatus));
+        }
+        return pwgToken;
+    }
+
+    /**
      * @return the login
      */