Retrieve Relay Server Configuration

Retrieves one or more relay server configuration.

You can retrieve a list of relay server configurations, or a specific relay server configuration based on a given ID, or a given host name and port number.

Syntax

java.util.List<RelayServerVO> getRelayServers()
                                              throws com.sybase.sup.admin.exception.SUPAdminException;

RelayServerVO getRelayServer(java.lang.Integer relayServerId)
                             throws com.sybase.sup.admin.exception.SUPAdminException;

RelayServerVO getRelayServer(java.lang.String host,
                             java.lang.Integer port)
                             throws com.sybase.sup.admin.exception.SUPAdminException;

Parameters

relayServerId – The ID of the relay server configuration you want to retrieve.
host – The host name of the relay server configuration you want to retrieve.
port – The port of the relay server configuration you want to retrieve.

Returns

If successful, retrieves a list of relay server configurations, or a specific relay server configuration. If unsuccessful, returns SUPAdminException.

Examples

Retrieval of a list of relay servers – retrieves a list of all relay server configurations.

Iterator<RelayServerVO> iter = suprs.getRelayServers().iterator();
		if (!iter.hasNext())
			return;
		RelayServerVO rsvo = iter.next();
		int id = rsvo.getID();

Retrieval of a relay server with a given ID – retrieves the relay server configuration with the given ID.
```
RelayServerVO rsvo_byId = suprs.getRelayServer(id);
```
Retrieval of a relay server with a given host and port – retrieves the relay server configuration with the given host name and port.
```
RelayServerVO rsvo_hostPort = suprs.getRelayServer(rsvo.getHost(),
				rsvo.getPort());
```