org.qtunes.core
Interface ServiceContext

All Known Implementing Classes:
ServiceContextImpl

public interface ServiceContext


Method Summary
 void addListener(Listener listener)
          Add a Listener to the Server, it will be notified of events
 ServiceContext addService(java.lang.Class<?>[] classes, Service service, java.util.Map<java.lang.String,java.lang.String> properties, boolean permanent)
          Add a service
 void debug(java.lang.String message)
           
 void debug(java.lang.String message, java.lang.Throwable e)
           
 void error(java.lang.String message, java.lang.Throwable e)
           
 void fireEvent(java.lang.String name, java.lang.Object[] o)
          Fire an event - the Listeners registered with the server will be notified.
 java.lang.String getGlobalProperty(java.lang.String key)
          Get a system-wide property
 java.lang.String getProperty(java.lang.String key)
          Get a property of this Service
 java.lang.String[] getPropertyNames()
          Return a list of properties of this Service
 java.util.Date getServerBuildDate()
          Return the build date of the Server
 java.lang.String getServerName()
          Return the logical name of the Server
 Service getService()
          Get the Service for this ServiceContext
<E extends Service>
E
getService(java.lang.Class<E> type)
          Get the first Service object of the specified type
<E extends Service>
E
getService(java.lang.Class<E> type, java.lang.String criteria)
          Get the first Service object of the specified type
 java.lang.String getServiceName()
          Return the unique logical name of this Service
 java.lang.String[] getServiceNames()
          Return the list of Service names
<E extends Service>
E[]
getServices(java.lang.Class<E> type, java.lang.String criteria)
          Get a list of all Service objects of the specified type
 java.lang.String getSoftwareName()
          Return the name and version of the Software
 void info(java.lang.String message)
           
 boolean isActive()
          Return true if the Service has been started
 void putProperty(java.lang.String key, java.lang.String value)
          Set a property of this Service
 void removeListener(Listener listener)
          Remove a Listener to the Server, it will be notified of events
 void removeService()
          Remove a service
 void start()
           
 void stop()
           
 void warn(java.lang.String message, java.lang.Throwable e)
           
 

Method Detail

debug

void debug(java.lang.String message,
           java.lang.Throwable e)

debug

void debug(java.lang.String message)

info

void info(java.lang.String message)

warn

void warn(java.lang.String message,
          java.lang.Throwable e)

error

void error(java.lang.String message,
           java.lang.Throwable e)

getSoftwareName

java.lang.String getSoftwareName()
Return the name and version of the Software


getServerName

java.lang.String getServerName()
Return the logical name of the Server


getServerBuildDate

java.util.Date getServerBuildDate()
Return the build date of the Server


getServiceName

java.lang.String getServiceName()
Return the unique logical name of this Service


getService

Service getService()
Get the Service for this ServiceContext


getService

<E extends Service> E getService(java.lang.Class<E> type)
Get the first Service object of the specified type


getService

<E extends Service> E getService(java.lang.Class<E> type,
                                 java.lang.String criteria)
Get the first Service object of the specified type


getServices

<E extends Service> E[] getServices(java.lang.Class<E> type,
                                    java.lang.String criteria)
Get a list of all Service objects of the specified type


addListener

void addListener(Listener listener)
Add a Listener to the Server, it will be notified of events


removeListener

void removeListener(Listener listener)
Remove a Listener to the Server, it will be notified of events


fireEvent

void fireEvent(java.lang.String name,
               java.lang.Object[] o)
Fire an event - the Listeners registered with the server will be notified. Properties can be specified easily with the second parameter, which is a sequence of [key, value] entries - eg
  qtunes.fireEvent("player.add, new Object[] { "track", track, "user", user });
 

Parameters:
o - an array of [key, value]

getPropertyNames

java.lang.String[] getPropertyNames()
Return a list of properties of this Service


getGlobalProperty

java.lang.String getGlobalProperty(java.lang.String key)
Get a system-wide property


getProperty

java.lang.String getProperty(java.lang.String key)
Get a property of this Service


putProperty

void putProperty(java.lang.String key,
                 java.lang.String value)
Set a property of this Service


start

void start()

stop

void stop()

addService

ServiceContext addService(java.lang.Class<?>[] classes,
                          Service service,
                          java.util.Map<java.lang.String,java.lang.String> properties,
                          boolean permanent)
Add a service


removeService

void removeService()
Remove a service


getServiceNames

java.lang.String[] getServiceNames()
Return the list of Service names


isActive

boolean isActive()
Return true if the Service has been started