com.buildforge.services.client.dbo
Class Geo

java.lang.Object
  extended by com.buildforge.services.client.dbo.Geo

public class Geo
extends java.lang.Object

This class represents a set of metadata describing a geographic database location for use with Globally Distributed Development.


Field Summary
static java.lang.Class<Geo> CLASS
           
 
Method Summary
static java.util.List<Geo> findAll(APIClientConnection conn)
          Retrives all Geo objects configured in the system
static Geo findById(APIClientConnection conn, java.lang.String geoId)
          Retrives a specific Geo site from the Build Forge system, by UUID
static Geo findByLocation(APIClientConnection conn, java.lang.String location)
          Retrives a specific Geo site from the Build Forge system, by Location
 boolean getActive()
          Returns whether or not this particular Geo is active (true if it is, false otherwise).
 java.lang.String getDatabaseName()
          Returns the name of the database at this particular Geo site, i.e.: "BUILD", "MyTableSpace", etc.
 java.lang.String getDatabaseType()
          Returns the type of the database at this particular Geo site, i.e.: "DB2", "Oracle", etc.
 java.lang.String getFailover()
          Returns the location name of the Geo site to which this Geo site will fail over to, in the case of failure, i.e.: "MyBackupPrimaryConsole"
 java.lang.String getGeoId()
          Returns the UUID identifier of this Geo site.
 java.lang.String getHostname()
          Returns the hostname of the Geo site.
 java.lang.String getLocation()
          Returns the user-specified location name for this Geo site.
 java.lang.String getPassword()
          Returns the password to be used to authenticate to the database application at this Geo site.
 java.lang.String getPort()
          Returns the port number on which the database application is listening at this Geo site.
 java.lang.String getUsername()
          Returns the username to be used to authenticate to the database application at this Geo site.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

CLASS

public static final java.lang.Class<Geo> CLASS
Method Detail

findAll

public static java.util.List<Geo> findAll(APIClientConnection conn)
                                   throws java.io.IOException,
                                          ServiceException
Retrives all Geo objects configured in the system

Parameters:
conn - A connected and authenticated APIClientConnection
Returns:
All located Geo objects defined in this Build Forge system
Throws:
java.io.IOException
ServiceException

findById

public static Geo findById(APIClientConnection conn,
                           java.lang.String geoId)
                    throws java.io.IOException,
                           ServiceException
Retrives a specific Geo site from the Build Forge system, by UUID

Parameters:
conn - A connected and authenticated APIClientConnection
geoId - The UUID of the Geo site to be retrieved
Returns:
The fully loaded Geo site object, or null if no such Geo site could be located
Throws:
java.io.IOException
ServiceException

findByLocation

public static Geo findByLocation(APIClientConnection conn,
                                 java.lang.String location)
                          throws java.io.IOException,
                                 ServiceException
Retrives a specific Geo site from the Build Forge system, by Location

Parameters:
conn - A connected and authenticated APIClientConnection
location - The Location name of the Geo site to be retrieved
Returns:
The fully loaded Geo site object, or null if no such Geo site could be found
Throws:
java.io.IOException
ServiceException

getActive

public boolean getActive()
Returns whether or not this particular Geo is active (true if it is, false otherwise).

Returns:
whether or not this particular Geo is active (true if it is, false otherwise).

getDatabaseName

public java.lang.String getDatabaseName()
Returns the name of the database at this particular Geo site, i.e.: "BUILD", "MyTableSpace", etc.

Returns:
the name of the database at this particular Geo site.

getDatabaseType

public java.lang.String getDatabaseType()
Returns the type of the database at this particular Geo site, i.e.: "DB2", "Oracle", etc.

Returns:
the type of the database at this particular Geo site.

getFailover

public java.lang.String getFailover()
Returns the location name of the Geo site to which this Geo site will fail over to, in the case of failure, i.e.: "MyBackupPrimaryConsole"

Returns:

getGeoId

public java.lang.String getGeoId()
Returns the UUID identifier of this Geo site.

Returns:
the UUID identifier of this Geo site.

getHostname

public java.lang.String getHostname()
Returns the hostname of the Geo site.

Returns:
the hostname of the Geo site.

getLocation

public java.lang.String getLocation()
Returns the user-specified location name for this Geo site.

Returns:
the user-specified location name for this Geo site.

getPassword

public java.lang.String getPassword()
Returns the password to be used to authenticate to the database application at this Geo site.

Returns:
the password to be used to authenticate to the database application at this Geo site.

getPort

public java.lang.String getPort()
Returns the port number on which the database application is listening at this Geo site.

Returns:
the port number on which the database application is listening at this Geo site.

getUsername

public java.lang.String getUsername()
Returns the username to be used to authenticate to the database application at this Geo site.

Returns:
the username to be used to authenticate to the database application at this Geo site.

toString

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