Oracle Secure Global Desktop Web Services API Documentation
Release 4.7

E21396-02

com.tarantella.tta.webservices.vsbim
Interface ICandidateServer

All Superinterfaces:
java.lang.Comparable<ICandidateServer>, java.io.Serializable
All Known Implementing Classes:
CandidateServer, UserDefinableCandidateServer

public interface ICandidateServer
extends java.lang.Comparable<ICandidateServer>, java.io.Serializable

This interface represents a server on which an application or a desktop can be launched. Typically, it is returned from a broker implementing IVirtualServerBroker.

Most of the properties are optional and may be null. To be valid, an object implementing this interface must return a non-null value for either the hostname or the IP address.

Since:
1.3

Method Summary
 int compareTo(ICandidateServer lc)
          Compares this object with the specified object for ordering.
 boolean equalsIgnoreType(ICandidateServer lc)
          Tests whether the given object is equal to this one.
 java.lang.String getConnectionProtocol()
          Gets the protocol to use when connecting to the server.
 java.lang.String getDescription()
          Gets the description of the server.
 java.lang.String getDomain()
          Gets the domain that the server is in.
 java.lang.String getHostname()
          Gets the name of the server.
 java.lang.String getIpAddress()
          Gets the IP address of the server.
 java.lang.String getPassword()
          Gets the password of an account on the server.
 java.lang.String getPermanentName()
          Gets the name to be used if an application server is created when this candidate is used.
 java.lang.String getPort()
          Gets the port for connections to the server.
 java.lang.String getType()
          Gets the type of the server.
 java.lang.String getUsername()
          Gets the username of an account on the server.
 boolean isFallback()
          Gets the fallback flag.
 boolean isPermanent()
          Gets the flag indicating whether SGD should create an application server in the datastore if one does not already exist and this candidate is used.
 boolean isUserDefinable()
          Tests if the broker permits users to override the server definition.
 

Method Detail

getIpAddress

java.lang.String getIpAddress()
Gets the IP address of the server.

Returns:
The IP address of the server.
Since:
1.3

getHostname

java.lang.String getHostname()
Gets the name of the server.

Returns:
The name of the server.
Since:
1.3

getDescription

java.lang.String getDescription()
Gets the description of the server. This is a user-friendly description of the server.

Returns:
The description of the server.
Since:
1.3

getUsername

java.lang.String getUsername()
Gets the username of an account on the server.

Returns:
The username of an account on the server.
Since:
1.3

getPassword

java.lang.String getPassword()
Gets the password of an account on the server.

Returns:
The password of an account on the server.
Since:
1.3

getDomain

java.lang.String getDomain()
Gets the domain that the server is in.

Returns:
The domain that the server is in.
Since:
1.3

getConnectionProtocol

java.lang.String getConnectionProtocol()
Gets the protocol to use when connecting to the server.

Returns:
The connection protocol to use.
Since:
1.3

isPermanent

boolean isPermanent()
Gets the flag indicating whether SGD should create an application server in the datastore if one does not already exist and this candidate is used.

Returns:
true if an application server should be created, otherwise false.
Since:
1.3

getPermanentName

java.lang.String getPermanentName()
Gets the name to be used if an application server is created when this candidate is used. If isPermanent() returns false, the name will not be used.

Returns:
The name of the application server, if it is created.
Since:
1.3

getType

java.lang.String getType()
Gets the type of the server.

The type is used to differentiate between groups of equivalent servers. For example, "TypeU" could be used to identify a group of servers running one operating system and "TypeW" a group running a different operating system. Ideally, this should be meaningful to users.

Returns:
The type string associated with the server.
Since:
1.3

getPort

java.lang.String getPort()
Gets the port for connections to the server.

Returns:
The port for connections to the server.
Since:
1.3

isUserDefinable

boolean isUserDefinable()
Tests if the broker permits users to override the server definition.

Returns:
true if the server definition can be overridden, otherwise false.
Since:
1.3

isFallback

boolean isFallback()
Gets the fallback flag. Servers with this flag set to true are intended as reserve servers and are not preferred choices.

Returns:
true if this server is a fallback server, otherwise false.
Since:
1.3

equalsIgnoreType

boolean equalsIgnoreType(ICandidateServer lc)
Tests whether the given object is equal to this one. The type attribute of the two objects is ignored.

Parameters:
lc - The object to check for equality to this object.
Returns:
true if the objects are equal, otherwise false.
Since:
1.3

compareTo

int compareTo(ICandidateServer lc)
Compares this object with the specified object for ordering. Returns a negative integer, zero, or a positive integer respectively when this object is less than, equal to, or greater than the specified object.

Specified by:
compareTo in interface java.lang.Comparable<ICandidateServer>
Parameters:
lc - the object to be compared.
Returns:
a negative integer, zero, or a positive integer respectively when this object is less than, equal to, or greater than the specified object.
See Also:
Comparable.compareTo(java.lang.Object)

Oracle Secure Global Desktop Web Services API Documentation
Release 4.7

E21396-02

Copyright © 2012, 2013, Oracle and/or its affiliates. All rights reserved.