org.openscada.opc.lib.da

Class Server

java.lang.Object

org.openscada.opc.lib.da.Server

public class Server
extends Object

Constructor Summary

Constructors

Constructor and Description
Server(ConnectionInformation connectionInformation, ScheduledExecutorService scheduler)

Method Summary

Modifier and Type	Method and Description
Group	addGroup() Add a new group and let the server generate a group name Actually this method only calls addGroup(String) with null as parameter.
Group	addGroup(String name) Add a new named group to the server
void	addStateListener(ServerConnectionStateListener listener)
protected void	cleanup() cleanup after the connection is closed
void	connect()
void	disconnect() Disconnect the connection if it is connected
void	dispose() Dispose the connection in the case of an error
Group	findGroup(String name) Find a group by its name
int	getDefaultLocaleID()
Float	getDefaultPercentDeadband()
Integer	getDefaultTimeBias()
int	getDefaultUpdateRate()
String	getErrorMessage(int errorCode)
FlatBrowser	getFlatBrowser() Get the flat browser
protected Group	getGroup(OPCGroupStateMgt groupMgt)
ScheduledExecutorService	getScheduler() Gets the scheduler for the server.
OPCSERVERSTATUS	getServerState()
OPCSERVERSTATUS	getServerState(int timeout)
TreeBrowser	getTreeBrowser() Get the tree browser
protected boolean	isConnected()
boolean	isDefaultActive()
protected void	notifyConnectionStateChange(boolean connected)
void	removeGroup(Group group, boolean force)
void	removeStateListener(ServerConnectionStateListener listener)
void	setDefaultActive(boolean defaultActive)
void	setDefaultLocaleID(int defaultLocaleID)
void	setDefaultPercentDeadband(Float defaultPercentDeadband)
void	setDefaultTimeBias(Integer defaultTimeBias)
void	setDefaultUpdateRate(int defaultUpdateRate)

Methods inherited from class java.lang.Object

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

Constructor Detail

Server

public Server(ConnectionInformation connectionInformation,
              ScheduledExecutorService scheduler)

Method Detail

getScheduler

public ScheduledExecutorService getScheduler()

Gets the scheduler for the server. Note that this scheduler might get blocked for a short time if the connection breaks. It should not be used for time critical operations.

Returns:

the scheduler for the server

isConnected

protected boolean isConnected()

connect

public void connect()
             throws IllegalArgumentException,
                    UnknownHostException,
                    JIException,
                    AlreadyConnectedException

Throws:

IllegalArgumentException

UnknownHostException

JIException

AlreadyConnectedException

cleanup

protected void cleanup()

cleanup after the connection is closed

disconnect

public void disconnect()

Disconnect the connection if it is connected

dispose

public void dispose()

Dispose the connection in the case of an error

getGroup

protected Group getGroup(OPCGroupStateMgt groupMgt)
                  throws JIException,
                         IllegalArgumentException,
                         UnknownHostException

Throws:

JIException

IllegalArgumentException

UnknownHostException

addGroup

public Group addGroup(String name)
               throws NotConnectedException,
                      IllegalArgumentException,
                      UnknownHostException,
                      JIException,
                      DuplicateGroupException

Add a new named group to the server

Parameters:

name - The name of the group to use. Must be unique or null so that the server creates a unique name.

Returns:

The new group

Throws:

NotConnectedException - If the server is not connected using connect()

IllegalArgumentException

UnknownHostException

JIException

DuplicateGroupException - If a group with this name already exists

addGroup

public Group addGroup()
               throws IllegalArgumentException,
                      UnknownHostException,
                      NotConnectedException,
                      JIException,
                      DuplicateGroupException

Add a new group and let the server generate a group name Actually this method only calls addGroup(String) with null as parameter.

Returns:

the new group

Throws:

IllegalArgumentException

UnknownHostException

NotConnectedException

JIException

DuplicateGroupException

findGroup

public Group findGroup(String name)
                throws IllegalArgumentException,
                       UnknownHostException,
                       JIException,
                       UnknownGroupException,
                       NotConnectedException

Find a group by its name

Parameters:

name - The name to look for

Returns:

The group

Throws:

IllegalArgumentException

UnknownHostException

JIException

UnknownGroupException - If the group was not found

NotConnectedException - If the server is not connected

getDefaultLocaleID

public int getDefaultLocaleID()

setDefaultLocaleID

public void setDefaultLocaleID(int defaultLocaleID)

getDefaultPercentDeadband

public Float getDefaultPercentDeadband()

setDefaultPercentDeadband

public void setDefaultPercentDeadband(Float defaultPercentDeadband)

getDefaultTimeBias

public Integer getDefaultTimeBias()

setDefaultTimeBias

public void setDefaultTimeBias(Integer defaultTimeBias)

getDefaultUpdateRate

public int getDefaultUpdateRate()

setDefaultUpdateRate

public void setDefaultUpdateRate(int defaultUpdateRate)

isDefaultActive

public boolean isDefaultActive()

setDefaultActive

public void setDefaultActive(boolean defaultActive)

getFlatBrowser

public FlatBrowser getFlatBrowser()

Get the flat browser

Returns:

The flat browser or null if the functionality is not supported

getTreeBrowser

public TreeBrowser getTreeBrowser()
                           throws JIException

Get the tree browser

Returns:

The tree browser or null if the functionality is not supported

Throws:

JIException

getErrorMessage

public String getErrorMessage(int errorCode)

addStateListener

public void addStateListener(ServerConnectionStateListener listener)

removeStateListener

public void removeStateListener(ServerConnectionStateListener listener)

notifyConnectionStateChange

protected void notifyConnectionStateChange(boolean connected)

getServerState

public OPCSERVERSTATUS getServerState(int timeout)
                               throws Throwable

Throws:

Throwable

getServerState

public OPCSERVERSTATUS getServerState()

removeGroup

public void removeGroup(Group group,
                        boolean force)
                 throws JIException

Throws:

JIException