Package lumis.service.portalmanagement.deployment.moduleeditor

Class ModuleEditorResource

  • @Path("/lum-internal/admin/portal-studio/module/editor")
public class ModuleEditorResource
extends java.lang.Object
    Supports Rest API for module editor.
    Since:
    8.0.0
    Version:
    $Revision$ $Date$

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String areThemeFilesEditable​(java.lang.String moduleId)  
      void createNewDirectory​(java.lang.String moduleId, java.lang.String filePath, java.lang.String dirName)  
      void createNewFile​(java.lang.String moduleId, java.lang.String filePath, java.lang.String fileName)  
      void deleteFile​(java.lang.String moduleId, java.lang.String filePath)  
      javax.ws.rs.core.Response downloadZip​(java.lang.String moduleId, java.lang.String folderPath)  
      javax.ws.rs.core.Response getFile​(java.lang.String moduleId, java.lang.String filePath)  
      java.lang.String getFileText​(java.lang.String moduleId, java.lang.String filePath)  
      java.lang.String getFolderChildren​(java.lang.String moduleId, java.lang.String folderPath)  
      protected IFile getModuleDir​(java.lang.String moduleId)  
      void renameFile​(java.lang.String moduleId, java.lang.String filePath, java.lang.String newFileName)  
      void saveFileText​(java.lang.String moduleId, java.lang.String filePath, java.lang.String fileContent)  
      java.lang.String uploadFile​(java.io.InputStream uploadedInputStream, org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail, java.lang.String moduleId, java.lang.String filePath)  
      java.lang.String uploadZip​(java.io.InputStream uploadedInputStream, org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail, java.lang.String moduleId, java.lang.String filePath)  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • ModuleEditorResource

        public ModuleEditorResource()

    • Method Detail

      • areThemeFilesEditable

        @Path("/aremodulefileseditable")
@GET
@Produces("text/plain")
public java.lang.String areThemeFilesEditable​(@QueryParam("moduleId")
                                              java.lang.String moduleId)
                                       throws PortalException,
                                              java.io.IOException
        Throws:
        PortalException
        java.io.IOException

      • getFolderChildren

        @Path("/getfolderchildren")
@GET
@Produces("text/plain")
public java.lang.String getFolderChildren​(@QueryParam("moduleId")
                                          java.lang.String moduleId,
                                          @QueryParam("folderPath")
                                          java.lang.String folderPath)
                                   throws PortalException,
                                          java.io.IOException
        Throws:
        PortalException
        java.io.IOException

      • getFile

        @Path("/getfile")
@GET
public javax.ws.rs.core.Response getFile​(@QueryParam("moduleId")
                                         java.lang.String moduleId,
                                         @QueryParam("filePath")
                                         java.lang.String filePath)
                                  throws java.io.IOException,
                                         PortalException
        Throws:
        java.io.IOException
        PortalException

      • getFileText

        @Path("/getfiletext")
@GET
@Produces("text/plain")
public java.lang.String getFileText​(@QueryParam("moduleId")
                                    java.lang.String moduleId,
                                    @QueryParam("filePath")
                                    java.lang.String filePath)
                             throws java.io.IOException,
                                    PortalException
        Throws:
        java.io.IOException
        PortalException

      • saveFileText

        @Path("/savefiletext")
@POST
public void saveFileText​(@FormParam("moduleId")
                         java.lang.String moduleId,
                         @FormParam("filePath")
                         java.lang.String filePath,
                         @FormParam("fileContent")
                         java.lang.String fileContent)
                  throws java.io.IOException,
                         PortalException
        Throws:
        java.io.IOException
        PortalException

      • createNewFile

        @Path("/createnewfile")
@POST
public void createNewFile​(@FormParam("moduleId")
                          java.lang.String moduleId,
                          @FormParam("filePath")
                          java.lang.String filePath,
                          @FormParam("fileName")
                          java.lang.String fileName)
                   throws java.io.IOException,
                          PortalException
        Throws:
        java.io.IOException
        PortalException

      • createNewDirectory

        @Path("/createnewdir")
@POST
public void createNewDirectory​(@FormParam("moduleId")
                               java.lang.String moduleId,
                               @FormParam("filePath")
                               java.lang.String filePath,
                               @FormParam("dirName")
                               java.lang.String dirName)
                        throws java.io.IOException,
                               PortalException
        Throws:
        java.io.IOException
        PortalException

      • renameFile

        @Path("/renamefile")
@POST
public void renameFile​(@FormParam("moduleId")
                       java.lang.String moduleId,
                       @FormParam("filePath")
                       java.lang.String filePath,
                       @FormParam("newFileName")
                       java.lang.String newFileName)
                throws java.io.IOException,
                       PortalException
        Throws:
        java.io.IOException
        PortalException

      • deleteFile

        @Path("/deletefile")
@POST
public void deleteFile​(@FormParam("moduleId")
                       java.lang.String moduleId,
                       @FormParam("filePath")
                       java.lang.String filePath)
                throws java.io.IOException,
                       PortalException
        Throws:
        java.io.IOException
        PortalException

      • uploadFile

        @POST
@Path("/uploadfile")
@Consumes("multipart/form-data")
public java.lang.String uploadFile​(java.io.InputStream uploadedInputStream,
                                   org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail,
                                   java.lang.String moduleId,
                                   java.lang.String filePath)
                            throws PortalException,
                                   java.io.IOException
        Throws:
        PortalException
        java.io.IOException

      • uploadZip

        @POST
@Path("/uploadzip")
@Consumes("multipart/form-data")
public java.lang.String uploadZip​(java.io.InputStream uploadedInputStream,
                                  org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail,
                                  java.lang.String moduleId,
                                  java.lang.String filePath)
                           throws PortalException,
                                  java.io.IOException
        Throws:
        PortalException
        java.io.IOException

      • downloadZip

        @Path("/downloadzip")
@GET
@Produces("application/octet-stream")
public javax.ws.rs.core.Response downloadZip​(@QueryParam("moduleId")
                                             java.lang.String moduleId,
                                             @QueryParam("folderPath")
                                             java.lang.String folderPath)
                                      throws java.io.IOException,
                                             PortalException
        Throws:
        java.io.IOException
        PortalException