java.lang.Object
com.elpical.jclaro.inspector.ws.server.IspImpl

@MTOM @BindingType("http://www.w3.org/2003/05/soap/bindings/HTTP/?mtom=true") public class IspImpl extends Object
This Webservices interface contains the methods for accessing Claro Inspector.
The interface is published by JAX-WS RI with : http://<hostname>:<port>/jclaroinspectorjaxws/job?wsdl

if you use Java, you can use the following code snippet:

        import com.elpical.jclaro.inspector.ws.client.IspImpl;
        import com.elpical.jclaro.inspector.ws.client.IspImplService;
     
        URL baseUrl = com.elpical.jclaro.inspector.ws.client.IspImplService.class.getResource(".");
        URL url = new URL(baseUrl, "http://"+hostname+":"+portnumber+"/jclaroinspectorjaxws/job?wsdl");
        IspImplService anis = new IspImplService(url, new QName("http://server.ws.inspector.jclaro.elpical.com/", "IspImplService"));
        IspImpl port;
        if (asMTOM)
                port = anis.getIspImplPort(new MTOMFeature(true,8000));
        else
                port = anis.getIspImplPort();
 

The package is included in ClaroInspector-<version>.jar (in the jclaroui/jclaro/inspector/lib folder of the Claro installation)

After obtaining a valid port, the first thing to do is setting a ClientID, by calling setClientID().
The ID is only needed for optimization reasons on the server and must be used with isQueueUpdateAvailable() and getQueue() The ID can be a randomly retrieved integer and is valid during the session of the client

All Available Claro channels can be retrieved with getChannelNames().

The files from Claro can be retrieved with getProcessedFile() and getOriginalFile()
If a file is in use on the client side, setInUseByUser() must be called.
If the file is not in use anymore, setInUse(id,false) must be called.

If a file is changed on the client side, setOriginalFile() or setProcessedFile() must be called.
After a file is approved on the client side, useInspectedFileOriginal() or useInspectedFileProcessed() must be called.
If a file is rejected on the clientside, useInspectedFileNone must be called.
The useInspectedFileOriginal(),useInspectedFileProcessed() or useInspectedFileNone() methods will remove the image from the inspector queue.

The fileformat may not be changed on the client side (featured only for internal use)

Optionally a preview image can be downloaded

An example of the client implementation : InspectorWebservices_example.java (see folder examples_integration if the Claro installation)

  • Constructor Summary

    Constructors
    Constructor
    Description
    IspImpl should be instanced with IspImplService (see snippet above)
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addClientID​(byte[] userToken, int clientid)
    adds an id for the client
    void
    deleteConfiguration​(byte[] userToken, String name)
    deletes a configuration (For internal use only)
    List<com.elpical.jclaro.inspector.ws.server.Account>
    getAccounts​(byte[] userToken)
    Returns a list of Accounts registered in Claro.
    getCauseMessage​(byte[] userToken, int id)
    gets the cause messsage
     
    getChannelName​(byte[] userToken, int id)
    gets the channelname
    getChannelNames​(byte[] userToken)
    retrieves the installed channels
    getChannelNamesForType​(byte[] userToken, int type)
    retrieves the installed channels for the specified type (1 = Processing, 2 = Routing, 3 = Device Link, 4 = Purging, 5 = Cropping)
    getChannelNamesWithGroupNames​(byte[] userToken)
    retrieves the installed channels with their groupnames
    getClaroBackupServers​(byte[] userToken)
    JFR 19-okt-2015: Ticket 1154: Added this method, so that clients can get a list of backup Claro servers.
    getClaroServers​(byte[] userToken)
    returns number of available Claro servers in multiserver operation returns null if multiserver operation has not been configured For internal usage only!
    getConfigurationNames​(byte[] userToken)
    retrieves all the names of the configurations, which are previously saved (For internal use only)
    int[]
    getCropInfo​(byte[] userToken, int id)
    returns cropdata (For internal use only)
    getDCData​(byte[] userToken, int id, String name)
    returns the DC data (For internal use only)
    int
    getEpsEncoding​(byte[] userToken, int id)
    returns the output EPS encoding, in case the output format is EPS (For internal use only)
    int
    getEpsPreview​(byte[] userToken, int id)
    returns the output EPS preview, in case the output format is EPS (For internal use only)
    getExtraDataColumns​(byte[] userToken)
    retrieves a list of extra data columns for Inspector For internal usage only!
     
    getImageName​(byte[] userToken, int id)
    gets the imagename
    com.elpical.jclaro.inspector.ws.server.InspectorObject
    getInspectorObject​(byte[] userToken, int id)
     
    getInUseByUser​(byte[] userToken, int id)
    returns the name of user which has the image in use
    getIPTCData​(byte[] userToken, int id, int recordNo, int datasetNo)
    returns the IPTC data (For internal use only)
    float
    getJpegCompression​(byte[] userToken, int id)
    returns the output jpeg compression
    getLogInfo​(byte[] userToken, int id)
    gets the log info
    javax.activation.DataHandler
    getOriginalFile​(byte[] userToken, int id)
     
    getOriginalFileName​(byte[] userToken, int id)
    gets the original image filename
    getOutfileformat​(byte[] userToken, int id)
    returns the output file format (For internal use only)
    getPageNr​(byte[] userToken, int id)
    returns the pagenumber of the image in the Pdf (For internal use only)
    int
    getPdfImage​(byte[] userToken, int id)
    returns the pdfimage (For internal use only)
    javax.activation.DataHandler
    getPreviewFile​(byte[] userToken, int id)
    retrieves the preview image file
    getPreviewFileName​(byte[] userToken, int id)
    gets the preview image filename
    javax.activation.DataHandler
    getProcessedFile​(byte[] userToken, int id)
    retrieves the processed image file
    javax.activation.DataHandler
    getProcessedFileEx​(byte[] userToken, int id, boolean applyFRD)
    retrieves the processed image file
    getProcessedFileName​(byte[] userToken, int id)
    gets the processed image filename
    javax.activation.DataHandler
    getProperties​(byte[] userToken)
    retrieves inspector properties (For internal use only)
    getQueue​(byte[] userToken, int clientid, ArrayList<String> channelNames)
    retrieves a list of image id's for all available images which should be inspected
    getQueueInUse​(byte[] userToken)
    retrieves a list of id's for all images which are in use by other users
    getQueueSentBack​(byte[] userToken)
    retrieves a list of id's for all images which are sent back by other users
    getReleaseDate​(byte[] userToken, int id)
    returns the releasedate of the image (For internal use only)
    getSentBackByUser​(byte[] userToken, int id)
    returns the name of user which has sent back the image
    getServerVersion​(byte[] userToken)
    retrieves the server version
    getXMPData​(byte[] userToken, int id, String field)
    returns the XMP data (For internal use only)
    static boolean
     
    boolean
    isImageIdAvailable​(byte[] userToken, int id)
    checks if there is an image is really available for download
    boolean
    isInUse​(byte[] userToken, int id)
    determines if the image is in use by another user
    boolean
    isJobInfoPresent​(byte[] userToken, int id)
    return if job information is present (For internal use only)
    boolean
    isPdfImage​(byte[] userToken, int id)
    return if image is a pdf image (For internal use only)
    boolean
    isQueueUpdateAvailable​(byte[] userToken, int clientid)
    checks if there is a queue update available for the related client id After the method getQueue() is called, the update flag will be reset
    boolean
    isSentBack​(byte[] userToken, int id)
    determines if the image is sent back by another user
    com.elpical.jclaro.inspector.ws.server.Account
    login​(String name, String password)
    Logs the user in with the supplied name.
    byte[]
    openConfigurations​(byte[] userToken, String name)
    opens a previously saved configuration (For internal use only)
    void
    removeClientID​(byte[] userToken, int clientid)
    removes an id
    void
    saveConfigurations​(byte[] userToken, String name, byte[] data)
    saves a configuration (For internal use only)
    void
    setCurfileformat​(byte[] userToken, int id, String curfileformat)
    sets the current file format (For internal use only)
    void
    setInspectedEditingTime​(byte[] userToken, int id, long set)
    set the Editing time
    void
    setInUse​(byte[] userToken, int id, boolean set)
    sets the image is in use
    void
    setInUseByUser​(byte[] userToken, int id, String set)
    sets the image is in use by user if this method is used no further call to setInUse() is necessary
    void
    setOriginalFile​(byte[] userToken, int id, javax.activation.DataHandler imgdata)
    sets the original image file as the inspected file
    void
    setProcessedFile​(byte[] userToken, int id, javax.activation.DataHandler imgdata)
    sets the processed image file as the inspected file
    void
    setSentBack​(byte[] userToken, int id, boolean set)
    sets the image as sent back
    void
    setSentBackByUser​(byte[] userToken, int id, String set)
    sets the image as sent back by user if this method is used no further call to setSentBack() is necessary
    boolean
    Checks the server connection, if failed throws an exception
    void
    useInspectedFileNone​(byte[] userToken, int id, String username)
    use no file as the inspected file
    void
    useInspectedFileOriginal​(byte[] userToken, int id, String username)
    use the original file as the inspected file
    void
    useInspectedFileProcessed​(byte[] userToken, int id, String username)
    use the processed file as the inspected file

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details

    • IspImpl

      public IspImpl()
      IspImpl should be instanced with IspImplService (see snippet above)
  • Method Details

    • login

      public com.elpical.jclaro.inspector.ws.server.Account login(String name, String password)
      Logs the user in with the supplied name. Returns an Account object containing the unique login-token needed in most methods to be able to check the login of the user. The login-token stays valid for 20 minutes after it's last use.
      Parameters:
      name - The name of the user
      password - The password of the user
      See Also:
      Description with example
    • getAccounts

      public List<com.elpical.jclaro.inspector.ws.server.Account> getAccounts(byte[] userToken) throws com.elpical.jclaro.inspector.ws.server.LoginException, com.elpical.jclaro.inspector.ws.server.PrivilegeException
      Returns a list of Accounts registered in Claro.
      Parameters:
      userToken - The unique login-token of a user with privileges to view Account information
      Returns:
      List of Accounts registered in Claro.
      Throws:
      com.elpical.jclaro.inspector.ws.server.LoginException - If no user with this login-token is found or the token is expired (20 minutes after last activity).
      com.elpical.jclaro.inspector.ws.server.PrivilegeException - User has no privileges to see Account information.
      See Also:
      Account.getAccountPrivileges()
    • testConnection

      public boolean testConnection() throws Exception
      Checks the server connection, if failed throws an exception
      Returns:
      true if connected to the server
      Throws:
      Exception
    • getServerVersion

      public String getServerVersion(byte[] userToken) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      retrieves the server version
      Returns:
      server version
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • getChannelNames

      public ArrayList<String> getChannelNames(byte[] userToken) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      retrieves the installed channels
      Returns:
      all installed channels
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • getChannelNamesForType

      public ArrayList<String> getChannelNamesForType(byte[] userToken, int type) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      retrieves the installed channels for the specified type (1 = Processing, 2 = Routing, 3 = Device Link, 4 = Purging, 5 = Cropping)
      Returns:
      all installed channels for the specified type
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • getChannelNamesWithGroupNames

      public ArrayList<String> getChannelNamesWithGroupNames(byte[] userToken) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      retrieves the installed channels with their groupnames
      Returns:
      all installed channels : first name is channelname second name is groupname, if no group exists an empty string is filled in if a password exists for the group, the groupname is extended with %$#password
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • getCERTName

      public String getCERTName()
    • getHTTPSKeystorePath

      public String getHTTPSKeystorePath()
    • getConfigurationNames

      public ArrayList<String> getConfigurationNames(byte[] userToken) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      retrieves all the names of the configurations, which are previously saved (For internal use only)
      Returns:
      configuration names
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • openConfigurations

      public byte[] openConfigurations(byte[] userToken, String name) throws Exception
      opens a previously saved configuration (For internal use only)
      Parameters:
      name - The configuration file name to be opened
      Returns:
      the configuration as a byte array
      Throws:
      Exception
    • saveConfigurations

      public void saveConfigurations(byte[] userToken, String name, byte[] data) throws IOException, com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      saves a configuration (For internal use only)
      Parameters:
      name - The configuration file name to be opened
      data - the configuration as a byte array
      Throws:
      IOException
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • deleteConfiguration

      public void deleteConfiguration(byte[] userToken, String name) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      deletes a configuration (For internal use only)
      Parameters:
      name - The configuration file name to be deleted
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • getProperties

      public javax.activation.DataHandler getProperties(byte[] userToken) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      retrieves inspector properties (For internal use only)
      Returns:
      DataHandler for the returned file
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • getQueue

      public ArrayList<Integer> getQueue(byte[] userToken, int clientid, ArrayList<String> channelNames) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      retrieves a list of image id's for all available images which should be inspected
      Parameters:
      channelNames - list of channelnames which are related to the images
      Returns:
      list of id's
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • getQueueInUse

      public ArrayList<Integer> getQueueInUse(byte[] userToken) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      retrieves a list of id's for all images which are in use by other users
      Returns:
      list of id's
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
      See Also:
      setInUse(byte[], int, boolean)
    • getQueueSentBack

      public ArrayList<Integer> getQueueSentBack(byte[] userToken) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      retrieves a list of id's for all images which are sent back by other users
      Returns:
      list of id's
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
      See Also:
      setSentBack(byte[], int, boolean)
    • addClientID

      public void addClientID(byte[] userToken, int clientid) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      adds an id for the client
      Parameters:
      clientid -
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • removeClientID

      public void removeClientID(byte[] userToken, int clientid) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      removes an id
      Parameters:
      clientid -
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • isQueueUpdateAvailable

      public boolean isQueueUpdateAvailable(byte[] userToken, int clientid) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      checks if there is a queue update available for the related client id After the method getQueue() is called, the update flag will be reset
      Returns:
      true if update available otherwise false
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • isImageIdAvailable

      public boolean isImageIdAvailable(byte[] userToken, int id) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      checks if there is an image is really available for download
      Parameters:
      id - the related image id
      Returns:
      true if the id is in the queue otherwise false
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • getOriginalFile

      public javax.activation.DataHandler getOriginalFile(byte[] userToken, int id) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • setOriginalFile

      public void setOriginalFile(byte[] userToken, int id, javax.activation.DataHandler imgdata) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      sets the original image file as the inspected file
      Parameters:
      id - the related image id
      imgdata - DataHandler for the original image file
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • getOriginalFileName

      public String getOriginalFileName(byte[] userToken, int id) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      gets the original image filename
      Parameters:
      id - the related image id
      Returns:
      the original image filename
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • getProcessedFile

      public javax.activation.DataHandler getProcessedFile(byte[] userToken, int id) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      retrieves the processed image file
      Parameters:
      id - the related image id
      Returns:
      DataHandler for the processed image file if the datahandler can not be generated, an exception is thrown
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • getProcessedFileEx

      public javax.activation.DataHandler getProcessedFileEx(byte[] userToken, int id, boolean applyFRD) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      retrieves the processed image file

      Parameters:
      id - the related image id
      applyFRD - whether or not to apply FileReadyDelay.

      Returns:
      DataHandler for the processed image file if the datahandler can not be generated, an exception is thrown
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • setProcessedFile

      public void setProcessedFile(byte[] userToken, int id, javax.activation.DataHandler imgdata) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      sets the processed image file as the inspected file
      Parameters:
      id - the related image id
      imgdata - DataHandler for the processed image file
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • getProcessedFileName

      public String getProcessedFileName(byte[] userToken, int id) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      gets the processed image filename
      Parameters:
      id - the related image id
      Returns:
      the processed image filename
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • getPreviewFile

      public javax.activation.DataHandler getPreviewFile(byte[] userToken, int id) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      retrieves the preview image file
      Parameters:
      id - the related image id
      Returns:
      DataHandler for the preview image file if the datahandler can not be generated, an exception is thrown
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • useInspectedFileProcessed

      public void useInspectedFileProcessed(byte[] userToken, int id, String username) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      use the processed file as the inspected file
      Parameters:
      id - the related image id
      username - name of the user which inspected the file
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • useInspectedFileOriginal

      public void useInspectedFileOriginal(byte[] userToken, int id, String username) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      use the original file as the inspected file
      Parameters:
      id - the related image id
      username - name of the user which inspected the file
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • useInspectedFileNone

      public void useInspectedFileNone(byte[] userToken, int id, String username) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      use no file as the inspected file
      Parameters:
      id - the related image id
      username - name of the user which inspected the file
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • getPreviewFileName

      public String getPreviewFileName(byte[] userToken, int id) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      gets the preview image filename
      Parameters:
      id - the related image id
      Returns:
      the preview image filename
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • getChannelName

      public String getChannelName(byte[] userToken, int id) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      gets the channelname
      Parameters:
      id - the related image id
      Returns:
      string
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • getImageName

      public String getImageName(byte[] userToken, int id) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      gets the imagename
      Parameters:
      id - the related image id
      Returns:
      string
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • getCauseMessage

      public String getCauseMessage(byte[] userToken, int id) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      gets the cause messsage
      Parameters:
      id - the related image id
      Returns:
      string
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • getLogInfo

      public String getLogInfo(byte[] userToken, int id) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      gets the log info
      Parameters:
      id - the related image id
      Returns:
      string
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • setInUse

      public void setInUse(byte[] userToken, int id, boolean set) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      sets the image is in use
      Parameters:
      id - the related image id
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • setInUseByUser

      public void setInUseByUser(byte[] userToken, int id, String set) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      sets the image is in use by user if this method is used no further call to setInUse() is necessary
      Parameters:
      id - the related image id
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • isInUse

      public boolean isInUse(byte[] userToken, int id) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      determines if the image is in use by another user
      Parameters:
      id - the related image id
      Returns:
      true if in use otherwise false
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • getInUseByUser

      public String getInUseByUser(byte[] userToken, int id) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      returns the name of user which has the image in use
      Parameters:
      id - the related image id
      Returns:
      the username or null if no user has the image in use
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • setSentBack

      public void setSentBack(byte[] userToken, int id, boolean set) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      sets the image as sent back
      Parameters:
      id - the related image id
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • setSentBackByUser

      public void setSentBackByUser(byte[] userToken, int id, String set) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      sets the image as sent back by user if this method is used no further call to setSentBack() is necessary
      Parameters:
      id - the related image id
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • isSentBack

      public boolean isSentBack(byte[] userToken, int id) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      determines if the image is sent back by another user
      Parameters:
      id - the related image id
      Returns:
      true if in use otherwise false
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • getSentBackByUser

      public String getSentBackByUser(byte[] userToken, int id) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      returns the name of user which has sent back the image
      Parameters:
      id - the related image id
      Returns:
      the username or null if no user has sent back the image
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • getIPTCData

      public String getIPTCData(byte[] userToken, int id, int recordNo, int datasetNo) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      returns the IPTC data (For internal use only)
      Parameters:
      id - the related image id
      Returns:
      the related IPTC data or empty string if no data is there
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • getXMPData

      public String getXMPData(byte[] userToken, int id, String field) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      returns the XMP data (For internal use only)
      Parameters:
      id - the related image id
      Returns:
      the related XMP data or empty string if no data is there
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • isPdfImage

      public boolean isPdfImage(byte[] userToken, int id) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      return if image is a pdf image (For internal use only)
      Parameters:
      id - the related image id
      Returns:
      true if pdf otherwise false
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • getDCData

      public String getDCData(byte[] userToken, int id, String name) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      returns the DC data (For internal use only)
      Parameters:
      id - the related image id
      Returns:
      the related DC data or empty string if no data is there
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • isJobInfoPresent

      public boolean isJobInfoPresent(byte[] userToken, int id) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      return if job information is present (For internal use only)
      Parameters:
      id - the related image id
      Returns:
      true if pdf otherwise false
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • getCropInfo

      public int[] getCropInfo(byte[] userToken, int id) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      returns cropdata (For internal use only)
      Parameters:
      id - the related image id
      Returns:
      cropframe
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • getOutfileformat

      public String getOutfileformat(byte[] userToken, int id) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      returns the output file format (For internal use only)
      Parameters:
      id - the related image id
      Returns:
      JPEG,TIFF,EPS,PSD
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • getJpegCompression

      public float getJpegCompression(byte[] userToken, int id) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      returns the output jpeg compression
      Parameters:
      id - the related image id
      Returns:
      0..1
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • getEpsEncoding

      public int getEpsEncoding(byte[] userToken, int id) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      returns the output EPS encoding, in case the output format is EPS (For internal use only)
      Parameters:
      id - the related image id
      Returns:
      integer
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • getEpsPreview

      public int getEpsPreview(byte[] userToken, int id) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      returns the output EPS preview, in case the output format is EPS (For internal use only)
      Parameters:
      id - the related image id
      Returns:
      integer
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • getPageNr

      public String getPageNr(byte[] userToken, int id) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      returns the pagenumber of the image in the Pdf (For internal use only)
      Parameters:
      id - the related image id
      Returns:
      string
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • getReleaseDate

      public String getReleaseDate(byte[] userToken, int id) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      returns the releasedate of the image (For internal use only)
      Parameters:
      id - the related image id
      Returns:
      string
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • getPdfImage

      public int getPdfImage(byte[] userToken, int id) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      returns the pdfimage (For internal use only)
      Parameters:
      id - the related image id
      Returns:
      integer
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • setCurfileformat

      public void setCurfileformat(byte[] userToken, int id, String curfileformat) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      sets the current file format (For internal use only)
      Parameters:
      id - the related image id
      curfileformat - : TIFF,JPEG,EPS,PSD,PNG,GIF
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • getExtraDataColumns

      public ArrayList<String> getExtraDataColumns(byte[] userToken) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      retrieves a list of extra data columns for Inspector For internal usage only!
      Returns:
      list of extra columns
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • getClaroServers

      public ArrayList<String> getClaroServers(byte[] userToken) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      returns number of available Claro servers in multiserver operation returns null if multiserver operation has not been configured For internal usage only!
      Returns:
      list of servers
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • getClaroBackupServers

      public ArrayList<String> getClaroBackupServers(byte[] userToken) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      JFR 19-okt-2015: Ticket 1154: Added this method, so that clients can get a list of backup Claro servers. returns number of available backup Claro servers in multiserver operation returns null if multiserver operation has not been configured For internal usage only!
      Returns:
      list of backup servers
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • setInspectedEditingTime

      public void setInspectedEditingTime(byte[] userToken, int id, long set) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      set the Editing time
      Parameters:
      id - the related image id
      set - time (in ms) This is the period used for editing
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • getInspectorObject

      public com.elpical.jclaro.inspector.ws.server.InspectorObject getInspectorObject(byte[] userToken, int id) throws com.elpical.jclaro.inspector.ws.server.PrivilegeException, com.elpical.jclaro.inspector.ws.server.LoginException
      Throws:
      com.elpical.jclaro.inspector.ws.server.PrivilegeException
      com.elpical.jclaro.inspector.ws.server.LoginException
    • isCaaSVersion

      public static boolean isCaaSVersion()