com.wowza.wms.application

Interface IApplication

public interface IApplication

IApplication: public interface to Application object

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_APPLICATION_NAME

Method Summary

Methods

Modifier and Type	Method and Description
void	addApplicationInstanceListener(IApplicationInstanceNotify applicationInstanceListener) Add applicationInstance listener.
IApplicationInstance	getAppInstance(String name) Get applicationInstance object by name
java.util.List<String>	getAppInstanceNames() Get a list of application instance names
String	getApplicationPath() Get the root path for application
String	getConfigPath() Get full path to Application.xml file
ConnectionCounter	getConnectionCounter() Get the connectionCounter for application
com.wowza.wms.client.ConnectionCounterSimple	getConnectionCounter(int counterIndex) Get the connectionCounter for application for application for a specific technology (see IVHost.COUNTER_*)
String	getDateStarted() Get date application started
IOPerformanceCounter	getIoPerformanceCounter() Get the performance counter for application
IOPerformanceCounter	getIoPerformanceCounter(int counterIndex) Get the performance counter for application for a specific technology (see IVHost.COUNTER_*)
String	getName() Get the name of application
WMSProperties	getProperties() Get application properties
void	getProtocolUsage(boolean[] protocolsInUse) Get the protocols in use by this application instance (see IApplicationInstance.PROTCOLUSAGE_*)
String	getTimeRunning() Get time application running
double	getTimeRunningSeconds() Get time running in seconds
IVHost	getVHost() Get the parent vHost object
boolean	isAppInstanceLoaded(String name) Return true if application instance is loaded
boolean	isRunning() Returns true if the application is in running state
String	readAppConfig(String sName) Method to read xml config file..
void	removeAppInstance(IApplicationInstance appInstance) Disconnect all clients connected to an application instance and remove it from the IApplication application list.
void	removeApplicationInstanceListener(IApplicationInstanceNotify applicationInstanceListener) Remove applicationInstance listener.
void	setName(String name) Set name of application
void	shutdown(boolean isServerShutdown) shutdown application
void	shutdownAppInstance(String appInstanceName) Shutdown an application instance by name.
boolean	writeAppConfig(String sName, String data) Method to write xml config file..

Field Detail

DEFAULT_APPLICATION_NAME

static final String DEFAULT_APPLICATION_NAME

See Also:

Constant Field Values

Method Detail

addApplicationInstanceListener

void addApplicationInstanceListener(IApplicationInstanceNotify applicationInstanceListener)

Add applicationInstance listener. Will be invoked each time applicationInstance created/deleted

Parameters:

applicationInstanceListener - applicationInstance listener

getAppInstance

IApplicationInstance getAppInstance(String name)

Get applicationInstance object by name

Parameters:

name - applicationInstance name

Returns:

appliationInstance object

getAppInstanceNames

java.util.List<String> getAppInstanceNames()

Get a list of application instance names

Returns:

list of application instance names

getApplicationPath

String getApplicationPath()

Get the root path for application

Returns:

root path for application

getConfigPath

String getConfigPath()

Get full path to Application.xml file

Returns:

full path to Application.xml file

getConnectionCounter

ConnectionCounter getConnectionCounter()

Get the connectionCounter for application

Returns:

connectionCounter for application

getConnectionCounter

com.wowza.wms.client.ConnectionCounterSimple getConnectionCounter(int counterIndex)

Get the connectionCounter for application for application for a specific technology (see IVHost.COUNTER_*)

Parameters:

counterIndex - counter index (see IVHost.COUNTER_*)

Returns:

connection ocunter

getDateStarted

String getDateStarted()

Get date application started

Returns:

date application started

getIoPerformanceCounter

IOPerformanceCounter getIoPerformanceCounter()

Get the performance counter for application

Returns:

performance counter for application

getIoPerformanceCounter

IOPerformanceCounter getIoPerformanceCounter(int counterIndex)

Get the performance counter for application for a specific technology (see IVHost.COUNTER_*)

Parameters:

counterIndex - counter index (see IVHost.COUNTER_*)

Returns:

performance counter

getName

String getName()

Get the name of application

Returns:

name of application

getProperties

WMSProperties getProperties()

Get application properties

Returns:

application properties

getProtocolUsage

void getProtocolUsage(boolean[] protocolsInUse)

Get the protocols in use by this application instance (see IApplicationInstance.PROTCOLUSAGE_*)

getTimeRunning

String getTimeRunning()

Get time application running

Returns:

time application running

getTimeRunningSeconds

double getTimeRunningSeconds()

Get time running in seconds

Returns:

time running in seconds

getVHost

IVHost getVHost()

Get the parent vHost object

Returns:

parent vHost

isAppInstanceLoaded

boolean isAppInstanceLoaded(String name)

Return true if application instance is loaded

Parameters:

name - applicationInstance name

Returns:

true if application instance is loaded

isRunning

boolean isRunning()

Returns true if the application is in running state

Returns:

true if the application is in running state

readAppConfig

String readAppConfig(String sName)

Method to read xml config file..

removeAppInstance

void removeAppInstance(IApplicationInstance appInstance)

Disconnect all clients connected to an application instance and remove it from the IApplication application list. The proper way to call this is:

public void shutdownAppInstance(IApplicationInstance appInstance)
{
        IVHost vhost = appInstance.getVHost();
        IApplication app = appInstance.getApplication();

        WMSReadWriteLock appLock = vhost.getApplicationLock();
        appLock.writeLock().lock();
        try
        {
                app.removeAppInstance(appInstance);
        }
        catch (Exception e)
        {
                WMSLoggerFactory.getLogger(Application.class).error("Application.shutdownAppInstance ", e);
        }
        finally
        {
                appLock.writeLock().unlock();
        }
}

Parameters:

appInstance - application instance to remove

removeApplicationInstanceListener

void removeApplicationInstanceListener(IApplicationInstanceNotify applicationInstanceListener)

Remove applicationInstance listener. Will be invoked each time applicationInstance created/deleted

Parameters:

applicationInstanceListener - applicationInstance listener

setName

void setName(String name)

Set name of application

Parameters:

name - name of application

shutdown

void shutdown(boolean isServerShutdown)

shutdown application

Parameters:

isServerShutdown - true if due to shutdown of server

shutdownAppInstance

void shutdownAppInstance(String appInstanceName)

Shutdown an application instance by name. This will disconnect all clients connected to this application instance.

Parameters:

appInstanceName - application instance name

writeAppConfig

boolean writeAppConfig(String sName,
                     String data)

Method to write xml config file..