com.buildforge.services.common.dbo
Class ServerAuthDBO

java.lang.Object
  extended by com.buildforge.services.common.dbo.DBObject
      extended by com.buildforge.services.common.dbo.ServerAuthDBO

public class ServerAuthDBO
extends DBObject

Database information representing server authentication data. Server auth entries contain login information for servers. The password is provided strictly on a need-to-know basis, and will always return null for API users.


Field Summary
static java.lang.Class<ServerAuthDBO> CLASS
           
 java.lang.String password
           
static java.lang.String TYPE_KEY
           
 
Constructor Summary
ServerAuthDBO()
           
 
Method Summary
 ServerAuthDBO fromArray(java.lang.Object[] data)
          Deserialize the database object's settings from a request array.
 java.lang.String getAuthId()
           
 int getLevel()
           
 java.lang.String getLiveAuthId()
           
 java.lang.String getPassword()
           
 java.lang.String getTypeKey()
          Retrieve the key that should be used to look up the display name for a data type.
 java.lang.String getUsername()
           
 boolean isLive()
          Checks whether or not the object is live.
 void setAuthId(java.lang.String authId)
           
 void setLevel(int level)
           
 void setLiveAuthId(java.lang.String id)
           
 void setPassword(java.lang.String password)
           
 void setUsername(java.lang.String username)
           
 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

TYPE_KEY

public static final java.lang.String TYPE_KEY
See Also:
Constant Field Values

CLASS

public static final java.lang.Class<ServerAuthDBO> CLASS

password

public java.lang.String password
Constructor Detail

ServerAuthDBO

public ServerAuthDBO()
Method Detail

getTypeKey

public java.lang.String getTypeKey()
Description copied from class: DBObject
Retrieve the key that should be used to look up the display name for a data type.

Specified by:
getTypeKey in class DBObject
Returns:
the type key for this object's class

isLive

public boolean isLive()
Description copied from class: DBObject
Checks whether or not the object is live. Note that this is not valid for object types that do not have a unique identifier. Those for which no reasonable implementation exists should always return false.

Specified by:
isLive in class DBObject
Returns:
true iff liveness is a valid concept for this object, and the object is live; otherwise, false is returned.

getLiveAuthId

public java.lang.String getLiveAuthId()

getAuthId

public java.lang.String getAuthId()

getLevel

public int getLevel()

getUsername

public java.lang.String getUsername()

getPassword

public java.lang.String getPassword()

setLiveAuthId

public void setLiveAuthId(java.lang.String id)

setAuthId

public void setAuthId(java.lang.String authId)

setLevel

public void setLevel(int level)

setUsername

public void setUsername(java.lang.String username)

setPassword

public void setPassword(java.lang.String password)

fromArray

public ServerAuthDBO fromArray(java.lang.Object[] data)
                        throws APIException
Description copied from class: DBObject
Deserialize the database object's settings from a request array. This method is used to reconstruct a database object from the array that was created by DBObject.toArray().

Specified by:
fromArray in class DBObject
Parameters:
data - the object list that renders this object
Returns:
this object, for convenience
Throws:
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.

toArray

public java.lang.Object[] toArray()
Description copied from class: DBObject
Serializes this database object as an array of objects. As specified in the description for Protocol, all supported protocols transfer database objects in this form.

Specified by:
toArray in class DBObject

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object