|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ITarantellaPrint
Defines the web services for managing Secure Global Desktop (SGD) print jobs.
Most of the print APIs operate within the context of the user session
that called them. For example, countJobs(String)
returns the
number of print jobs that the user has currently queued. The exceptions
are the APIs starting "admin..." - SGD administrators
can use these APIs to operate on print jobs belonging to other users.
Method Summary | |
---|---|
java.lang.String |
adminCount(java.lang.String sessionCookie,
java.lang.String searchSpec)
Counts the number of matching print jobs a search would return. |
java.lang.String |
adminSearchEnd(java.lang.String sessionCookie,
java.lang.String searchId)
Cleans-up resources in the server for a given search. |
java.lang.String |
adminSearchNext(java.lang.String sessionCookie,
java.lang.String searchId,
int noOfResults)
Retrieves the next subset of search results. |
java.lang.String |
adminSearchStart(java.lang.String sessionCookie,
java.lang.String searchSpec,
java.lang.String[] desiredAttributes,
int noOfResults,
java.lang.String searchType)
Starts a search, returning a maximum number of results. |
java.lang.String |
cancelAllJobs(java.lang.String sessionCookie)
Cancels all print jobs owned by a user session. |
java.lang.String |
cancelJobs(java.lang.String sessionCookie,
java.lang.String[] jobIds)
Cancels named print jobs owned by a user session. |
java.lang.String |
countJobs(java.lang.String sessionCookie)
Counts the print jobs owned by a user session. |
java.lang.String |
lookupJobs(java.lang.String sessionCookie,
java.lang.String[] jobIds,
java.lang.String[] desiredAttributes)
Looks-up named print jobs owned by a user session. |
java.lang.String |
printAllJobs(java.lang.String sessionCookie)
Prints all print jobs owned by a user session. |
java.lang.String |
printJobs(java.lang.String sessionCookie,
java.lang.String[] jobIds)
Prints named print jobs owned by a user session. |
java.lang.String |
search(java.lang.String sessionCookie,
java.lang.String searchSpec,
java.lang.String[] desiredAttributes)
Searches for print jobs owned by a user session. |
Method Detail |
---|
java.lang.String adminCount(java.lang.String sessionCookie, java.lang.String searchSpec) throws java.rmi.RemoteException
sessionCookie
- Identifies the user session performing the operation.searchSpec
- RFC 2254 search specification for selecting matching
print jobs.
countJobs(String)
for details.
java.rmi.RemoteException
- On receipt of a SOAP fault.java.lang.String adminSearchEnd(java.lang.String sessionCookie, java.lang.String searchId) throws java.rmi.RemoteException
adminSearchStart(String, String, String[], int, String)
.
sessionCookie
- Identifies the user session performing the operation.searchId
- Identifies the search to clean-up.
java.rmi.RemoteException
- On receipt of a SOAP fault.java.lang.String adminSearchNext(java.lang.String sessionCookie, java.lang.String searchId, int noOfResults) throws java.rmi.RemoteException
adminSearchStart(String, String, String[], int, String)
.
sessionCookie
- Identifies the user session performing the operation.searchId
- Identifies the search to use.noOfResults
- The maximum number of results to return from the search.
If noOfResults <= 0
, all results are returned.
adminSearchStart(String, String, String[], int, String)
.
java.rmi.RemoteException
- On receipt of a SOAP fault.java.lang.String adminSearchStart(java.lang.String sessionCookie, java.lang.String searchSpec, java.lang.String[] desiredAttributes, int noOfResults, java.lang.String searchType) throws java.rmi.RemoteException
noOfResults
, the results
are cached on the server and subsequent sets can be retrieved by calling
adminSearchNext(String, String, int)
. If not all of the results are
retrieved and the search is no longer needed, adminSearchEnd(String, String)
should be called.
For use by administrators only.
sessionCookie
- Identifies the user session performing the operation.searchSpec
- RFC 2254 search specfication to select matching print jobs.desiredAttributes
- Array of attributes wanted in the response.
See search(String, String, String[])
for details of attributes.noOfResults
- The maximum number of results to return from this search.
If noOfResults <= 0
, all results are returned.searchType
- Reserved for future use. An empty string should be
provided.
IConstantsXML.NAME_SEARCHID
attribute identifies the
search and is returned in the top-level object. If this attribute has a
non-empty value, then the search found more results than allowed by
noOfResults
. Subsequent results can be obtained by calling
adminSearchNext(String, String, int)
until that API returns
an empty IConstantsXML.NAME_SEARCHID
value, indicating that there
are no more results.
If the search is abandoned before the attribute name IConstantsXML.NAME_SEARCHID
is empty, then the search should be
ended by calling adminSearchEnd(String, String)
. Failure to do so
will consume server resources.
The results for the user sessions are returned in the children of the
the top-level object named IConstantsXML.NAME_PRINT
, where each
child corresponds to an SGD print job. Each child object
contains the desired attributes.
Sample Response:
<?xml version="1.0" encoding="UTF-8"?>
<tta:response xmlns:tta="http://xml.tarantella.com/2001/soapreply.xsd">
<obj name="printjob">
See search(String, String, String[])
for details.
</obj>
<attr name="searchId">server.uk.sun.com:1195051376977:-3865342581179161190:PR-1195216694083</attr>
</tta:response>
java.rmi.RemoteException
- On receipt of a SOAP fault.java.lang.String cancelAllJobs(java.lang.String sessionCookie) throws java.rmi.RemoteException
sessionCookie
- Identifies the user session owning the print jobs.
java.rmi.RemoteException
- On receipt of a SOAP fault.java.lang.String cancelJobs(java.lang.String sessionCookie, java.lang.String[] jobIds) throws java.rmi.RemoteException
sessionCookie
- Identifies the user session owning the print jobs.jobIds
- Array of print jobs name to be cancelled.
java.rmi.RemoteException
- On receipt of a SOAP fault.java.lang.String countJobs(java.lang.String sessionCookie) throws java.rmi.RemoteException
sessionCookie
- Identifies the user session owning the print jobs.
IAttributeNames.TOTAL
in the top-level object.
Sample response:
<?xml version="1.0" encoding="UTF-8"?>
<tta:response xmlns:tta="http://xml.tarantella.com/2001/soapreply.xsd">
<attr name="total">0</attr>
</tta:response>
java.rmi.RemoteException
- On receipt of a SOAP fault.java.lang.String lookupJobs(java.lang.String sessionCookie, java.lang.String[] jobIds, java.lang.String[] desiredAttributes) throws java.rmi.RemoteException
sessionCookie
- Identifies the user session owning the print jobs.jobIds
- Array of print job names to be looked-up. The name of a
print job is stored in the ISchemaNames.PRINT_FILENAME
attribute.desiredAttributes
- Array of attributes wanted on the print jobs. The
shortcut IConstants.LOCAL_ATTRS
can be used to look-up attributes
that can be retrieved quickly.
search(String, String, String[])
for details.
java.rmi.RemoteException
- On receipt of a SOAP fault.java.lang.String printAllJobs(java.lang.String sessionCookie) throws java.rmi.RemoteException
NOTE: Print jobs located in a print queue on the server that has been paused by an administrator will not print.
sessionCookie
- Identifies the user session owning the print jobs.
java.rmi.RemoteException
- On receipt of a SOAP fault.java.lang.String printJobs(java.lang.String sessionCookie, java.lang.String[] jobIds) throws java.rmi.RemoteException
NOTE: Print jobs located in a print queue on the server that has been paused by an administrator will not print.
sessionCookie
- Identifies the user session owning the print jobs.jobIds
- Array of print jobs name to be printed.
java.rmi.RemoteException
- On receipt of a SOAP fault.java.lang.String search(java.lang.String sessionCookie, java.lang.String searchSpec, java.lang.String[] desiredAttributes) throws java.rmi.RemoteException
sessionCookie
- Identifies the user session owning the print jobs.searchSpec
- RFC 2254 search specification to select matching
print jobs.desiredAttributes
- Array of attributes wanted on the print jobs. The
shortcut IConstants.LOCAL_ATTRS
can be used to look-up attributes
that can be retrieved quickly.
IConstantsXML.NAME_PRINT
, where each child corresponds to a Secure
Global Desktop print job. Each child object contains the desired attributes.
The attribute ISchemaNames.PRINT_FILENAME
contains the name of the
print job. This name can be used in cancelJobs(String, String[])
,
lookupJobs(String, String[], String[])
and printJobs(String, String[])
.
Sample Response:
<?xml version="1.0" encoding="UTF-8"?>
<tta:response xmlns:tta="http://xml.tarantella.com/2001/soapreply.xsd">
<obj name="printjob">
<attr name="scottaprintt3username">root</attr>
<attr name="scottaprintprintername"></attr>
<attr name="scottaprintformat">Unknown</attr>
<attr name="scottaprinttimestamp">1195211742991</attr>
<attr name="scottaprintsize">2167</attr>
<attr name="scottaprintname">passwd</attr>
<attr name="scottaprintcopies">1</attr>
<attr name="scottaprintfilename">root-9523</attr>
<attr name="scottapeerdnsname">server.uk.sun.com</attr>
<attr name="objectclass">scottaprintjob</attr>
<attr name="scottaprintserver">server</attr>
<attr name="scottaprintstatus">0</attr>
<attr name="scottaprinttfnname">.../_dns/server.uk.sun.com/_service/sco/tta/print/root-9523</attr>
<attr name="scottaprintusername">.../_ens/o=Tarantella System Objects/cn=Administrator</attr>
</obj>
<obj name="printjob">
<attr name="scottaprintt3username">root</attr>
<attr name="scottaprintprintername"></attr>
<attr name="scottaprintformat">Unknown</attr>
<attr name="scottaprinttimestamp">1195211740849</attr>
<attr name="scottaprintsize">2167</attr>
<attr name="scottaprintname">passwd</attr>
<attr name="scottaprintcopies">1</attr>
<attr name="scottaprintfilename">root-9439</attr>
<attr name="scottapeerdnsname">server.uk.sun.com</attr>
<attr name="objectclass">scottaprintjob</attr>
<attr name="scottaprintserver">server</attr>
<attr name="scottaprintstatus">0</attr>
<attr name="scottaprinttfnname">.../_dns/server.uk.sun.com/_service/sco/tta/print/root-9439</attr>
<attr name="scottaprintusername">.../_ens/o=Tarantella System Objects/cn=Administrator</attr>
</obj>
</tta:response>
java.rmi.RemoteException
- On receipt of a SOAP fault.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |