com.baan.b3.boi1
Interface IBackend

public interface IBackend

This interface represents an OpenWorld Backend (server). This interface can be used to perform some control actions on a started Backend.

Inner Class Summary

static class

IBackend.Statistics Structure containing the statistics of the Backend.

Method Summary

void	close() Close the connection in use by this Backend.
void	deactivate() Deactivate the backend.
long	getTimeout() Get the Timeout for this Backend object.
java.lang.String	getType() Get the Backend type.
long	ping() Try to ping the Backend.
void	reset() Reset the statistics of the backend.
void	setLicenseOverrideKey(java.lang.String sLicenseOverrideKey)
void	setTimeout(long p_timeout) Set the Timeout for this Backend object.
void	setUserInfo(IUserInfo p_userInfo) Set the UserInfo used to connect.
IBackend.Statistics	statistics() Retrieve Statistics from the server.

Method Detail

setLicenseOverrideKey

public void setLicenseOverrideKey(java.lang.String sLicenseOverrideKey)
                           throws BoiException

setUserInfo

public void setUserInfo(IUserInfo p_userInfo)
                 throws BoiException

Set the UserInfo used to connect. This can be used to connect to backends where a Backend Security mode is enabled (thisuser, checkuser). Default no User Information is send.

Parameters:

p_userInfo - an UserInfo Object.

Throws:

BoiException - if closed or already initialized (a call has been done).

setTimeout

public void setTimeout(long p_timeout)
                throws BoiException

Set the Timeout for this Backend object. Default the timeout is set to the Adapter Timeout.

Parameters:

p_timeout - timeout in milliseconds.

Throws:

BoiException - if already closed.

getTimeout

public long getTimeout()
                throws BoiException

Get the Timeout for this Backend object. Default the timeout is set to the Adapter Timeout.

Returns:

Timeout in milliseconds.

Throws:

BoiException - if already closed

deactivate

public void deactivate()
                throws BoiException

Deactivate the backend. This only works with Backends started without an UI.

Throws:

BoiException - if already closed or error during transport.

reset

public void reset()
           throws BoiException

Reset the statistics of the backend.

Throws:

BoiException - if already closed or error during transport.

getType

public java.lang.String getType()
                         throws BoiException

Get the Backend type.

Returns:

The Backend type name.

Throws:

BoiException - if already closed or error during transport.

ping

public long ping()
          throws BoiException

Try to ping the Backend.

Returns:

ping time in milliseconds.

Throws:

BoiException - if already closed or error during transport.

statistics

public IBackend.Statistics statistics()
                               throws BoiException

Retrieve Statistics from the server.

Returns:

Statistics object containing statistics.

Throws:

BoiException - if already closed or error during transport.

close

public void close()

Close the connection in use by this Backend.