org.openksavi.sponge.mpd

Class MpdPlugin

java.lang.Object

org.openksavi.sponge.core.engine.BaseEngineModule

org.openksavi.sponge.core.plugin.BasePlugin

org.openksavi.sponge.java.JPlugin

org.openksavi.sponge.mpd.MpdPlugin

All Implemented Interfaces:

EngineModule, Plugin, Descriptive, HasEngine, Manageable

public class MpdPlugin
extends JPlugin

MPD (Music Player Daemon) plugin.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_PLUGIN_NAME The default name of this plugin.

Constructor Summary

Constructors

Constructor and Description
MpdPlugin() Creates a new MPD plugin.
MpdPlugin(String name) Creates a new MPD plugin.

Method Summary

Modifier and Type	Method and Description
void	connect() Connects to the MPD server.
protected org.bff.javampd.server.MPD	createMpd() Creates the MPD server representation.
void	disconnect() Disconnects from the MPD server.
String	getEventNamePrefix() Returns the MPD-based Sponge event name prefix.
String	getHostname() Returns the MPD server hostname.
MpdListenerManager	getListenerManager() Returns the MPD event listener manager.
String	getPassword() Returns the MPD server password.
Integer	getPort() Returns the MPD server port.
org.bff.javampd.server.MPD	getServer() Returns the MPD server representation.
Integer	getTimeout() Returns the MPD server timeout.
boolean	isAutoConnect() Returns the auto connect flag.
boolean	isAutoStartMonitor() Returns the auto start monitor flag.
void	onConfigure(Configuration configuration) Applies the XML configuration to this plugin.
void	onShutdown() Shuts down the plugin.
void	onStartup() Starts up this plugin.
void	registerAllListeners() Registers all MPD event listeners.
void	registerListener(MpdEventCategory category) Registers the MPD event listener for the MPD event category.
void	registerListeners(MpdEventCategory... categories) Registers MPD event listeners by MPD event categories.
void	removeListener(MpdEventCategory category) Removes the MPD event listener for the MPD event category.
protected <T> void	sendEvent(MpdEventCategory category, T source) Sends a new MPD-based Sponge event to the engine.
void	setAutoConnect(boolean autoConnect) Sets the auto connect flag.
void	setAutoStartMonitor(boolean autoStartMonitor) Sets the auto start monitor flag.
void	setEventNamePrefix(String eventNamePrefix) Sets the MPD-based Sponge event name prefix.
void	setHostname(String hostname) Sets the MPD server hostname.
void	setPassword(String password) Sets the MPD server password.
void	setPort(Integer port) Sets the MPD server port.
void	setServer(org.bff.javampd.server.MPD server) Sets the MPD server representation.
void	setTimeout(Integer timeout) Sets the MPD server timeout.

Methods inherited from class org.openksavi.sponge.core.plugin.BasePlugin

doShutdown, doStartup, getConfiguration, getEngineOperations, getKnowledgeBase, getLogger, getSponge, onAfterReload, onBeforeReload, onInit, setConfiguration, setKnowledgeBase, shutdown, startup, toString

Methods inherited from class org.openksavi.sponge.core.engine.BaseEngineModule

getDescription, getDisplayName, getEngine, getInternalService, getName, getState, isFailed, isNew, isNewOrStartingOrRunning, isRunning, isStarting, isStopping, isTerminated, setDescription, setDisplayName, setEngine, setName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.openksavi.sponge.util.Manageable

isFailed, isNew, isRunning, isStarting, isStopping, isTerminated

Methods inherited from interface org.openksavi.sponge.util.Descriptive

getDescription, getDisplayName, getName, setDescription, setDisplayName, setName

Methods inherited from interface org.openksavi.sponge.util.HasEngine

getEngine, setEngine

Field Detail

DEFAULT_PLUGIN_NAME

public static final String DEFAULT_PLUGIN_NAME

The default name of this plugin.

See Also:

Constant Field Values

Constructor Detail

MpdPlugin

public MpdPlugin()

Creates a new MPD plugin.

MpdPlugin

public MpdPlugin(String name)

Creates a new MPD plugin.

Parameters:

name - the plugin name.

Method Detail

onConfigure

public void onConfigure(Configuration configuration)

Applies the XML configuration to this plugin.

Specified by:

onConfigure in interface Plugin

Overrides:

onConfigure in class BasePlugin

Parameters:

configuration - configuration.

onStartup

public void onStartup()

Starts up this plugin.

Specified by:

onStartup in interface Plugin

Overrides:

onStartup in class BasePlugin

connect

public void connect()

Connects to the MPD server.

disconnect

public void disconnect()

Disconnects from the MPD server.

createMpd

protected org.bff.javampd.server.MPD createMpd()

Creates the MPD server representation.

Returns:

the MPD server representation.

sendEvent

protected <T> void sendEvent(MpdEventCategory category,
                             T source)

Sends a new MPD-based Sponge event to the engine.

Type Parameters:

T - source event type.

Parameters:

category - the MPD event category.

source - the source MPD event.

onShutdown

public void onShutdown()

Shuts down the plugin.

Specified by:

onShutdown in interface Plugin

Overrides:

onShutdown in class BasePlugin

getHostname

public String getHostname()

Returns the MPD server hostname.

Returns:

the MPD server hostname.

setHostname

public void setHostname(String hostname)

Sets the MPD server hostname.

Parameters:

hostname - the MPD server hostname.

getPort

public Integer getPort()

Returns the MPD server port.

Returns:

the MPD server port.

setPort

public void setPort(Integer port)

Sets the MPD server port.

Parameters:

port - the MPD server port.

getPassword

public String getPassword()

Returns the MPD server password.

Returns:

the MPD server password.

setPassword

public void setPassword(String password)

Sets the MPD server password.

Parameters:

password - the MPD server password.

getTimeout

public Integer getTimeout()

Returns the MPD server timeout.

Returns:

the MPD server timeout.

setTimeout

public void setTimeout(Integer timeout)

Sets the MPD server timeout.

Parameters:

timeout - the MPD server timeout.

getEventNamePrefix

public String getEventNamePrefix()

Returns the MPD-based Sponge event name prefix.

Returns:

the MPD-based Sponge event name prefix.

setEventNamePrefix

public void setEventNamePrefix(String eventNamePrefix)

Sets the MPD-based Sponge event name prefix.

Parameters:

eventNamePrefix - the MPD-based Sponge event name prefix.

isAutoConnect

public boolean isAutoConnect()

Returns the auto connect flag.

Returns:

true if the plugin is to connect to the MPD server on startup.

setAutoConnect

public void setAutoConnect(boolean autoConnect)

Sets the auto connect flag.

Parameters:

autoConnect - true if the plugin is to connect to the MPD server on startup.

isAutoStartMonitor

public boolean isAutoStartMonitor()

Returns the auto start monitor flag.

Returns:

true if the plugin is to start the MPD monitor on startup.

setAutoStartMonitor

public void setAutoStartMonitor(boolean autoStartMonitor)

Sets the auto start monitor flag.

Parameters:

autoStartMonitor - true if the plugin is to start the MPD monitor on startup.

getServer

public org.bff.javampd.server.MPD getServer()

Returns the MPD server representation.

Returns:

the MPD server representation.

setServer

public void setServer(org.bff.javampd.server.MPD server)

Sets the MPD server representation.

Parameters:

server - the MPD server representation.

getListenerManager

public MpdListenerManager getListenerManager()

Returns the MPD event listener manager.

Returns:

the MPD event listener manager.

registerListeners

public void registerListeners(MpdEventCategory... categories)

Registers MPD event listeners by MPD event categories.

Parameters:

categories - the MPD event categories.

registerAllListeners

public void registerAllListeners()

Registers all MPD event listeners.

registerListener

public void registerListener(MpdEventCategory category)

Registers the MPD event listener for the MPD event category.

Parameters:

category - the MPD event category.

removeListener

public void removeListener(MpdEventCategory category)

Removes the MPD event listener for the MPD event category.

Parameters:

category - the MPD event category.