Interface IServerMethods

  • All Known Implementing Classes:
    ServerMethods

    public interface IServerMethods
    interface provides REST api
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String createLayer​(java.lang.String clientId, java.lang.String layerid)
      creates Layer with layerid as name in html
      java.lang.String createShape​(java.lang.String clientId, java.lang.String type, java.lang.String canvasId, java.lang.String cx, java.lang.String cy, java.lang.String rx, java.lang.String ry, java.lang.String fill, java.lang.String stroke, java.lang.String stroke_width, java.lang.String info_text)
      creates a shape of type-template with all given parameters
      java.lang.String deleteClientData​(java.lang.String ClientId)
      closes Client Data,closes and deletes saved files of Client. should be used to free resources
      java.lang.String deleteShape​(java.lang.String clientId, java.lang.String shapeId)
      deletes shape with shapeid in layerID, returns exception if nothing found
      java.lang.String editShape​(java.lang.String clientId, java.lang.String canvasId, java.lang.String shapeID, java.lang.String cx, java.lang.String cy, java.lang.String rx, java.lang.String ry, java.lang.String fill, java.lang.String stroke, java.lang.String stroke_width, java.lang.String info_text)
      gets shape-type and changes all parameters which are not null, example: if only cx and cy are given for a circle, it knows that circle should only be moved.
      java.util.List<java.lang.String> getColours()
      List with all possible Colours
      java.util.List<java.lang.String> getEditOptions()
      List with all Edit options possible in menue, like changeColour, addStroke, move, delete, create,
      java.lang.String getHtmlCanvas​(java.lang.String clientId)  
      java.util.List<java.lang.String> getLayers​(java.lang.String clientId)
      list with names of all created layers
      java.util.List<java.lang.String> getShapes()
      List with all possible Shapes
      java.util.List<java.lang.String> getShapesOfLayer​(java.lang.String clientId, java.lang.String layerId)
      List with all Shapenames of Layer
      java.lang.String getSVG​(java.lang.String clientId)
      saves active Layers as one svg
      java.lang.String LayerActivition​(java.lang.String clientId, java.lang.Boolean activated, java.lang.String layerId)
      sets Layer active(True) or gets deactivated(false)
      java.lang.String registerClient()
      registers Client, opens new Thread and returns id
      org.springframework.http.ResponseEntity<java.lang.String> test()
      testmethod, can be used to test communication
    • Method Detail

      • test

        org.springframework.http.ResponseEntity<java.lang.String> test()
        testmethod, can be used to test communication
        Returns:
        ResponseEntity mit String Data
      • createShape

        java.lang.String createShape​(java.lang.String clientId,
                                     java.lang.String type,
                                     java.lang.String canvasId,
                                     java.lang.String cx,
                                     java.lang.String cy,
                                     java.lang.String rx,
                                     java.lang.String ry,
                                     java.lang.String fill,
                                     java.lang.String stroke,
                                     java.lang.String stroke_width,
                                     java.lang.String info_text)
        creates a shape of type-template with all given parameters
        Parameters:
        clientId - =id of client
        type - =shape
        canvasId - =Layerid
        cx - =x1-point - Default:Null
        cy - =y1-point - Default:Null
        rx - =radius for circle/x2 point for line/width - not required
        ry - =ry paramater/y2 point for line/height - not required
        fill - =colour to fill shape
        stroke - =stroke colour - not required
        stroke_width - = stroke thickness - not required
        info_text - =text, points, path - not required
        Returns:
        html Doc with new reated Shape
      • createLayer

        java.lang.String createLayer​(java.lang.String clientId,
                                     java.lang.String layerid)
        creates Layer with layerid as name in html
        Parameters:
        clientId - String
        layerid - string id
        Returns:
        info about success
      • registerClient

        java.lang.String registerClient()
        registers Client, opens new Thread and returns id
        Returns:
        Client Id
      • getSVG

        java.lang.String getSVG​(java.lang.String clientId)
        saves active Layers as one svg
        Parameters:
        clientId - String
        Returns:
        String in SVG format
      • editShape

        java.lang.String editShape​(java.lang.String clientId,
                                   java.lang.String canvasId,
                                   java.lang.String shapeID,
                                   java.lang.String cx,
                                   java.lang.String cy,
                                   java.lang.String rx,
                                   java.lang.String ry,
                                   java.lang.String fill,
                                   java.lang.String stroke,
                                   java.lang.String stroke_width,
                                   java.lang.String info_text)
        gets shape-type and changes all parameters which are not null, example: if only cx and cy are given for a circle, it knows that circle should only be moved.
        Parameters:
        clientId - string clientid
        canvasId - =Layerid
        shapeID - =Name of Layer, given by user
        cx - =x1-point - Default:Null
        cy - =y1-point - Default:Null
        rx - =radius for circle/x2 point for line - Default:Null
        ry - =ry paramater/y2 point for line - Default:Null
        fill - =colour - Default:Null
        stroke - =stroke colour - Default:Null
        stroke_width - =number of stroke thickness
        info_text - =text, points, path
        Returns:
        html Doc of Canvas with edited Shape
      • getLayers

        java.util.List<java.lang.String> getLayers​(java.lang.String clientId)
        list with names of all created layers
        Parameters:
        clientId - string clientid
        Returns:
        String List with all LayerIds
      • getShapesOfLayer

        java.util.List<java.lang.String> getShapesOfLayer​(java.lang.String clientId,
                                                          java.lang.String layerId)
        List with all Shapenames of Layer
        Parameters:
        clientId - string clientid
        layerId - string clientid
        Returns:
        String List with all Shape ids of a specified Layer
      • getColours

        java.util.List<java.lang.String> getColours()
        List with all possible Colours
        Returns:
        String List with Colours
      • getShapes

        java.util.List<java.lang.String> getShapes()
        List with all possible Shapes
        Returns:
        String List with shapes. eg. rectangular, circle
      • getEditOptions

        java.util.List<java.lang.String> getEditOptions()
        List with all Edit options possible in menue, like changeColour, addStroke, move, delete, create,
        Returns:
        String List with options. e.g. create,delete etc
      • deleteShape

        java.lang.String deleteShape​(java.lang.String clientId,
                                     java.lang.String shapeId)
        deletes shape with shapeid in layerID, returns exception if nothing found
        Parameters:
        clientId - String
        shapeId - String
        Returns:
        String with message about success
      • deleteClientData

        java.lang.String deleteClientData​(java.lang.String ClientId)
        closes Client Data,closes and deletes saved files of Client. should be used to free resources
        Parameters:
        ClientId - string clientid
        Returns:
        String with message about success
      • LayerActivition

        java.lang.String LayerActivition​(java.lang.String clientId,
                                         java.lang.Boolean activated,
                                         java.lang.String layerId)
        sets Layer active(True) or gets deactivated(false)
        Parameters:
        clientId - String
        activated - boolean
        layerId - String
        Returns:
        String with message about success
      • getHtmlCanvas

        java.lang.String getHtmlCanvas​(java.lang.String clientId)
        Parameters:
        clientId - string clientid
        Returns:
        Html Doc of Layers