|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.elpical.jclaro.inspector.ws.server.IspImpl
@MTOM @BindingType(value="http://java.sun.com/xml/ns/jaxws/2003/05/soap/bindings/HTTP/") public class IspImpl
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 | |
---|---|
IspImpl()
IspImpl should be instanced with IspImplService (see snippet above) |
Method Summary | |
---|---|
void |
addClientID(int clientid)
adds an id for the client |
void |
deleteConfiguration(java.lang.String name)
deletes a configuration (For internal use only) |
java.lang.String |
getCauseMessage(int id)
gets the cause messsage |
java.lang.String |
getChannelName(int id)
gets the channelname |
java.util.ArrayList |
getChannelNames()
retrieves the installed channels |
java.util.ArrayList |
getChannelNamesWithGroupNames()
retrieves the installed channels with their groupnames |
java.util.ArrayList |
getClaroServers()
returns number of available Claro servers in multiserver operation returns null if multiserver operation has not been configured For internal usage only! |
java.util.ArrayList |
getConfigurationNames()
retrieves all the names of the configurations, which are previously saved (For internal use only) |
int[] |
getCropInfo(int id)
returns cropdata (For internal use only) |
java.lang.String |
getDCData(int id,
java.lang.String name)
returns the DC data (For internal use only) |
int |
getEpsEncoding(int id)
returns the output EPS encoding, in case the output format is EPS (For internal use only) |
int |
getEpsPreview(int id)
returns the output EPS preview, in case the output format is EPS (For internal use only) |
java.util.ArrayList |
getExtraDataColumns()
retrieves a list of extra data columns for Inspector For internal usage only! |
java.lang.String |
getImageName(int id)
gets the imagename |
java.lang.String |
getInUseByUser(int id)
returns the name of user which has the image in use |
java.lang.String |
getIPTCData(int id,
int recordNo,
int datasetNo)
returns the IPTC data (For internal use only) |
float |
getJpegCompression(int id)
returns the output jpeg compression |
java.lang.String |
getLogInfo(int id)
gets the log info |
javax.activation.DataHandler |
getOriginalFile(int id)
retrieves the original image file |
java.lang.String |
getOriginalFileName(int id)
gets the original image filename |
java.lang.String |
getOutfileformat(int id)
returns the output file format (For internal use only) |
java.lang.String |
getPageNr(int id)
returns the pagenumber of the image in the Pdf (For internal use only) |
int |
getPdfImage(int id)
returns the pdfimage (For internal use only) |
javax.activation.DataHandler |
getPreviewFile(int id)
retrieves the preview image file |
java.lang.String |
getPreviewFileName(int id)
gets the preview image filename |
javax.activation.DataHandler |
getProcessedFile(int id)
retrieves the processed image file |
java.lang.String |
getProcessedFileName(int id)
gets the processed image filename |
javax.activation.DataHandler |
getProperties()
retrieves inspector properties (For internal use only) |
java.util.ArrayList |
getQueue(int clientid,
java.util.ArrayList channelNames)
retrieves a list of image id's for all available images which should be inspected |
java.util.ArrayList |
getQueueInUse()
retrieves a list of id's for all images which are in use by other users |
java.util.ArrayList |
getQueueSentBack()
retrieves a list of id's for all images which are sent back by other users |
java.lang.String |
getReleaseDate(int id)
returns the releasedate of the image (For internal use only) |
java.lang.String |
getSentBackByUser(int id)
returns the name of user which has sent back the image |
java.lang.String |
getServerVersion()
retrieves the server version |
java.lang.String |
getXMPData(int id,
java.lang.String field)
returns the XMP data (For internal use only) |
boolean |
isImageIdAvailable(int id)
checks if there is an image is really available for download |
boolean |
isInUse(int id)
determines if the image is in use by another user |
boolean |
isJobInfoPresent(int id)
return if job information is present (For internal use only) |
boolean |
isPdfImage(int id)
return if image is a pdf image (For internal use only) |
boolean |
isQueueUpdateAvailable(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(int id)
determines if the image is sent back by another user |
byte[] |
openConfigurations(java.lang.String name)
opens a previously saved configuration (For internal use only) |
void |
removeClientID(int clientid)
removes an id |
void |
saveConfigurations(java.lang.String name,
byte[] data)
saves a configuration (For internal use only) |
void |
setCurfileformat(int id,
java.lang.String curfileformat)
sets the current file format (For internal use only) |
void |
setInspectedEditingTime(int id,
long set)
set the Editing time |
void |
setInUse(int id,
boolean set)
sets the image is in use |
void |
setInUseByUser(int id,
java.lang.String set)
sets the image is in use by user if this method is used no further call to setInUse() is necessary |
void |
setOriginalFile(int id,
javax.activation.DataHandler imgdata)
sets the original image file as the inspected file |
void |
setProcessedFile(int id,
javax.activation.DataHandler imgdata)
sets the processed image file as the inspected file |
void |
setSentBack(int id,
boolean set)
sets the image as sent back |
void |
setSentBackByUser(int id,
java.lang.String set)
sets the image as sent back by user if this method is used no further call to setSentBack() is necessary |
boolean |
testConnection()
Checks the server connection, if failed throws an exception |
void |
useInspectedFileNone(int id,
java.lang.String username)
use no file as the inspected file |
void |
useInspectedFileOriginal(int id,
java.lang.String username)
use the original file as the inspected file |
void |
useInspectedFileProcessed(int id,
java.lang.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 Detail |
---|
public IspImpl()
Method Detail |
---|
public boolean testConnection()
java.lang.Exception
public java.lang.String getServerVersion()
java.lang.Exception
public java.util.ArrayList getChannelNames()
java.lang.Exception
public java.util.ArrayList getChannelNamesWithGroupNames()
java.lang.Exception
public java.util.ArrayList getConfigurationNames()
java.lang.Exception
public byte[] openConfigurations(java.lang.String name) throws java.lang.Exception
name
- The configuration file name to be opened
java.lang.Exception
public void saveConfigurations(java.lang.String name, byte[] data) throws java.io.IOException
name
- The configuration file name to be openeddata
- the configuration as a byte array
java.lang.Exception
java.io.IOException
public void deleteConfiguration(java.lang.String name)
name
- The configuration file name to be deleted
java.lang.Exception
public javax.activation.DataHandler getProperties()
java.lang.Exception
public java.util.ArrayList getQueue(int clientid, java.util.ArrayList channelNames)
clientid
- channelNames
- list of channelnames which are related to the images
java.lang.Exception
public java.util.ArrayList getQueueInUse()
java.lang.Exception
public java.util.ArrayList getQueueSentBack()
java.lang.Exception
public void addClientID(int clientid)
clientid
-
java.lang.Exception
public void removeClientID(int clientid)
clientid
-
java.lang.Exception
public boolean isQueueUpdateAvailable(int clientid)
clientid
-
java.lang.Exception
public boolean isImageIdAvailable(int id)
id
- the related image id
java.lang.Exception
public javax.activation.DataHandler getOriginalFile(int id)
id
- the related image id
javax.xml.ws.WebServiceException
public void setOriginalFile(int id, javax.activation.DataHandler imgdata)
id
- the related image idimgdata
- DataHandler for the original image file
javax.xml.ws.WebServiceException
public java.lang.String getOriginalFileName(int id)
id
- the related image id
javax.xml.ws.WebServiceException
public javax.activation.DataHandler getProcessedFile(int id)
id
- the related image id
javax.xml.ws.WebServiceException
public void setProcessedFile(int id, javax.activation.DataHandler imgdata)
id
- the related image idimgdata
- DataHandler for the processed image file
javax.xml.ws.WebServiceException
public java.lang.String getProcessedFileName(int id)
id
- the related image id
javax.xml.ws.WebServiceException
public javax.activation.DataHandler getPreviewFile(int id)
id
- the related image id
javax.xml.ws.WebServiceException
public void useInspectedFileProcessed(int id, java.lang.String username)
id
- the related image idusername
- name of the user which inspected the file
javax.xml.ws.WebServiceException
public void useInspectedFileOriginal(int id, java.lang.String username)
id
- the related image idusername
- name of the user which inspected the file
javax.xml.ws.WebServiceException
public void useInspectedFileNone(int id, java.lang.String username)
id
- the related image idusername
- name of the user which inspected the file
javax.xml.ws.WebServiceException
public java.lang.String getPreviewFileName(int id)
id
- the related image id
javax.xml.ws.WebServiceException
public java.lang.String getChannelName(int id)
id
- the related image id
javax.xml.ws.WebServiceException
public java.lang.String getImageName(int id)
id
- the related image id
javax.xml.ws.WebServiceException
public java.lang.String getCauseMessage(int id)
id
- the related image id
javax.xml.ws.WebServiceException
public java.lang.String getLogInfo(int id)
id
- the related image id
javax.xml.ws.WebServiceException
public void setInUse(int id, boolean set)
id
- the related image id
javax.xml.ws.WebServiceException
public void setInUseByUser(int id, java.lang.String set)
id
- the related image idset
-
javax.xml.ws.WebServiceException
public boolean isInUse(int id)
id
- the related image id
javax.xml.ws.WebServiceException
public java.lang.String getInUseByUser(int id)
id
- the related image id
javax.xml.ws.WebServiceException
public void setSentBack(int id, boolean set)
id
- the related image id
javax.xml.ws.WebServiceException
public void setSentBackByUser(int id, java.lang.String set)
id
- the related image idset
-
javax.xml.ws.WebServiceException
public boolean isSentBack(int id)
id
- the related image id
javax.xml.ws.WebServiceException
public java.lang.String getSentBackByUser(int id)
id
- the related image id
javax.xml.ws.WebServiceException
public java.lang.String getIPTCData(int id, int recordNo, int datasetNo)
id
- the related image idrecordNo
- datasetNo
-
javax.xml.ws.WebServiceException
public java.lang.String getXMPData(int id, java.lang.String field)
id
- the related image idfield
-
javax.xml.ws.WebServiceException
public boolean isPdfImage(int id)
id
- the related image id
javax.xml.ws.WebServiceException
public java.lang.String getDCData(int id, java.lang.String name)
id
- the related image idname
-
javax.xml.ws.WebServiceException
public boolean isJobInfoPresent(int id)
id
- the related image id
javax.xml.ws.WebServiceException
public int[] getCropInfo(int id)
id
- the related image id
javax.xml.ws.WebServiceException
public java.lang.String getOutfileformat(int id)
id
- the related image id
javax.xml.ws.WebServiceException
public float getJpegCompression(int id)
id
- the related image id
javax.xml.ws.WebServiceException
public int getEpsEncoding(int id)
id
- the related image id
javax.xml.ws.WebServiceException
public int getEpsPreview(int id)
id
- the related image id
javax.xml.ws.WebServiceException
public java.lang.String getPageNr(int id)
id
- the related image id
javax.xml.ws.WebServiceException
public java.lang.String getReleaseDate(int id)
id
- the related image id
javax.xml.ws.WebServiceException
public int getPdfImage(int id)
id
- the related image id
javax.xml.ws.WebServiceException
public void setCurfileformat(int id, java.lang.String curfileformat)
id
- the related image idcurfileformat
- : TIFF,JPEG,EPS,PSD,PNG,GIF
javax.xml.ws.WebServiceException
public java.util.ArrayList getExtraDataColumns()
java.lang.Exception
public java.util.ArrayList getClaroServers()
java.lang.Exception
public void setInspectedEditingTime(int id, long set)
id
- the related image idEditing
- time (in ms)
This is the period used for editing
javax.xml.ws.WebServiceException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |