|
dbXML API | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
dbXMLClient is the standard interface for working with dbXML in a client/server fashion.
Field Summary | |
static java.lang.String |
ALT_HOST
|
static java.lang.String |
ALT_PASS
|
static java.lang.String |
ALT_PORT
|
static java.lang.String |
ALT_USER
|
static java.lang.String |
HOST
|
static java.lang.String |
PASS
|
static java.lang.String |
PORT
|
static java.lang.String |
USER
|
Method Summary | |
void |
connect()
connect instructs the client to connect to the server. |
void |
disconnect()
disconnect instructs the client to disconnect from the server. |
CollectionClient |
getCollection(java.lang.String path)
getCollection returns the CollectionClient defined by the specified path. |
ContentClient |
getContent(java.lang.String path)
getContent returns the ContentClient defined by the specified path. |
CollectionClient |
getDatabase()
getDatabase returns the Database instance as a CollectionClient. |
java.util.Map |
getProperties()
getProperties returns the entire set of client properties. |
java.lang.String |
getProperty(java.lang.String name)
getProperty returns a connection property from the client. |
java.lang.String |
getServerVersion()
getServerVersion returns a string that includes the name and current version of the server that is currently connected. |
java.lang.String[] |
listProperties()
listProperties returns a list of the connection property names for the client. |
void |
setProperty(java.lang.String name,
java.lang.String value)
setProperty sets a connection property for the client. |
void |
shutdown(int exitCode)
shutdown shuts down the server with the specified exit code. |
Field Detail |
public static final java.lang.String HOST
public static final java.lang.String ALT_HOST
public static final java.lang.String PORT
public static final java.lang.String ALT_PORT
public static final java.lang.String USER
public static final java.lang.String ALT_USER
public static final java.lang.String PASS
public static final java.lang.String ALT_PASS
Method Detail |
public void setProperty(java.lang.String name, java.lang.String value)
name
- The property namevalue
- The property valuepublic java.lang.String getProperty(java.lang.String name)
name
- The property name
public java.lang.String[] listProperties()
public java.util.Map getProperties()
public void connect() throws dbXMLException
dbXMLException
public void disconnect() throws dbXMLException
dbXMLException
public java.lang.String getServerVersion() throws dbXMLException
dbXMLException
public void shutdown(int exitCode) throws dbXMLException
exitCode
- The exit code to use
dbXMLException
public CollectionClient getDatabase() throws dbXMLException
dbXMLException
public CollectionClient getCollection(java.lang.String path) throws dbXMLException
path
- The Collection path
dbXMLException
public ContentClient getContent(java.lang.String path) throws dbXMLException
path
- The Document path
dbXMLException
|
dbXML API | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |