|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.buildforge.services.common.dbo.DBObject
com.buildforge.services.common.dbo.ServerDBO
public class ServerDBO
Database information representing the definition of a logical server.
Nested Class Summary | |
---|---|
static class |
ServerDBO.Error
Specifies whether or not an error was encountered while testing the connection to this server. |
static class |
ServerDBO.Publish
Specifies what types of file publishing are permitted for the server. |
static class |
ServerDBO.Upstate
Specifies whether or not the server's readiness is currently in flux. |
Field Summary | |
---|---|
static java.lang.Class<ServerDBO> |
CLASS
|
static java.lang.String |
TYPE_KEY
|
Constructor Summary | |
---|---|
ServerDBO()
|
Method Summary | |
---|---|
ServerDBO |
fromArray(java.lang.Object[] data)
Deserialize the database object's settings from a request array. |
boolean |
getActive()
|
java.lang.String |
getAuthId()
|
java.lang.String |
getCollectorId()
|
int |
getEnvironmentId()
|
ServerDBO.Error |
getError()
|
java.lang.String |
getHost()
|
int |
getLevel()
|
java.lang.String |
getName()
|
java.lang.String |
getPath()
|
ServerDBO.Publish |
getPublish()
|
int |
getServerId()
|
java.lang.String |
getTestKey()
|
java.lang.String |
getTestText()
|
java.lang.String |
getTypeKey()
Retrieve the key that should be used to look up the display name for a data type. |
ServerDBO.Upstate |
getUpstate()
|
boolean |
isLive()
Checks whether or not the object is live. |
static void |
sanityCheckId(int serverId)
|
static void |
sanityCheckName(java.lang.String serverName)
|
void |
setActive(boolean active)
|
void |
setAuthId(java.lang.String authId)
|
void |
setCollectorId(java.lang.String collectorId)
|
void |
setEnvironmentId(int environmentId)
|
void |
setError(ServerDBO.Error error)
|
void |
setHost(java.lang.String host)
|
void |
setLevel(int level)
|
void |
setName(java.lang.String name)
|
void |
setPath(java.lang.String path)
|
void |
setPublish(ServerDBO.Publish publish)
|
void |
setServerId(int serverId)
|
void |
setTestKey(java.lang.String testKey)
|
void |
setTestText(java.lang.String testText)
|
void |
setUpstate(ServerDBO.Upstate upstate)
|
java.lang.Object[] |
toArray()
Serializes this database object as an array of objects. |
java.lang.String |
toString()
|
Methods inherited from class com.buildforge.services.common.dbo.DBObject |
---|
badId, badName, checkDead, checkLive, collision, collision |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String TYPE_KEY
public static final java.lang.Class<ServerDBO> CLASS
Constructor Detail |
---|
public ServerDBO()
Method Detail |
---|
public java.lang.String getTypeKey()
DBObject
getTypeKey
in class DBObject
public boolean isLive()
DBObject
isLive
in class DBObject
public boolean getActive()
public java.lang.String getAuthId()
public java.lang.String getCollectorId()
public int getEnvironmentId()
public ServerDBO.Error getError()
public java.lang.String getHost()
public int getLevel()
public java.lang.String getName()
public java.lang.String getPath()
public ServerDBO.Publish getPublish()
public int getServerId()
public java.lang.String getTestKey()
public java.lang.String getTestText()
public ServerDBO.Upstate getUpstate()
public void setActive(boolean active)
public void setAuthId(java.lang.String authId)
public void setCollectorId(java.lang.String collectorId)
public void setEnvironmentId(int environmentId)
public void setError(ServerDBO.Error error)
public void setHost(java.lang.String host)
public void setLevel(int level)
public void setName(java.lang.String name)
public void setPath(java.lang.String path)
public void setPublish(ServerDBO.Publish publish)
public void setServerId(int serverId)
public void setTestKey(java.lang.String testKey)
public void setTestText(java.lang.String testText)
public void setUpstate(ServerDBO.Upstate upstate)
public static void sanityCheckId(int serverId) throws APIException
APIException
public static void sanityCheckName(java.lang.String serverName) throws APIException
APIException
public java.lang.String toString()
toString
in class java.lang.Object
public ServerDBO fromArray(java.lang.Object[] data) throws APIException
DBObject
DBObject.toArray()
.
fromArray
in class DBObject
data
- the object list that renders this object
APIException
- if there is something wrong with the
serialized data that interferes with the reconstruction of
the object. The most obvious reason for this would be if
the serialized array contains the wrong number of fields
or otherwise does not match the serialized form for this
type of database object.public java.lang.Object[] toArray()
DBObject
Protocol
, all supported
protocols transfer database objects in this form.
toArray
in class DBObject
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |