|
EAC Toolkit 3.2.1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.endeca.soleng.eac.toolkit.base.EacElement com.endeca.soleng.eac.toolkit.base.Provisionable com.endeca.soleng.eac.toolkit.host.Host
public class Host
This class represents a host provisioned in the EAC, implementing provisioning methods.
Field Summary |
---|
Fields inherited from class com.endeca.soleng.eac.toolkit.base.EacElement |
---|
appName, dataPrefix, eacHost, eacPort, elementId, lockManager, logDir, sslEnabled, workingDir |
Constructor Summary | |
---|---|
Host()
Default constructor. |
|
Host(java.lang.String appName,
java.lang.String eacHost,
int eacPort,
java.lang.String hostId,
boolean sslEnabled,
java.lang.String dataPrefix,
java.lang.String workingDir)
Constructor to initialize the host object from its EAC definition, by retrieving the definition associated with the specified hostId. |
Method Summary | |
---|---|
com.endeca.eac.client.HostType |
buildEacStub()
Builds a HostType object to send to the EAC. |
void |
constructFromEacStub(com.endeca.eac.client.HostType hostType)
Populates the fields in this object from associated values in the HostType WSDL stub object. |
java.util.Map<java.lang.String,java.lang.String> |
getCustomDirectories()
|
java.lang.String |
getDirectory(java.lang.String dirName)
Retrieves the value of the directory with the specified name from the provisioned host. |
java.lang.String |
getHostName()
|
int |
getPort()
|
java.util.Map<java.lang.String,java.lang.String> |
getProperties()
|
java.lang.String |
getProperty(java.lang.String propName)
Retrieves the value of the property with the specified name from the provisioned host. |
com.endeca.eac.client.HostType |
instantiateEacStub()
|
boolean |
isDefined()
Checks whether the host is defined in the EAC. |
boolean |
isDefinitionChanged()
Compares the definition of the host in the EAC to the local definition. |
void |
removeDefinition()
Removes the EAC provisioning of this host. |
void |
setCustomDirectories(java.util.Map<java.lang.String,java.lang.String> customDirectories)
|
void |
setDefinition()
Sets the EAC provisioning of this host. |
void |
setHostName(java.lang.String hostName)
|
void |
setPort(int port)
|
void |
setProperties(java.util.Map<java.lang.String,java.lang.String> properties)
|
void |
updateDefinition()
Updates the EAC provisioning of this host. |
void |
updateEacDefinition()
|
Methods inherited from class com.endeca.soleng.eac.toolkit.base.Provisionable |
---|
getAppDefinitionFromEac, getCachedAppDefinition, getProvisioningPort, invalidateCachedAppDefinition, setCachedAppDefinition |
Methods inherited from class com.endeca.soleng.eac.toolkit.base.EacElement |
---|
getAppName, getDataPrefix, getEacHost, getEacPort, getElementId, getLockManager, getLogDir, getWorkingDir, isSslEnabled, setAppName, setDataPrefix, setEacHost, setEacPort, setElementId, setLockManager, setLogDir, setSslEnabled, setWorkingDir |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Host()
public Host(java.lang.String appName, java.lang.String eacHost, int eacPort, java.lang.String hostId, boolean sslEnabled, java.lang.String dataPrefix, java.lang.String workingDir) throws EacCommunicationException, EacProvisioningException, AppConfigurationException
hostId
- ID of the provisioned host to retrieve from the EAC.
EacCommunicationException
EacProvisioningException
AppConfigurationException
Method Detail |
---|
public java.lang.String getProperty(java.lang.String propName)
propName
- Name of the property whose value will be retrieved.
public java.lang.String getDirectory(java.lang.String dirName)
dirName
- Name of the provisioned directory whose value will be retrieved.
public boolean isDefinitionChanged() throws EacCommunicationException, EacProvisioningException
isDefinitionChanged
in class Provisionable
EacCommunicationException
- If a communication error occurs while
retrieving the provisioning port.
EacProvisioningException
- If an error occurs while trying to retrieve
the host definition from the EAC.public boolean isDefined() throws EacCommunicationException, EacProvisioningException
isDefined
in class Provisionable
EacCommunicationException
- If a communication error occurs while
retrieving the provisioning port.
EacProvisioningException
- If an error occurs while trying to retrieve
the component definition from the EAC.public void updateDefinition() throws EacCommunicationException, EacComponentControlException, EacProvisioningException, AppConfigurationException
updateDefinition
in class Provisionable
EacComponentControlException
- If an error occurs while trying to
start, stop or check the status of the component.
EacCommunicationException
- If a communication error occurs while
retrieving the provisioning port.
AppConfigurationException
- If a component configuration is invalid.
EacProvisioningException
- If an error occurs while provisioning the
host or its associated components.public void removeDefinition() throws EacCommunicationException
removeDefinition
in class Provisionable
EacCommunicationException
- If a communication error occurs while
retrieving the provisioning port.public void setDefinition() throws EacCommunicationException
setDefinition
in class Provisionable
EacCommunicationException
- If a communication error occurs while
setting the host definition.public void updateEacDefinition() throws EacCommunicationException, EacProvisioningException
EacCommunicationException
EacProvisioningException
public void constructFromEacStub(com.endeca.eac.client.HostType hostType)
hostType
- The HostType WSDL stub object from which to retrieve host
definition.public com.endeca.eac.client.HostType buildEacStub()
public com.endeca.eac.client.HostType instantiateEacStub()
public java.util.Map<java.lang.String,java.lang.String> getCustomDirectories()
public void setCustomDirectories(java.util.Map<java.lang.String,java.lang.String> customDirectories)
public java.util.Map<java.lang.String,java.lang.String> getProperties()
public void setProperties(java.util.Map<java.lang.String,java.lang.String> properties)
public java.lang.String getHostName()
public void setHostName(java.lang.String hostName)
public int getPort()
public void setPort(int port)
|
EAC Toolkit 3.2.1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@VERSION PRODUCT: EAC Toolkit (eacToolkit) VERSION: 3.2.1 BUILD: NONE ARCH_OS: n/a DATE: 2011-11-10T16:21:05-0500