|
Oracle Secure Global Desktop Web Services API Documentation Release 4.7 E21396-02 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.tarantella.tta.webservices.vsbim.CandidateServer
public class CandidateServer
This class implements
ICandidateServer
.
It represents a server returned from a broker implementing
IVirtualServerBroker
.
Constructor Summary | |
---|---|
CandidateServer(ICandidateServer lc)
Constructor. |
|
CandidateServer(java.lang.String hostname)
Constructor. |
|
CandidateServer(java.lang.String ipAddress,
java.lang.String hostname)
Constructor. |
Method Summary | |
---|---|
int |
compareTo(ICandidateServer lc)
Compares this object with the specified object for ordering. |
boolean |
equals(java.lang.Object o)
|
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. |
int |
hashCode()
Returns a hash code value for the CandidateServer. |
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. |
void |
setConnectionProtocol(java.lang.String connectionProtocol)
Sets the protocol to use when connecting to server. |
void |
setDescription(java.lang.String description)
Sets the description of the server |
void |
setDomain(java.lang.String domain)
Sets the domain the server is in. |
void |
setFallback(boolean isFallback)
Sets the fallback flag. |
boolean |
setHostname(java.lang.String hostname)
Sets the name of the server |
boolean |
setIpAddress(java.lang.String ipAddress)
Sets the IP address of the server |
void |
setPassword(java.lang.String password)
Sets the password of an account on the server. |
void |
setPermanent(boolean permanent)
Sets the flag requesting SGD to create an application server if this candidate is used. |
void |
setPermanentName(java.lang.String permanentName)
Sets the name to be used if SGD should create an application server when this candidate is used. |
void |
setPort(java.lang.String port)
Sets the port for connections to the server. |
void |
setType(java.lang.String type)
Sets the type parameter. |
void |
setUsername(java.lang.String username)
Sets the username of an account on the server. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public CandidateServer(java.lang.String ipAddress, java.lang.String hostname)
At least one of ipAddress
or hostname
must be
non-null.
ipAddress
- The IP address of the server. Can only be null if
hostname
is not null.hostname
- The name of the server. Can only be null if
ipAddress
is not null.public CandidateServer(java.lang.String hostname)
hostname
- The name of the server. It cannot be null.public CandidateServer(ICandidateServer lc)
The details from the supplied object are copied into the newly created instance.
lc
- The object to copy.Method Detail |
---|
public java.lang.String getIpAddress()
ICandidateServer
getIpAddress
in interface ICandidateServer
public boolean setIpAddress(java.lang.String ipAddress)
ipAddress
- The IP address to set for this server. This can only be
set to null if the hostname is not null.
public java.lang.String getHostname()
ICandidateServer
getHostname
in interface ICandidateServer
public boolean setHostname(java.lang.String hostname)
hostname
- The name to set for this server. This can only be set to
null if the IP address is not null.
public java.lang.String getDescription()
ICandidateServer
getDescription
in interface ICandidateServer
public void setDescription(java.lang.String description)
description
- The description to set for the server.public java.lang.String getUsername()
ICandidateServer
getUsername
in interface ICandidateServer
public void setUsername(java.lang.String username)
username
- The username of an account on the server.public java.lang.String getPassword()
ICandidateServer
getPassword
in interface ICandidateServer
public void setPassword(java.lang.String password)
password
- The password of an account on the server.public java.lang.String getDomain()
ICandidateServer
getDomain
in interface ICandidateServer
public void setDomain(java.lang.String domain)
domain
- The domain to set for the server
.public java.lang.String getConnectionProtocol()
ICandidateServer
getConnectionProtocol
in interface ICandidateServer
public void setConnectionProtocol(java.lang.String connectionProtocol)
connectionProtocol
- The connection protocol to use.public boolean isPermanent()
ICandidateServer
isPermanent
in interface ICandidateServer
public void setPermanent(boolean permanent)
permanent
- true if an application server should be
created, otherwise false.public java.lang.String getPermanentName()
ICandidateServer
ICandidateServer.isPermanent()
returns false, the name will not be used.
getPermanentName
in interface ICandidateServer
public void setPermanentName(java.lang.String permanentName)
Note that setting this name alone
does not guarantee that an application server will be
created, use setPermanent(boolean)
to do that. If the name
is not set, but an application server is created, then SGD chooses the name
of the application server. It is based off the host name or IP Address of
the server used for the launch.
permanentName
- The name that will be used if an
application server object is created when this
candidate is used. A value of null implies that no
name has been set, and a name will be generated as
per the default behaviour.setPermanent(boolean)
,
isPermanent()
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String getType()
ICandidateServer
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.
getType
in interface ICandidateServer
public void setType(java.lang.String type)
type
- The type for the group to which this candidate belongs.getType()
public java.lang.String getPort()
ICandidateServer
getPort
in interface ICandidateServer
public void setPort(java.lang.String port)
port
- The port to be set for the candidate.public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public boolean equalsIgnoreType(ICandidateServer lc)
ICandidateServer
equalsIgnoreType
in interface ICandidateServer
lc
- The object to check for equality to this object.
public int hashCode()
hashCode
in class java.lang.Object
public boolean isUserDefinable()
ICandidateServer
isUserDefinable
in interface ICandidateServer
false
public boolean isFallback()
ICandidateServer
true
are
intended as reserve servers and are not preferred choices.
isFallback
in interface ICandidateServer
public void setFallback(boolean isFallback)
isFallback
- true if this server is intended as a fallback server,
otherwise false.isFallback()
public int compareTo(ICandidateServer lc)
ICandidateServer
compareTo
in interface ICandidateServer
compareTo
in interface java.lang.Comparable<ICandidateServer>
lc
- the object to be compared.
Comparable.compareTo(java.lang.Object)
|
Oracle Secure Global Desktop Web Services API Documentation Release 4.7 E21396-02 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |