public interface IServer
IServer: public interface to Server object.
| Modifier and Type | Field | Description |
|---|---|---|
static String |
SERVER_DEFAULT |
| Modifier and Type | Method | Description |
|---|---|---|
boolean |
addAuthorizedRESTAPI(Class classType) |
Returns true if the class has been added to the REST API.
|
boolean |
addAuthorizedRESTAPI(Class classType,
String url) |
Returns true if the class has been added to the REST API at the specified URL
|
void |
addServerListener(IServerNotify serverListener) |
Add server listener
|
boolean |
addUnAuthorizedRESTAPI(Class classType) |
Returns true if the class has been added to the REST API.
|
boolean |
addUnAuthorizedRESTAPI(Class classType,
String url) |
Returns true if the class has been added to the REST API at the specified URL
|
com.wowza.wms.admin.AdminAgent |
getAdminAgent() |
Get the JMX interface
|
String |
getAdminGUID() |
Get the admin guid
|
java.util.List |
getAdminInterfaceObjectList() |
Get the list of objects exposed through JMX interface
|
com.wowza.util.RandomIdGenerator |
getClientIdGenerator() |
Get the client id generator for the server
|
int |
getClientIdGeneratorRecycleDelaySize() |
Get the client ID generator recycle delay size
|
int |
getClientIdGeneratorRecycleSize() |
Get the client ID generator recycle size
|
long |
getClientIdGeneratorTimeout() |
Get the client ID generator timeout
|
com.wowza.wms.server.CommandInterfaceCommandHandler |
getCommandInterfaceCommandHandler() |
Get the command interface command handler
|
HostPort |
getCommandInterfaceHostPort() |
Get the definition of the command interface
|
long |
getCommittedVirtuallMemory() |
Get the committed virtual memory
|
ConnectionCounter |
getConnectionCounter() |
Get the server connection counter.
|
com.wowza.wms.client.ConnectionCounterSimple |
getConnectionCounter(int counterIndex) |
Get the server connection counter for a specific technology (see IVHost.COUNTER_*)
|
long |
getConnectionsMaximum() |
Returns maximum number of connections allowed to the server (-1 means unlimited)
|
int |
getCoreHandlerPoolSize() |
Get the handler core thread pool size.
|
int |
getCoreTransportPoolSize() |
Get the transport core thread pool size.
|
long |
getCurrentHeapSize() |
Get the current heap size
|
String |
getDateStarted() |
Get the date and time the server was started.
|
String |
getDefaultStreamPrefix() |
Get the default stream prefix used if the stream name does not include a prefix (default is mp4)
|
java.util.Properties |
getDynamicLogProperties() |
Get the dynamic log properties defined at the server level in conf/log4j.properties
|
String |
getGUID() |
Get the base guid
|
ThreadPool |
getHandlerThreadPool() |
Get the server handler thread pool.
|
String |
getHTTPHeaderServer() |
Get the Server header used for HTTP responses
|
IOPerformanceCounter |
getIoPerformanceCounter() |
Get the server performance counter.
|
IOPerformanceCounter |
getIoPerformanceCounter(int counterIndex) |
Get the server performance counter for a specific technology (see IVHost.COUNTER_*)
|
long |
getLiveStreamTranscoderSessionCount() |
Get the current number of live stream transcoder sessions.
|
long |
getLiveThreads() |
Get the count of live threads
|
WMSProperties |
getManagerProperties() |
Get server's manager's properties collection
|
long |
getMaxHeapSize() |
Get the max heap size
|
long |
getPeakThreads() |
Get the count of peak threads
|
WMSProperties |
getProperties() |
Get server level properties collection
|
com.wowza.wms.server.Server.ProtocolUsageSessionTracker |
getProtocolUsageTracker() |
Get the server level protocol usage tracker
|
long |
getPublishersMaximum() |
Get the maximum number of streams that can be published to the server
|
PushPublishUsageTracker |
getPushPublishUsageTracker() |
Get the server level push publishing usage tracker
|
com.wowza.wms.rest.restserver.RESTUsageTracker |
getRESTUsageTracker() |
Get the server level REST usage tracker
|
String |
getRTMPTHeaderServer() |
Get the Server header used for RTMPT responses
|
String |
getServerGUID() |
Get the server guid
|
String |
getSessionGUID() |
Get the session guid
|
ThreadPool |
getThreadPool() |
Get the server handler thread pool.
|
com.wowza.wms.transcoder.thumbnailer.ThumbnailerUsageTracker |
getThumbnailerUsageTracker() |
Get the server level thumbnail usage tracker
|
String |
getTimeRunning() |
Get a formatted String of how long the server has been running.
|
double |
getTimeRunningSeconds() |
Get time running in seconds
|
com.wowza.wms.transcoder.capture.TranscoderCaptureManager |
getTranscoderCaptureManager() |
Get the transcoder capture manager
|
com.wowza.wms.transcoder.model.TranscoderContextServer |
getTranscoderContextServer() |
Get the server level transcoder context
|
long |
getTranscoderLicenseInUse() |
Get the total number of transcoder licenses in use.
|
long |
getTranscoderLicenseTotal() |
Get the total number of transcoder licenses (-1 means unlimited - subscription)
|
com.wowza.wms.server.TranscoderUsageTracker |
getTranscoderUsageTracker() |
Get the server level live transcoder usage tracker
|
com.wowza.wms.transcoder.vod.TranscoderVODUsageTracker |
getTranscoderVODUsageTracker() |
Get the server level VOD transcoder usage tracker
|
ThreadPool |
getTransportThreadPool() |
Get the server transport thread pool.
|
com.wowza.wms.server.ServerTuningHandler |
getTuningHandler() |
Get the handler that control automatic server tuning
|
com.wowza.wms.transport.udp.UDPPortManager |
getUDPPortManager() |
Get the UDP port manager which manages the allocation of incoming UDP port binding to be sure there are not port conflicts
|
com.wowza.wms.transport.udp.UDPPortSharingManager |
getUDPPortSharingManager() |
Get the UDP port sharing manager.
|
String[] |
getUserAgents() |
Get a pipe "|" delimited list of user agents that the server recognizes as RTMPT client.
|
String |
getVersion() |
Get server version number.
|
VHostList |
getVHostList() |
Returns the interface to the VHostList for the server
|
boolean |
isAcceptWOWZConnections() |
If true, WOWZ connections will use the WOWZ protocol.
|
boolean |
isDRMAvailable() |
Returns true if DRM is properly licensed.
|
boolean |
isDRMInUse() |
Returns true if DRM is in-use.
|
boolean |
isDVRAvailable() |
Returns true if nDVR is properly licensed.
|
boolean |
isDVRInUse() |
Returns true if nDVR is in-use.
|
boolean |
isDynamicLogContextLoaded(String logContext) |
Returns true of the given dynamic log context is already loaded.
|
boolean |
isHTTPOriginAvailable() |
Returns true if HTTP origin is properly licensed.
|
boolean |
isInitiateWOWZConnections() |
If true, NetConnection attempts will use the WOWZ protocol when possible.
|
boolean |
isLoggingRemoveStdoutIfRunningAsService() |
If true, stdout log4j appender is removed from logging configuration if running as a service.
|
boolean |
isPushPublishAvailable() |
Returns true if Push Publish is properly licensed.
|
boolean |
isRESTAPIAvailable() |
Returns true if REST API is properly licensed.
|
boolean |
isRestDocumentationServerEnabled() |
Returns true if REST API documentation server is enabled
|
boolean |
isRestServerEnabled() |
Returns true if REST API is enabled
|
boolean |
isSuspended() |
Is the server current suspended
|
boolean |
isTranscoderWatermark() |
Return true if transcoder has a watermark
|
boolean |
isVHostRunning(String name) |
Returns true if the name provided is a running VHost name
|
String |
readConfig(String sName) |
Method to read xml config file..
|
void |
reloadVHostConfig() |
Reload the VHosts.xml file.
|
void |
removeServerListener(IServerNotify serverListener) |
Remove server listener
|
void |
setAcceptWOWZConnections(boolean acceptWOWZConnections) |
If true, WOWZ connections will use the WOWZ protocol.
|
void |
setCommandInterfaceHostPort(HostPort commandInterfaceHostPort) |
Set the definition for the command interface.
|
void |
setCoreHandlerPoolSize(int corePoolSize) |
Set the handler core thread pool size.
|
void |
setCoreTransportPoolSize(int corePoolSize) |
Set the transport core thread pool size.
|
void |
setDefaultStreamPrefix(String defaultStreamPrefix) |
Set the default stream prefix used if the stream name does not include a prefix (default is mp4)
|
void |
setDynamicLogProperties(java.util.Properties dynamicLogProperties) |
Set the dynamic log properties set at the server level
|
void |
setHTTPHeaderServer(String httpHeaderServer) |
Set the Server header used for HTTP responses
|
void |
setInitiateWOWZConnections(boolean initiateWOWZConnections) |
If true, NetConnection attempts will use the WOWZ protocol when possible.
|
void |
setLoggingRemoveStdoutIfRunningAsService(boolean loggingRemoveStdoutIfRunningAsService) |
If true, stdout log4j appender is removed from logging configuration if running as a service.
|
void |
setRestDocumentationServerEnabled(boolean restDocumentationServerEnabled) |
Sets if REST API documentation server will be enabled
|
void |
setRestServerEnabled(boolean restServerEnabled) |
Sets if REST API server will be enabled
|
void |
setRTMPTHeaderServer(String rtmptHeaderServer) |
Set the Server header used for RTMPT responses
|
void |
setUserAgents(String[] userAgents) |
Set a pipe "|" delimited list of user agents that the server recognizes as RTMPT client.
|
void |
startCommandInterface() |
Start the command interface as defined in Server.xml.
|
void |
startStats() |
Starts the statistics manager to collect server and application statistics
|
void |
startVHost(String vhostName) |
Start a vHost by name.
|
void |
startVHosts() |
Start all vHosts
|
void |
stopAdminAgent() |
Stop the JMX interface
|
void |
stopCommandInterface() |
Stop the command interface as defined in Server.xml.
|
void |
stopStats() |
Stops the statistics manager
|
void |
stopVHost(String vhostName) |
Stop a vHost by name.
|
void |
stopVHosts() |
Stop all vHosts
|
void |
suspendAllVHosts() |
Suspend all virtual hosts (Calls IVHost.suspendAllHostPorts for each vhost)
|
void |
suspendCommandInterface() |
Suspend the command interface as defined in Server.xml.
|
void |
suspendServer() |
Suspend all virtual hosts and the command interface
|
void |
unbindAllVHosts() |
Unbind all virtual hosts (Calls IVHost.unbindAllHostPorts for each vhost)
|
boolean |
writeConfig(String sName,
String data) |
Method to write xml config file..
|
static final String SERVER_DEFAULT
boolean addAuthorizedRESTAPI(Class classType)
boolean addAuthorizedRESTAPI(Class classType,
String url)
void addServerListener(IServerNotify serverListener)
serverListener - server listenerboolean addUnAuthorizedRESTAPI(Class classType)
boolean addUnAuthorizedRESTAPI(Class classType,
String url)
com.wowza.wms.admin.AdminAgent getAdminAgent()
String getAdminGUID()
java.util.List getAdminInterfaceObjectList()
com.wowza.util.RandomIdGenerator getClientIdGenerator()
int getClientIdGeneratorRecycleDelaySize()
int getClientIdGeneratorRecycleSize()
long getClientIdGeneratorTimeout()
com.wowza.wms.server.CommandInterfaceCommandHandler getCommandInterfaceCommandHandler()
HostPort getCommandInterfaceHostPort()
long getCommittedVirtuallMemory()
ConnectionCounter getConnectionCounter()
com.wowza.wms.client.ConnectionCounterSimple getConnectionCounter(int counterIndex)
counterIndex - counter index (see IVHost.COUNTER_*)long getConnectionsMaximum()
int getCoreHandlerPoolSize()
int getCoreTransportPoolSize()
long getCurrentHeapSize()
String getDateStarted()
String getDefaultStreamPrefix()
java.util.Properties getDynamicLogProperties()
String getGUID()
ThreadPool getHandlerThreadPool()
String getHTTPHeaderServer()
IOPerformanceCounter getIoPerformanceCounter()
IOPerformanceCounter getIoPerformanceCounter(int counterIndex)
counterIndex - counter index (see IVHost.COUNTER_*)long getLiveStreamTranscoderSessionCount()
long getLiveThreads()
WMSProperties getManagerProperties()
long getMaxHeapSize()
long getPeakThreads()
WMSProperties getProperties()
com.wowza.wms.server.Server.ProtocolUsageSessionTracker getProtocolUsageTracker()
long getPublishersMaximum()
PushPublishUsageTracker getPushPublishUsageTracker()
com.wowza.wms.rest.restserver.RESTUsageTracker getRESTUsageTracker()
String getRTMPTHeaderServer()
String getServerGUID()
String getSessionGUID()
ThreadPool getThreadPool()
com.wowza.wms.transcoder.thumbnailer.ThumbnailerUsageTracker getThumbnailerUsageTracker()
String getTimeRunning()
double getTimeRunningSeconds()
com.wowza.wms.transcoder.capture.TranscoderCaptureManager getTranscoderCaptureManager()
com.wowza.wms.transcoder.model.TranscoderContextServer getTranscoderContextServer()
long getTranscoderLicenseInUse()
long getTranscoderLicenseTotal()
com.wowza.wms.server.TranscoderUsageTracker getTranscoderUsageTracker()
com.wowza.wms.transcoder.vod.TranscoderVODUsageTracker getTranscoderVODUsageTracker()
ThreadPool getTransportThreadPool()
com.wowza.wms.server.ServerTuningHandler getTuningHandler()
com.wowza.wms.transport.udp.UDPPortManager getUDPPortManager()
com.wowza.wms.transport.udp.UDPPortSharingManager getUDPPortSharingManager()
String[] getUserAgents()
String getVersion()
VHostList getVHostList()
boolean isAcceptWOWZConnections()
boolean isDRMAvailable()
boolean isDRMInUse()
boolean isDVRAvailable()
boolean isDVRInUse()
boolean isDynamicLogContextLoaded(String logContext)
boolean isHTTPOriginAvailable()
boolean isInitiateWOWZConnections()
boolean isLoggingRemoveStdoutIfRunningAsService()
boolean isPushPublishAvailable()
boolean isRESTAPIAvailable()
boolean isRestDocumentationServerEnabled()
boolean isRestServerEnabled()
boolean isSuspended()
boolean isTranscoderWatermark()
boolean isVHostRunning(String name)
name - of a running VHostString readConfig(String sName)
void reloadVHostConfig()
void removeServerListener(IServerNotify serverListener)
serverListener - server listenervoid setAcceptWOWZConnections(boolean acceptWOWZConnections)
acceptWOWZConnections - true, WOWZ connections will use the WOWZ protocolvoid setCommandInterfaceHostPort(HostPort commandInterfaceHostPort)
commandInterfaceHostPort - host port definition of command interfacevoid setCoreHandlerPoolSize(int corePoolSize)
corePoolSize - core thread pool sizevoid setCoreTransportPoolSize(int corePoolSize)
corePoolSize - core thread pool sizevoid setDefaultStreamPrefix(String defaultStreamPrefix)
defaultStreamPrefix - default stream prefixvoid setDynamicLogProperties(java.util.Properties dynamicLogProperties)
dynamicLogProperties - dynamic log properties defined at the server levelvoid setHTTPHeaderServer(String httpHeaderServer)
httpHeaderServer - void setInitiateWOWZConnections(boolean initiateWOWZConnections)
initiateWOWZConnections - true, NetConnection attempts will use the WOWZ protocol when possible.void setLoggingRemoveStdoutIfRunningAsService(boolean loggingRemoveStdoutIfRunningAsService)
loggingRemoveStdoutIfRunningAsService - stdout log4j appender is removed from logging configuration if running as a servicevoid setRestDocumentationServerEnabled(boolean restDocumentationServerEnabled)
restDocumentationServerEnabled - if the REST API server will be enabledvoid setRestServerEnabled(boolean restServerEnabled)
restServerEnabled - if the REST API server will be enabledvoid setRTMPTHeaderServer(String rtmptHeaderServer)
rtmptHeaderServer - Server header used for RTMPT responsesvoid setUserAgents(String[] userAgents)
userAgents - pipe "|" delimited list of user agents that the server recognizes as RTMPT clientvoid startCommandInterface()
void startStats()
void startVHost(String vhostName)
vhostName - vHost namevoid startVHosts()
void stopAdminAgent()
void stopCommandInterface()
void stopStats()
void stopVHost(String vhostName)
vhostName - vHost namevoid stopVHosts()
void suspendAllVHosts()
void suspendCommandInterface()
void suspendServer()
void unbindAllVHosts()
boolean writeConfig(String sName,
String data)