Package com.sun.enterprise.admin.servermgmt

Interface InstancesManager

public interface InstancesManager

Method Summary

Modifier and Type	Method	Description
void	createInstance()	Creates a server instance.
void	deleteInstance()	Deletes an instance identified by the given name.
int	getInstanceStatus()	Returns status of an instance.
String	getNativeName()
boolean	isRestartNeeded()
void	killRelatedProcesses()
String[]	listInstances()	Lists all the instances.
Process	startInstance()	Starts the instance.
Process	startInstance(String[] interativeOptions)	Starts the instance.
Process	startInstance(String[] interativeOptions, String[] commandLineArgs)	Starts the instance.
Process	startInstance(String[] interativeOptions, String[] commandLineArgs, Properties envProps)	Starts the instance.
void	stopInstance()	Stops the instance.
boolean	stopInstanceWithinTime(int timeout)	Trys to stop the instance with the specified timeout.

Method Detail

createInstance

void createInstance()
             throws InstanceException

Creates a server instance.

Throws:

InstanceException - This exception is thrown if - the instance already exists. - an invalid or insufficient config. is supplied. - an exception occurred during instance creation.

deleteInstance

void deleteInstance()
             throws InstanceException

Deletes an instance identified by the given name. (Should we stop the instance before deleting the instance?)

Throws:

InstanceException - This exception is thrown if - the instance doesnot exist. - an exception occurred while deleting the instance.

startInstance

Process startInstance()
               throws InstanceException

Starts the instance.

Parameters:

startParams -

Throws:

InstanceException

startInstance

Process startInstance(String[] interativeOptions)
               throws InstanceException

Starts the instance.

Parameters:

interativeOptions - which may be used for security, these paramters are passed in on the standard input stream of the executing process

Throws:

InstanceException

startInstance

Process startInstance(String[] interativeOptions,
                      String[] commandLineArgs)
               throws InstanceException

Starts the instance.

Parameters:

interativeOptions - which may be used for security, these paramters are passed in on the standard input stream of the executing process

commandLineArgs - is additional commandline arguments that are to be appended to the processes commandline when it starts

Throws:

InstanceException

startInstance

Process startInstance(String[] interativeOptions,
                      String[] commandLineArgs,
                      Properties envProps)
               throws InstanceException

Starts the instance.

Parameters:

interativeOptions - which may be used for security, these paramters are passed in on the standard input stream of the executing process

commandLineArgs - is additional commandline arguments that are to be appended to the processes commandline when it starts

envProps - properties to be added to System

Throws:

InstanceException

stopInstance

void stopInstance()
           throws InstanceException

Stops the instance.

Throws:

InstanceException

listInstances

String[] listInstances()
                throws InstanceException

Lists all the instances.

Throws:

InstanceException

getInstanceStatus

int getInstanceStatus()
               throws InstanceException

Returns status of an instance.

Throws:

InstanceException

isRestartNeeded

boolean isRestartNeeded()
                 throws InstanceException

Returns:

true if the instance requires a restart for some config changes to take effect, false otherwise.

Throws:

InstanceException

getNativeName

String getNativeName()

stopInstanceWithinTime

boolean stopInstanceWithinTime(int timeout)
                        throws InstanceException

Trys to stop the instance with the specified timeout. Returns true if success; false if failure

Throws:

InstanceException

killRelatedProcesses

void killRelatedProcesses()
                   throws InstanceException

Throws:

InstanceException