com.prosysopc.ua.client

Class ServerListBase

java.lang.Object

com.prosysopc.ua.client.ServerListBase

Direct Known Subclasses:

GlobalServerList, ServerList

public abstract class ServerListBase
extends Object

A base class for ServerLists discovered from discovery servers.

Field Summary

Fields

Modifier and Type	Field and Description
protected DateTime	lastCounterResetTime
protected List<ApplicationDescription>	servers
protected List<ServerOnNetwork>	serversOnNetwork

Constructor Summary

Constructors

Constructor and Description
ServerListBase()
ServerListBase(String uri) Create a new list of servers, containing the servers discovered from a discoveryServer.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the list.
abstract void	discover(String discoveryServerUri) Discover OPCUA applications from a discovery server.
ApplicationDescription	get(int index) Get the description of a server.
DateTime	getLastCounterResetTime() The last time the counters were reset
ApplicationDescription[]	getServers() The current list of discovered servers.
ServerOnNetwork[]	getServersOnNetwork() Get the discovered ServerOnNetwork records
boolean	isEmpty() Check if the getServers() list is empty.
int	size()

Methods inherited from class java.lang.Object

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

Field Detail

lastCounterResetTime

protected DateTime lastCounterResetTime

servers

protected final List<ApplicationDescription> servers

serversOnNetwork

protected final List<ServerOnNetwork> serversOnNetwork

Constructor Detail

ServerListBase

public ServerListBase()

ServerListBase

public ServerListBase(String uri)
               throws ServerListException

Create a new list of servers, containing the servers discovered from a discoveryServer.

Parameters:

uri - The URI of the discovery server to discover.

Throws:

ServerListException - if the discovery fails

Method Detail

clear

public void clear()

Clears the list.

discover

public abstract void discover(String discoveryServerUri)
                       throws ServerListException

Discover OPCUA applications from a discovery server.

Parameters:

discoveryServerUri - URI of the discovery server

Throws:

ServerListException - if the discovery

get

public ApplicationDescription get(int index)

Get the description of a server.

Parameters:

index - the index of the server in the list

Returns:

the application description of the server

getLastCounterResetTime

public DateTime getLastCounterResetTime()

The last time the counters were reset

Returns:

time as DateTime object

getServers

public ApplicationDescription[] getServers()

The current list of discovered servers.

Returns:

the servers in an array

getServersOnNetwork

public ServerOnNetwork[] getServersOnNetwork()

Get the discovered ServerOnNetwork records

Returns:

the servers in an array

isEmpty

public boolean isEmpty()

Check if the getServers() list is empty. Note that getServersOnNetwork() may still provide entries.

Returns:

true if size() == 0

size

public int size()

Returns:

the number of elements in the list.