|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.xspace.service.XSpaceService
An XSpace is a hierarchically-keyed repository for values, accessible globally via XSpaceService.
A key is simply a String with a tree path syntax. For example, /a/b/c
A value can be a String or an XML document.
The most useful methods when you are starting to use this API are:
Method Summary | |
XSpaceSubscriber |
createSubscriptionForAdminEvents(javax.jms.MessageListener listener)
Creates a subscription for an XSpace administration event. |
XSpaceSubscriber |
createSubscriptionForEvents(java.lang.String xspaceName,
javax.jms.MessageListener listener)
Creates a subscription for an XSpace event. |
XSpaceSubscriber |
createSubscriptionForEvents(java.lang.String xspaceName,
java.lang.String key,
javax.jms.MessageListener listener)
Creates a subscription for an XSpace event for a specified key. |
int |
createXSpace(java.lang.String xspaceName)
Creates an XSpace with the given name |
void |
delete(java.lang.String xspaceName,
java.lang.String key)
Deletes a key from an XSpace |
void |
deleteXSpace(java.lang.String xspaceName)
Deletes an XSpace with the given name |
java.lang.String[] |
findChildrenPaths(java.lang.String xspaceName,
java.lang.String path,
boolean fullPath)
Returns all immediate children paths for a specified path. |
java.lang.String[] |
findDescendantPaths(java.lang.String xspaceName,
java.lang.String path)
Returns all descendant paths for a specified path. |
XSpaceItem |
get(java.lang.String xspaceName,
java.lang.String key)
Gets the value for a key in an XSpace |
java.lang.String[] |
getAllKeys(java.lang.String xspaceName)
Gets all the keys in an XSpace. |
static XSpaceService |
getInstance()
Returns a handle to the non-authenticated XSpaceService. |
static XSpaceService |
getInstance(XSpaceCredential credential)
Returns a handle to the authenticated XSpaceService. |
java.lang.String[] |
getKeys(java.lang.String xspaceName,
java.lang.String path)
Gets all the keys starting at the given path in an XSpace |
java.lang.String[] |
listXSpaces()
Lists the names of all XSpaces |
void |
put(java.lang.String xspaceName,
java.lang.String key,
java.lang.String value)
Puts a value for a key in an XSpace |
void |
putXML(java.lang.String xspaceName,
java.lang.String key,
org.w3c.dom.Document document)
Puts an XML document as a value for a key in an XSpace |
java.lang.String[] |
search(java.lang.String xspaceName,
java.lang.String path,
java.lang.String searchString)
Searches an XSpace for values containing the search string. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
public static XSpaceService getInstance()
public static XSpaceService getInstance(XSpaceCredential credential)
credential
- the user ID/password credential
public int createXSpace(java.lang.String xspaceName) throws java.rmi.RemoteException, org.xspace.util.XSpaceException
xspaceName
- the XSpace name
java.rmi.RemoteException
org.xspace.util.XSpaceException
public void deleteXSpace(java.lang.String xspaceName) throws java.rmi.RemoteException, org.xspace.util.XSpaceException
xspaceName
- the XSpace name
java.rmi.RemoteException
org.xspace.util.XSpaceException
public java.lang.String[] listXSpaces() throws java.rmi.RemoteException, org.xspace.util.XSpaceException
java.rmi.RemoteException
org.xspace.util.XSpaceException
public void put(java.lang.String xspaceName, java.lang.String key, java.lang.String value) throws java.rmi.RemoteException, org.xspace.util.XSpaceException
xspaceName
- the name of the XSpacekey
- the key (the format must adhere to XSpace path syntax: e.g. /a/b/c)value
- the string value
java.rmi.RemoteException
org.xspace.util.XSpaceException
public void putXML(java.lang.String xspaceName, java.lang.String key, org.w3c.dom.Document document) throws java.rmi.RemoteException, org.xspace.util.XSpaceException
xspaceName
- the name of the XSpacekey
- the key (the format must adhere to XSpace path syntax: e.g. /a/b/c)document
- the XML document
java.rmi.RemoteException
org.xspace.util.XSpaceException
public XSpaceItem get(java.lang.String xspaceName, java.lang.String key) throws java.rmi.RemoteException, org.xspace.util.XSpaceException
xspaceName
- the name of the XSpacekey
- the key (the format must adhere to XSpace path syntax: e.g. /a/b/c)
java.rmi.RemoteException
org.xspace.util.XSpaceException
public void delete(java.lang.String xspaceName, java.lang.String key) throws java.rmi.RemoteException, org.xspace.util.XSpaceException
xspaceName
- the name of the XSpacekey
- the key (the format must adhere to XSpace path syntax: e.g. /a/b/c)
java.rmi.RemoteException
org.xspace.util.XSpaceException
public java.lang.String[] getKeys(java.lang.String xspaceName, java.lang.String path) throws java.rmi.RemoteException, org.xspace.util.XSpaceException
xspaceName
- the name of the XSpacepath
- the path (e.g. /, /a, /a/b/c)
java.rmi.RemoteException
org.xspace.util.XSpaceException
public java.lang.String[] getAllKeys(java.lang.String xspaceName) throws java.rmi.RemoteException, org.xspace.util.XSpaceException
xspaceName
- the name of the XSpace
java.rmi.RemoteException
org.xspace.util.XSpaceException
public java.lang.String[] findChildrenPaths(java.lang.String xspaceName, java.lang.String path, boolean fullPath) throws java.rmi.RemoteException, org.xspace.util.XSpaceException
xspaceName
- the name of the XSpacepath
- the starting pathfullPath
- a flag indicating whether the returned paths should be full paths
java.rmi.RemoteException
org.xspace.util.XSpaceException
public java.lang.String[] findDescendantPaths(java.lang.String xspaceName, java.lang.String path) throws java.rmi.RemoteException, org.xspace.util.XSpaceException
xspaceName
- the name of the XSpacepath
- the starting path
java.rmi.RemoteException
org.xspace.util.XSpaceException
public java.lang.String[] search(java.lang.String xspaceName, java.lang.String path, java.lang.String searchString) throws java.rmi.RemoteException, org.xspace.util.XSpaceException
xspaceName
- the name of the XSpacepath
- the starting pathsearchString
- the search string
java.rmi.RemoteException
org.xspace.util.XSpaceException
public XSpaceSubscriber createSubscriptionForEvents(java.lang.String xspaceName, javax.jms.MessageListener listener) throws org.xspace.util.XSpaceException, javax.jms.JMSException
xspaceName
- the name of the XSpacelistener
- the listener (which implements javax.jms.MessageListener interface)
org.xspace.util.XSpaceException
javax.jms.JMSException
public XSpaceSubscriber createSubscriptionForEvents(java.lang.String xspaceName, java.lang.String key, javax.jms.MessageListener listener) throws org.xspace.util.XSpaceException, javax.jms.JMSException
xspaceName
- the name of the XSpacekey
- the keylistener
- the listener (which implements javax.jms.MessageListener interface)
org.xspace.util.XSpaceException
javax.jms.JMSException
public XSpaceSubscriber createSubscriptionForAdminEvents(javax.jms.MessageListener listener) throws org.xspace.util.XSpaceException, javax.jms.JMSException
listener
- the listener (which implements javax.jms.MessageListener interface)
org.xspace.util.XSpaceException
javax.jms.JMSException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |