Package org.basex.api.client

Class ClientSession

java.lang.Object

org.basex.api.client.Session

org.basex.api.client.ClientSession

All Implemented Interfaces:

Closeable, AutoCloseable

public class ClientSession
extends Session

This class contains methods to execute database commands via the client/server architecture. Commands are sent to the server instance over a socket connection:

• A socket instance is created by the constructor.
• The execute(java.lang.String, java.io.OutputStream) method sends database commands to the server. All strings are encoded as UTF8 and suffixed by a zero byte.
• If the command has been successfully executed, the result string is read.
• Next, the command info string is read.
• A last byte is next sent to indicate if command execution was successful (0) or not (1).
• close() closes the session by sending the Commands.Cmd.EXIT command to the server.

Author:

BaseX Team 2005-21, BSD License, Christian Gruen

Field Summary

Fields inherited from class org.basex.api.client.Session

info, out

Constructor Summary

Constructors

Constructor	Description
ClientSession(String host, int port, String username, String password)	Constructor, specifying the server host:port combination and login data.
ClientSession(String host, int port, String username, String password, OutputStream output)	Constructor, specifying the server host:port combination, login data and an output stream.
ClientSession(Context context, String username, String password)	Constructor, specifying login data.
ClientSession(Context context, String username, String password, OutputStream output)	Constructor, specifying login data and an output stream.

Method Summary

Modifier and Type	Method	Description
void	add(String path, InputStream input)	Adds a document to the opened database.
void	close()
void	create(String name, InputStream input)	Creates a database.
protected void	execute(String command, OutputStream output)	Executes a command and prints the result to the specified output stream.
protected void	execute(Command command, OutputStream output)	Executes a command and prints the result to the specified output stream.
ClientQuery	query(String query)	Returns a query object for the specified query string.
void	replace(String path, InputStream input)	Replaces a document in an open database.
void	store(String path, InputStream input)	Stores raw data in an open database.
String	toString()

Methods inherited from class org.basex.api.client.Session

execute, execute, getOutputStream, info, setOutputStream

Methods inherited from class java.lang.Object

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

Constructor Details

ClientSession

public ClientSession(Context context,
 String username,
 String password)
              throws IOException

Constructor, specifying login data.

Parameters:

context - database context

username - user name

password - password (plain text)

Throws:

IOException - I/O exception

ClientSession

public ClientSession(Context context,
 String username,
 String password,
 OutputStream output)
              throws IOException

Constructor, specifying login data and an output stream.

Parameters:

context - database context

username - user name

password - password (plain text)

output - client output; if set to null, results will be returned as strings

Throws:

IOException - I/O exception

ClientSession

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

Constructor, specifying the server host:port combination and login data.

Parameters:

host - server name

port - server port

username - user name

password - password (plain text)

Throws:

IOException - I/O exception

ClientSession

public ClientSession(String host,
 int port,
 String username,
 String password,
 OutputStream output)
              throws IOException

Constructor, specifying the server host:port combination, login data and an output stream.

Parameters:

host - server name

port - server port

username - user name

password - password (plain text)

output - client output; if set to null, results will be returned as strings

Throws:

IOException - I/O exception

Method Details

create

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

Description copied from class: Session

Creates a database.

Specified by:

create in class Session

Parameters:

name - name of database

input - xml input

Throws:

IOException - I/O exception

add

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

Description copied from class: Session

Adds a document to the opened database.

Specified by:

add in class Session

Parameters:

path - target path

input - xml input

Throws:

IOException - I/O exception

replace

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

Description copied from class: Session

Replaces a document in an open database.

Specified by:

replace in class Session

Parameters:

path - document(s) to replace

input - new content

Throws:

IOException - I/O exception

store

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

Description copied from class: Session

Stores raw data in an open database.

Specified by:

store in class Session

Parameters:

path - target path

input - binary input

Throws:

IOException - I/O exception

query

public ClientQuery query(String query)
                  throws IOException

Description copied from class: Session

Returns a query object for the specified query string.

Specified by:

query in class Session

Parameters:

query - query string

Returns:

query

Throws:

IOException - I/O exception

close

public void close()
           throws IOException

Throws:

IOException

execute

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

Description copied from class: Session

Executes a command and prints the result to the specified output stream.

Specified by:

execute in class Session

Parameters:

command - command to be parsed

output - output stream

Throws:

IOException - I/O exception

execute

protected void execute(Command command,
 OutputStream output)
                throws IOException

Description copied from class: Session

Executes a command and prints the result to the specified output stream.

Specified by:

execute in class Session

Parameters:

command - command to be executed

output - output stream

Throws:

IOException - I/O exception

toString

public String toString()

Overrides:

toString in class Object