org.openscada.opc.lib.list

Class ServerList

java.lang.Object

org.openscada.opc.lib.list.ServerList

public class ServerList
extends Object

A wrapper around the OPCServerList class which makes the handling somewhat easier.

Since:

0.1.8

Author:

Jens Reimann <jens.reimann@th4-systems.com>

Constructor Summary

Constructors

Constructor and Description
ServerList(JISession session, String host) Create a new instance with an already existing session
ServerList(String host, String user, String password) Create a new instance and a new DCOM session
ServerList(String host, String user, String password, String domain) Create a new instance and a new DCOM session

Method Summary

Modifier and Type	Method and Description
String	getClsIdFromProgId(String progId) Fetch the class id of a prog id
ClassDetails	getDetails(String clsId) Get the details of a opc class
Collection<String>	listServers(Category[] implemented, Category[] required) List all servers that match the requirements
Collection<ClassDetails>	listServersWithDetails(Category[] implemented, Category[] required) List all servers that match the requirements and return the class details

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerList

public ServerList(JISession session,
                  String host)
           throws IllegalArgumentException,
                  UnknownHostException,
                  JIException

Create a new instance with an already existing session

Parameters:

session - the DCOM session

host - the host to query

Throws:

IllegalArgumentException

UnknownHostException

JIException

ServerList

public ServerList(String host,
                  String user,
                  String password)
           throws IllegalArgumentException,
                  UnknownHostException,
                  JIException

Create a new instance and a new DCOM session

Parameters:

host - the host to contact

user - the user to use for authentication

password - the password to use for authentication

Throws:

IllegalArgumentException

UnknownHostException

JIException

ServerList

public ServerList(String host,
                  String user,
                  String password,
                  String domain)
           throws IllegalArgumentException,
                  UnknownHostException,
                  JIException

Create a new instance and a new DCOM session

Parameters:

host - the host to contact

user - the user to use for authentication

password - the password to use for authentication

domain - The domain to use for authentication

Throws:

IllegalArgumentException

UnknownHostException

JIException

Method Detail

getDetails

public ClassDetails getDetails(String clsId)
                        throws JIException

Get the details of a opc class

Parameters:

clsId - the class to request details for

Returns:

The class details

Throws:

JIException

getClsIdFromProgId

public String getClsIdFromProgId(String progId)
                          throws JIException

Fetch the class id of a prog id

Parameters:

progId - The prog id to look up

Returns:

the class id or null if none could be found.

Throws:

JIException

listServers

public Collection<String> listServers(Category[] implemented,
                                      Category[] required)
                               throws IllegalArgumentException,
                                      UnknownHostException,
                                      JIException

List all servers that match the requirements

Parameters:

implemented - All implemented categories

required - All required categories

Returns:

A collection of class ids

Throws:

IllegalArgumentException

UnknownHostException

JIException

listServersWithDetails

public Collection<ClassDetails> listServersWithDetails(Category[] implemented,
                                                       Category[] required)
                                                throws IllegalArgumentException,
                                                       UnknownHostException,
                                                       JIException

List all servers that match the requirements and return the class details

Parameters:

implemented - All implemented categories

required - All required categories

Returns:

a collection of matching server and their class information

Throws:

IllegalArgumentException

UnknownHostException

JIException