org.ow2.jasmine.jadort.service.action
Class ServerAction

java.lang.Object
  extended by org.ow2.jasmine.jadort.service.action.AbstractAction
      extended by org.ow2.jasmine.jadort.service.action.AbstractJMXAction
          extended by org.ow2.jasmine.jadort.service.action.ServerAction
Direct Known Subclasses:
DummyServerAction, GlassFishServerAction, JBossServerAction, JonasServerAction, OSGiServerAction, WebLogicServerAction, WebSphereServerAction

public abstract class ServerAction
extends AbstractJMXAction

Action for a server (JOnAS or other)

Author:
Malek Chahine, Remy Bresson, S. Ali Tokmen

Field Summary
static java.lang.String STATE_DEPLOYED
           
static java.lang.String STATE_PRESENT
           
 
Fields inherited from class org.ow2.jasmine.jadort.service.action.AbstractJMXAction
connector, JMX_CHECK_TIMEOUT, JMX_CONNECT_TIMEOUT, mbscnx
 
Constructor Summary
ServerAction()
           
 
Method Summary
abstract  boolean canDeployApplications()
           
abstract  boolean canStartStopServer()
           
abstract  void deploy(java.lang.String appName)
           
abstract  boolean enableOrDisableApplications(boolean enable)
          Enable or disable or enable all applications in this server.
abstract  void erase(java.lang.String appName)
           
abstract  int getActiveSessions()
           
abstract  int getActiveSessions(java.lang.String appName)
           
abstract  org.ow2.jasmine.jadort.api.entities.deployment.ApplicationBean getApplicationBean(java.lang.String appName)
           
protected static java.lang.reflect.Constructor<? extends ServerAction> getConstructor(java.lang.Class<? extends ServerAction> actionType)
           
static ServerAction getServerAction(org.ow2.jasmine.jadort.api.entities.topology.ServerBean server)
           
abstract  boolean isStarted()
           
abstract  java.util.List<org.ow2.jasmine.jadort.api.entities.deployment.ApplicationBean> listOfApplications()
           
protected static ServerAction newInstance(org.ow2.jasmine.jadort.api.entities.topology.ServerBean server)
           
protected static byte[] obtainByteData(java.io.File file)
          Reads bytes of a file
abstract  java.lang.String setDefault(java.lang.String appName)
           
abstract  void start()
          Start server
abstract  void stop()
          Stop server
abstract  void undeploy(java.lang.String appName)
           
abstract  java.lang.String upload(org.ow2.jasmine.jadort.api.entities.deployment.ApplicationBean application)
           
 
Methods inherited from class org.ow2.jasmine.jadort.service.action.AbstractJMXAction
checkJMXConnection, connectViaJMX, disconnectJMX, establishJMXConnection
 
Methods inherited from class org.ow2.jasmine.jadort.service.action.AbstractAction
appendToLog, flushLog
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

STATE_PRESENT

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

STATE_DEPLOYED

public static final java.lang.String STATE_DEPLOYED
See Also:
Constant Field Values
Constructor Detail

ServerAction

public ServerAction()
Method Detail

getServerAction

public static ServerAction getServerAction(org.ow2.jasmine.jadort.api.entities.topology.ServerBean server)

newInstance

protected static ServerAction newInstance(org.ow2.jasmine.jadort.api.entities.topology.ServerBean server)

getConstructor

protected static java.lang.reflect.Constructor<? extends ServerAction> getConstructor(java.lang.Class<? extends ServerAction> actionType)
                                                                               throws java.lang.Exception
Throws:
java.lang.Exception

listOfApplications

public abstract java.util.List<org.ow2.jasmine.jadort.api.entities.deployment.ApplicationBean> listOfApplications()
                                                                                                           throws java.lang.Exception
Returns:
List of applications currently present on this server, reformatted as ApplicationBean objects.
Throws:
java.lang.Exception

canDeployApplications

public abstract boolean canDeployApplications()
                                       throws java.lang.Exception
Returns:
true if this ServerAction can deploy applications, false otherwise.
Throws:
java.lang.Exception

canStartStopServer

public abstract boolean canStartStopServer()
                                    throws java.lang.Exception
Returns:
true if this ServerAction can start/stop the server, false otherwise.
Throws:
java.lang.Exception

upload

public abstract java.lang.String upload(org.ow2.jasmine.jadort.api.entities.deployment.ApplicationBean application)
                                 throws java.lang.Exception
Parameters:
application - ApplicationBean to upload.
Returns:
Name of the application as saved by the server, to use in the deploy(String) and setDefault(String), undeploy(String) and erase(String) methods.
Throws:
java.lang.Exception

getApplicationBean

public abstract org.ow2.jasmine.jadort.api.entities.deployment.ApplicationBean getApplicationBean(java.lang.String appName)
                                                                                           throws java.lang.Exception
Parameters:
appName - Name of the application, as returned by upload(ApplicationBean) or setDefault(String), for which to obtain an ApplicationBean.
Returns:
ApplicationBean corresponding to appName, null if nothing matches.
Throws:
java.lang.Exception

deploy

public abstract void deploy(java.lang.String appName)
                     throws java.lang.Exception
Parameters:
appName - Name of the application to deploy, as returned by upload(ApplicationBean) or setDefault(String).
Throws:
java.lang.Exception

setDefault

public abstract java.lang.String setDefault(java.lang.String appName)
                                     throws java.lang.Exception
Parameters:
appName - Name of the application to set as default version (previous Default version will become Disabled), as returned by upload(ApplicationBean) or setDefault(String).
Returns:
Old application that was default.
Throws:
java.lang.Exception

undeploy

public abstract void undeploy(java.lang.String appName)
                       throws java.lang.Exception
Parameters:
appName - Name of the application to undeploy, as returned by upload(ApplicationBean) or setDefault(String).
Throws:
java.lang.Exception

erase

public abstract void erase(java.lang.String appName)
                    throws java.lang.Exception
Parameters:
appName - Name of the application to erase, as returned by upload(ApplicationBean) or setDefault(String).
Throws:
java.lang.Exception

getActiveSessions

public abstract int getActiveSessions(java.lang.String appName)
                               throws java.lang.Exception
Parameters:
appName - Name of the application for which to get the number of active sessions, as returned by upload(ApplicationBean) or setDefault(String).
Returns:
Number of active sessions on application named appName.
Throws:
java.lang.Exception

getActiveSessions

public abstract int getActiveSessions()
                               throws java.lang.Exception
Returns:
Number of active sessions on all applications of this server.
Throws:
java.lang.Exception

start

public abstract void start()
                    throws java.lang.Exception
Start server

Throws:
java.lang.Exception

stop

public abstract void stop()
                   throws java.lang.Exception
Stop server

Throws:
java.lang.Exception

isStarted

public abstract boolean isStarted()
Returns:
true if server started, false otherwise.

enableOrDisableApplications

public abstract boolean enableOrDisableApplications(boolean enable)
                                             throws java.lang.Exception
Enable or disable or enable all applications in this server.

Parameters:
enable - true to enable all applications, false to disable all applications.
Returns:
true if disabling all applications has succeeded, false otherwise. An exception should only be thrown if a real error occurs.
Throws:
java.lang.Exception

obtainByteData

protected static byte[] obtainByteData(java.io.File file)
                                throws java.io.IOException
Reads bytes of a file

Parameters:
file - File to read.
Returns:
byte contents of the file.
Throws:
java.io.IOException


Copyright © 2010 OW2 Consortium. All Rights Reserved.