com.metamatrix.common.config.model
Class BasicHost

java.lang.Object
  extended by com.metamatrix.common.namedobject.BasicObject
      extended by com.metamatrix.common.config.model.BasicComponentObject
          extended by com.metamatrix.common.config.model.BasicComponentDefn
              extended by com.metamatrix.common.config.model.BasicHost
All Implemented Interfaces:
ComponentDefn, ComponentObject, Host, BaseObject, PropertiedObject, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable

public class BasicHost
extends BasicComponentDefn
implements Host

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface com.metamatrix.common.config.api.Host
HOST_COMPONENT_TYPE_ID
 
Fields inherited from interface com.metamatrix.common.config.api.ComponentDefn
AUTHPROVIDER_COMPONENT_CODE, CONFIGURATION_COMPONENT_CODE, CONNECTOR_COMPONENT_CODE, DEPLOYED_COMPONENT_CODE, HOST_COMPONENT_CODE, PRODUCT_COMPONENT_CODE, RESOURCE_DESCRIPTOR_COMPONENT_CODE, SERVICE_COMPONENT_CODE, SHARED_RESOURCE_COMPONENT_CODE, VM_COMPONENT_CODE
 
Constructor Summary
protected BasicHost(BasicHost component)
           
  BasicHost(ConfigurationID configID, HostID hostID, ComponentTypeID typeID)
           
 
Method Summary
 java.lang.Object clone()
          Return a deep cloned instance of this object.
 java.lang.String getBindAddress()
          Return the address that should be used to bind to the host
 java.lang.String getConfigDirectory()
           
 java.lang.String getDataDirectory()
          Returns the directory where data files created on this host machine should be located.
 java.lang.String getHostAddress()
          Return the physical host address.
 java.lang.String getLogDirectory()
          Returns the directory where log files created on this host machine should be located.
 java.lang.String getTempDirectory()
          Returns the temp directory that is used when setting the java.io.tmpdir envornment variable
 void setProperties(java.util.Properties props)
          Set the properties for this object.
 
Methods inherited from class com.metamatrix.common.config.model.BasicComponentDefn
getConfigurationID, isDependentUpon, isEnabled, isEssential
 
Methods inherited from class com.metamatrix.common.config.model.BasicComponentObject
accept, addProperties, addProperty, getComponentTypeID, getCreatedBy, getCreatedDate, getCreatedDateString, getDescription, getEditableProperties, getLastChangedBy, getLastChangedDate, getLastChangedDateString, getProperties, getProperty, removeProperties, removeProperty, setCreatedBy, setCreatedDate, setDescription, setLastChangedBy, setLastChangedDate, toString
 
Methods inherited from class com.metamatrix.common.namedobject.BasicObject
compareTo, equals, getFullName, getID, getName, hashCode, setID
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.metamatrix.common.config.api.ComponentDefn
getConfigurationID, isEnabled, isEssential
 
Methods inherited from interface com.metamatrix.common.config.api.ComponentObject
accept, getComponentTypeID, getCreatedBy, getCreatedDate, getDescription, getLastChangedBy, getLastChangedDate, getName, getProperties, getProperty, isDependentUpon
 
Methods inherited from interface com.metamatrix.common.namedobject.BaseObject
getFullName, getID
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Constructor Detail

BasicHost

public BasicHost(ConfigurationID configID,
                 HostID hostID,
                 ComponentTypeID typeID)

BasicHost

protected BasicHost(BasicHost component)
Method Detail

getDataDirectory

public java.lang.String getDataDirectory()
Description copied from interface: Host
Returns the directory where data files created on this host machine should be located. This maybe null, therfore, the data files will goto the current directory.

Specified by:
getDataDirectory in interface Host
Returns:
Since:
4.3
See Also:
Host.getDataDirectory()

getConfigDirectory

public java.lang.String getConfigDirectory()
Specified by:
getConfigDirectory in interface Host

getLogDirectory

public java.lang.String getLogDirectory()
Description copied from interface: Host
Returns the directory where log files created on this host machine should be located. This maybe null, therfore, the logfile will goto the current directory.

Specified by:
getLogDirectory in interface Host
Returns:
Since:
4.3
See Also:
Host.getLogDirectory()

getTempDirectory

public java.lang.String getTempDirectory()
Description copied from interface: Host
Returns the temp directory that is used when setting the java.io.tmpdir envornment variable

Specified by:
getTempDirectory in interface Host
Returns:
Since:
4.3
See Also:
Host.getTempDirectory()

clone

public java.lang.Object clone()
Return a deep cloned instance of this object. Subclasses must override this method.

Specified by:
clone in interface BaseObject
Overrides:
clone in class BasicObject
Returns:
the object that is the clone of this instance.

getBindAddress

public java.lang.String getBindAddress()
Return the address that should be used to bind to the host

Specified by:
getBindAddress in interface Host
Returns:
Since:
4.3

getHostAddress

public java.lang.String getHostAddress()
Return the physical host address. The physical may or may not be the same as the logical host name (@see #getID().getFullName())

Specified by:
getHostAddress in interface Host
Returns:
Since:
4.3

setProperties

public void setProperties(java.util.Properties props)
Description copied from class: BasicComponentObject
Set the properties for this object. If the argument is null, an empty Properties object is created.

Overrides:
setProperties in class BasicComponentObject
Parameters:
props - the set of properties for this service; a reference to this Properties instance should not be maintained by the caller


Copyright © 2009. All Rights Reserved.