|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ITarantellaDatastore
Defines the web services for accessing the Secure Global Desktop (SGD) datastore.
These APIs are for advanced users.
Method Summary | |
---|---|
java.lang.String |
count(java.lang.String sessionCookie,
java.lang.String rootName,
java.lang.String searchSpec,
java.lang.String depth)
Counts the number of objects in a sub-tree of the SGD datastore. |
java.lang.String |
create(java.lang.String sessionCookie,
java.lang.String objectName,
Item[] attributes)
Creates a new object in the SGD datastore. |
java.lang.String |
delete(java.lang.String sessionCookie,
java.lang.String objectName,
boolean removeChildren)
Deletes an object from the SGD datastore. |
java.lang.String |
deleteObjects(java.lang.String sessionCookie,
java.lang.String[] objectNames,
boolean removeChildren)
Deletes several objects from the SGD datastore. |
java.lang.String |
lookup(java.lang.String sessionCookie,
java.lang.String objectName,
java.lang.String[] desiredAttributes)
Looks-up an object in the SGD datastore. |
java.lang.String |
modify(java.lang.String sessionCookie,
java.lang.String objectName,
Item[] attributes,
java.lang.String operation)
Modifies an object in the SGD datastore. |
java.lang.String |
modifyReplace(java.lang.String sessionCookie,
java.lang.String objectName,
Item[] attributes)
Modifies an object in the SGD datastore. |
java.lang.String |
rename(java.lang.String sessionCookie,
java.lang.String oldName,
java.lang.String newName)
Renames an object in the SGD datastore. |
java.lang.String |
search(java.lang.String sessionCookie,
java.lang.String rootName,
java.lang.String[] desiredAttributes,
java.lang.String searchSpec,
java.lang.String depth)
Searches for objects in a sub-tree of the SGD datastore. |
java.lang.String |
searchEnd(java.lang.String sessionCookie,
java.lang.String searchId)
Cleans-up resources in the server for a given search. |
java.lang.String |
searchNext(java.lang.String sessionCookie,
java.lang.String searchId,
int noOfResults)
Retrieves the next subset of search results. |
java.lang.String |
searchStart(java.lang.String sessionCookie,
java.lang.String rootName,
java.lang.String[] desiredAttributes,
java.lang.String searchSpec,
java.lang.String depth,
int noOfResults,
java.lang.String searchType)
Starts a datastore search, returning a maximum number of results. |
Method Detail |
---|
java.lang.String count(java.lang.String sessionCookie, java.lang.String rootName, java.lang.String searchSpec, java.lang.String depth) throws java.rmi.RemoteException
sessionCookie
- Identifies the user session performing the operation.rootName
- The fully-qualified name from which to start counting.searchSpec
- RFC 2254 search specification to select matching objects.depth
- The depth of sub-tree to count:
IConstants.DEPTH_ONELEVEL |
Restrict the search to one level under the rootName
|
IConstants.DEPTH_SUBTREE |
Search the whole sub-tree under the rootName |
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">38</attr>
</tta:response>
java.rmi.RemoteException
- On receipt of a SOAP fault.java.lang.String create(java.lang.String sessionCookie, java.lang.String objectName, Item[] attributes) throws java.rmi.RemoteException
sessionCookie
- Identifies the user session performing the operation.objectName
- The fully-qualified name of the object to be created.attributes
- The attributes to be set on the object. Different object
types have different sets of mandatory attributes. See 'Help' for the
command-line interfaces for guidance.
java.rmi.RemoteException
- On receipt of a SOAP fault.java.lang.String delete(java.lang.String sessionCookie, java.lang.String objectName, boolean removeChildren) throws java.rmi.RemoteException
sessionCookie
- Identifies the user session performing the operation.objectName
- The fully-qualified name of the object to be deleted.removeChildren
- Flag controlling how the children are handled:
true | Delete all children |
false | Do not delete children |
java.rmi.RemoteException
- On receipt of a SOAP fault.java.lang.String deleteObjects(java.lang.String sessionCookie, java.lang.String[] objectNames, boolean removeChildren) throws java.rmi.RemoteException
sessionCookie
- Identifies the user session performing the operation.objectNames
- The fully-qualified names of the objects to be deleted.removeChildren
- Flag controlling how the children are handled.
true | Delete all children |
false | Do not delete children |
java.rmi.RemoteException
- On receipt of a SOAP fault.java.lang.String lookup(java.lang.String sessionCookie, java.lang.String objectName, java.lang.String[] desiredAttributes) throws java.rmi.RemoteException
sessionCookie
- Identifies the user session performing the operation.objectName
- The fully-qualified name of the object to be looked-up.desiredAttributes
- The attributes wanted in the response.
The shortcut IConstants.ALL_ATTRS
can be used to retrieve all
attributes.
IConstantsXML.NAME_DATASTOREITEM
.
Sample response:
<?xml version="1.0" encoding="UTF-8"?>
<tta:response xmlns:tta="http://xml.tarantella.com/2001/soapreply.xsd">
<obj name="datastoreitem">
<attr name="sn">root</attr>
<attr name="scottawebtopcontents">o=applications/cn=Applications</attr>
<attr name="scottainheritwebtop">0</attr>
<attr name="scottasharedlogin">0</attr>
<attr name="scottaaipbandwidth">0</attr>
<attr name="uid">root</attr>
<attr name="objectclass">inetorgperson</attr>
<attr name="objectclass">scottaauxperson</attr>
<attr name="objectclass">organizationalperson</attr>
<attr name="objectclass">person</attr>
<attr name="objectclass">top</attr>
<attr name="scottaaccountenabled">1</attr>
<attr name="cn">Administrator</attr>
<attr name="sunsgdeditprofile">2</attr>
<attr name="sunsgdclipboardenabled">2</attr>
<attr name="scottatheme">..</attr>
<attr name="sunsgdserialportenabled">2</attr>
</obj>
</tta:response>
java.rmi.RemoteException
- On receipt of a SOAP fault.java.lang.String modifyReplace(java.lang.String sessionCookie, java.lang.String objectName, Item[] attributes) throws java.rmi.RemoteException
modify(String, String, Item[], String)
with a mode of IConstants.MODE_REPLACEATTR
.
sessionCookie
- Identifies the user session performing the operation.objectName
- The fully-qualified name of the object to be modified.attributes
- The attributes to be modified on the object.
java.rmi.RemoteException
- On receipt of a SOAP fault.java.lang.String modify(java.lang.String sessionCookie, java.lang.String objectName, Item[] attributes, java.lang.String operation) throws java.rmi.RemoteException
sessionCookie
- Identifies the user session performing the operation.objectName
- The fully-qualified name of the object to be modified.attributes
- The attributes to be modified on the object.operation
- Type of modification. One of:
IConstants.MODE_APPENDATTR |
Append the values to any existing values on the named attributes. |
IConstants.MODE_REMOVEATTR |
Remove the named attributes. Attributes that are not named are left untouched. |
IConstants.MODE_REPLACEATTR |
Replace the values on the named attributes with new values. Attributes that are not named are left untouched. |
IConstants.MODE_REPLACEALLATTR |
Remove all attributes and replace them with the named values. |
java.rmi.RemoteException
- On receipt of a SOAP fault.java.lang.String rename(java.lang.String sessionCookie, java.lang.String oldName, java.lang.String newName) throws java.rmi.RemoteException
sessionCookie
- Identifies the user session performing the operation.oldName
- The current fully-qualified name of the object.newName
- The new fully-qualified name for the object.
java.rmi.RemoteException
- On receipt of a SOAP fault.java.lang.String search(java.lang.String sessionCookie, java.lang.String rootName, java.lang.String[] desiredAttributes, java.lang.String searchSpec, java.lang.String depth) throws java.rmi.RemoteException
sessionCookie
- Identifies the user session performing the operation.rootName
- The fully-qualified name from which to start searching.desiredAttributes
- The attributes wanted in the response.
The shortcut IConstants.ALL_ATTRS
can be used to retrieve all
attributes.searchSpec
- RFC 2254 search specification to select matching objects.depth
- The depth of sub-tree to search:
IConstants.DEPTH_ONELEVEL |
Restrict the search to one level under the rootName
|
IConstants.DEPTH_SUBTREE |
Search the whole sub-tree under the rootName |
IConstantsXML.NAME_DATASTOREITEM
.
Sample response:
<?xml version="1.0" encoding="UTF-8"?>
<tta:response xmlns:tta="http://xml.tarantella.com/2001/soapreply.xsd">
<obj name="datastoreitem">
<attr name="datastoreitemname">o=applications</attr>
<attr name="scottatheme">sco/tta/standard</attr>
<attr name="dn">o=applications</attr>
<attr name="scottadeviceconfig">1:15:*:3:%%SAME%%1:16:*:2:%%SAME%%</attr>
<attr name="sunsgdclipboardenabled">2</attr>
<attr name="objectclass">organization</attr>
<attr name="objectclass">scottaauxorganization</attr>
<attr name="objectclass">top</attr>
<attr name="sunsgdeditprofile">2</attr>
<attr name="sunsgdserialportenabled">2</attr>
<attr name="o">applications</attr>
</obj>
<obj name="datastoreitem">
<attr name="datastoreitemname">dc=com</attr>
<attr name="dc">com</attr>
<attr name="dn">dc=com</attr>
<attr name="objectclass">domainDNS</attr>
<attr name="objectclass">domain</attr>
<attr name="objectclass">top</attr>
</obj>
<obj name="datastoreitem">
<attr name="datastoreitemname">o=Tarantella System Objects</attr>
<attr name="scottatheme">sco/tta/standard</attr>
<attr name="dn">o=Tarantella System Objects</attr>
<attr name="scottadeviceconfig">1:15:*:3:%%SAME%%1:16:*:2:%%SAME%%</attr>
<attr name="sunsgdclipboardenabled">2</attr>
<attr name="objectclass">organization</attr>
<attr name="objectclass">scottaauxorganization</attr>
<attr name="objectclass">top</attr>
<attr name="sunsgdeditprofile">2</attr>
<attr name="sunsgdserialportenabled">2</attr>
<attr name="o">Tarantella System Objects</attr>
</obj>
<obj name="datastoreitem">
<attr name="datastoreitemname">o=appservers</attr>
<attr name="scottatheme">sco/tta/standard</attr>
<attr name="dn">o=appservers</attr>
<attr name="scottadeviceconfig">1:15:*:3:%%SAME%%1:16:*:2:%%SAME%%</attr>
<attr name="sunsgdclipboardenabled">2</attr>
<attr name="objectclass">organization</attr>
<attr name="objectclass">scottaauxorganization</attr>
<attr name="objectclass">top</attr>
<attr name="sunsgdeditprofile">2</attr>
<attr name="sunsgdserialportenabled">2</attr>
<attr name="o">appservers</attr>
</obj>
<obj name="datastoreitem">
<attr name="datastoreitemname">o=organization</attr>
<attr name="scottatheme">sco/tta/standard</attr>
<attr name="dn">o=organization</attr>
<attr name="scottadeviceconfig">1:15:*:3:%%SAME%%1:16:*:2:%%SAME%%</attr>
<attr name="sunsgdclipboardenabled">2</attr>
<attr name="objectclass">organization</attr>
<attr name="objectclass">scottaauxorganization</attr>
<attr name="objectclass">top</attr>
<attr name="sunsgdeditprofile">2</attr>
<attr name="scottawebtopcontents">o=applications/cn=Applications</attr>
<attr name="sunsgdserialportenabled">2</attr>
<attr name="o">organization</attr>
</obj>
</tta:response>
java.rmi.RemoteException
- On receipt of a SOAP fault.java.lang.String searchEnd(java.lang.String sessionCookie, java.lang.String searchId) throws java.rmi.RemoteException
searchStart(String, String, String[], String, String, int, String)
for more details on searching.
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 searchNext(java.lang.String sessionCookie, java.lang.String searchId, int noOfResults) throws java.rmi.RemoteException
searchStart(String, String, String[], String, String, int, String)
for more details on searching.
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.
searchStart(String, String, String[], String, String, int, String)
.
java.rmi.RemoteException
- On receipt of a SOAP fault.java.lang.String searchStart(java.lang.String sessionCookie, java.lang.String rootName, java.lang.String[] desiredAttributes, java.lang.String searchSpec, java.lang.String depth, int noOfResults, java.lang.String searchType) throws java.rmi.RemoteException
search(String, String, String[], String, String)
)
If the search finds more results than noOfResults
, the results
are cached on the server and subsequent sets can be retrieved by calling
searchNext(String, String, int)
. If not all of the results are
retrieved and the search is no longer needed, searchEnd(String, String)
should be called.
For use by administrators only.
sessionCookie
- Identifies the user session performing the operation.rootName
- The fully-qualified name from which to start searching.desiredAttributes
- The attributes wanted in the response. The shortcut
IConstants.ALL_ATTRS
can be used to retrieve all attributes.searchSpec
- RFC 2254 search specification to select matching objects.depth
- The depth of sub-tree to search:
IConstants.DEPTH_ONELEVEL |
Restrict the search to one level under the rootName
|
IConstants.DEPTH_SUBTREE |
Search the whole sub-tree under the rootName |
noOfResults
- The 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
searchNext(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 searchEnd(String, String)
. Failure to do so
will consume server resources.
The results for the objects are returned in the children of the
top-level object. See
search(String, String, String[], String, String)
for details.
Sample response:
<?xml version="1.0" encoding="UTF-8"?>
<tta:response xmlns:tta="http://xml.tarantella.com/2001/soapreply.xsd">
<obj name="datastoreitem">
See search(String, String, String[], String, String)
for details
</obj>
<attr name="searchId">server.uk.sun.com:1195051376977:-3865342581179161190:DS-1195127538810</attr>
</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 |