com.neeve.robin
Class Controller

java.lang.Object
  extended by com.neeve.robin.Controller

public final class Controller
extends Object

The Robin controller.


Constructor Summary
Controller()
          Creates a robin Controller on the default discovery network.
 
Method Summary
 void checkAndDeployNewXars()
          Checks the deploy folder for new XARs to extract
 void close()
          Closes the Controller and it's underlying deployment Model.
static Controller create(String discoveryDescriptor)
           
 Script createScript(System system)
          Create an executable script
 File getDistribution()
          Get the configured distribution
 String getDistributionPlatform()
          Get the configured distribution's platform
 String getJavaHome()
          Get the configured JAVA_HOME
 com.neeve.deploy.Model getModel()
          Get the underlying model instance
 String getRobinHome()
          Get the configured ROBIN_HOME
 String getSshKeyFile()
          Get the configured SSH key file
 String getSshUser()
          Get the configured SSH user
 List<String> getSystemNames()
          Get the names of the deployed systems
 int getXVMCommandTimeout()
           
 int getXVMLaunchTimeout()
           
 boolean isTreatUnreachableXVMAsNonFatal()
           
static void main(String[] args)
           
 File resolveSystemHome(String systemName)
          Resolve the root directory of a system
 Controller setTraceSniffer(TraceSniffer traceSniffer)
          Set the controller trace sniffer
 void setTreatUnreachableXVMAsNonFatal(boolean val)
          Set to not treat an unreachable XVM as a fatal error
 Controller setTroubleshootingTraceSniffer(TraceSniffer traceSniffer)
          Set the controller troubleshooting trace sniffer
 void setXVMCommandTimeout(int xvmCommandTimeout)
          Set the timeout for synchronous XVM requests (in milliseconds)
 void setXVMLaunchTimeout(int xvmLaunchTimeout)
          Sets the timeout for XVM launches (in seconds)
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Controller

public Controller()
           throws Exception
Creates a robin Controller on the default discovery network.

Throws:
Exception
Method Detail

create

public static Controller create(String discoveryDescriptor)
                         throws Exception
Parameters:
discoveryDescriptor - The descriptor for the discovery network on which to listen
Returns:
A new Controller;
Throws:
Exception - If there is an error creating the Controller

resolveSystemHome

public final File resolveSystemHome(String systemName)
Resolve the root directory of a system


getRobinHome

public final String getRobinHome()
Get the configured ROBIN_HOME


getJavaHome

public final String getJavaHome()
Get the configured JAVA_HOME


getSshUser

public final String getSshUser()
Get the configured SSH user


getSshKeyFile

public final String getSshKeyFile()
Get the configured SSH key file


getDistribution

public final File getDistribution()
Get the configured distribution


getDistributionPlatform

public final String getDistributionPlatform()
Get the configured distribution's platform


setTraceSniffer

public final Controller setTraceSniffer(TraceSniffer traceSniffer)
Set the controller trace sniffer


setTroubleshootingTraceSniffer

public final Controller setTroubleshootingTraceSniffer(TraceSniffer traceSniffer)
Set the controller troubleshooting trace sniffer


setXVMLaunchTimeout

public final void setXVMLaunchTimeout(int xvmLaunchTimeout)
Sets the timeout for XVM launches (in seconds)


getXVMLaunchTimeout

public final int getXVMLaunchTimeout()
Returns:
The timeout for XVM launches.

setXVMCommandTimeout

public final void setXVMCommandTimeout(int xvmCommandTimeout)
Set the timeout for synchronous XVM requests (in milliseconds)


getXVMCommandTimeout

public final int getXVMCommandTimeout()
Returns:
The timeout for synchronous XVM requests.

setTreatUnreachableXVMAsNonFatal

public final void setTreatUnreachableXVMAsNonFatal(boolean val)
Set to not treat an unreachable XVM as a fatal error


isTreatUnreachableXVMAsNonFatal

public final boolean isTreatUnreachableXVMAsNonFatal()
Returns:
Whether unreachable XVM is treated as a fatal error

getModel

public final com.neeve.deploy.Model getModel()
Get the underlying model instance


getSystemNames

public final List<String> getSystemNames()
Get the names of the deployed systems


checkAndDeployNewXars

public final void checkAndDeployNewXars()
Checks the deploy folder for new XARs to extract


createScript

public final Script createScript(System system)
                          throws Exception
Create an executable script

Throws:
Exception

close

public final void close()
Closes the Controller and it's underlying deployment Model.

If the controller is using the default discovery provider this method will not close it, otherwise the discovery provider used by this controller will be closed as a result of this call.


main

public static void main(String[] args)
                 throws Exception
Throws:
Exception


Copyright © 2016 Neeve Research, LLC. All Rights Reserved.