org.basex.examples.api

Class BaseXClient

java.lang.Object

org.basex.examples.api.BaseXClient

All Implemented Interfaces:

Closeable, AutoCloseable

public final class BaseXClient
extends Object
implements Closeable

Java client for BaseX. Works with BaseX 7.0 and later Documentation: http://docs.basex.org/wiki/Clients (C) BaseX Team 2005-15, BSD License

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BaseXClient.Query Inner class for iterative query execution.

Field Summary

Fields

Modifier and Type	Field and Description
static Charset	UTF8 UTF-8 charset.

Constructor Summary

Constructors

Constructor and Description
BaseXClient(String host, int port, String username, String password) Constructor.

Method Summary

Modifier and Type	Method and Description
void	add(String path, InputStream input) Adds a document to a database.
void	close() Closes the session.
void	create(String name, InputStream input) Creates a database.
String	execute(String command) Executes a command and returns the result.
void	execute(String command, OutputStream output) Executes a command and serializes the result to an output stream.
String	info() Returns command information.
BaseXClient.Query	query(String query) Creates a query object.
void	replace(String path, InputStream input) Replaces a document in a database.
void	store(String path, InputStream input) Stores a binary resource in a database.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

UTF8

public static final Charset UTF8

UTF-8 charset.

Constructor Detail

BaseXClient

public BaseXClient(String host,
                   int port,
                   String username,
                   String password)
            throws IOException

Constructor.

Parameters:

host - server name

port - server port

username - user name

password - password

Throws:

IOException - Exception

Method Detail

execute

public void execute(String command,
                    OutputStream output)
             throws IOException

Executes a command and serializes the result to an output stream.

Parameters:

command - command

output - output stream

Throws:

IOException - Exception

execute

public String execute(String command)
               throws IOException

Executes a command and returns the result.

Parameters:

command - command

Returns:

result

Throws:

IOException - Exception

query

public BaseXClient.Query query(String query)
                        throws IOException

Creates a query object.

Parameters:

query - query string

Returns:

query

Throws:

IOException - Exception

create

public void create(String name,
                   InputStream input)
            throws IOException

Creates a database.

Parameters:

name - name of database

input - xml input

Throws:

IOException - I/O exception

add

public void add(String path,
                InputStream input)
         throws IOException

Adds a document to a database.

Parameters:

path - path to resource

input - xml input

Throws:

IOException - I/O exception

replace

public void replace(String path,
                    InputStream input)
             throws IOException

Replaces a document in a database.

Parameters:

path - path to resource

input - xml input

Throws:

IOException - I/O exception

store

public void store(String path,
                  InputStream input)
           throws IOException

Stores a binary resource in a database.

Parameters:

path - path to resource

input - xml input

Throws:

IOException - I/O exception

info

public String info()

Returns command information.

Returns:

string info

close

public void close()
           throws IOException

Closes the session.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException - Exception