|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.muse.core.AbstractCapability
public abstract class AbstractCapability
AbstractCapability provides a foundation for user-defined capabilities
by allowing users to focus on their operations and capability-specific
logic without having to worry about maintaining Muse components and
other plumbing work.
The implementations of the initialization and shutdown routines are mostly
no-ops. Nevertheless, if these methods are overridden by concrete capability
classes, the implementations should be sure to call the parent class version
(via 'super') before executing their own logic; for example, a new version
of the initialize() method should always start with a call to super.initialize().
As the class hierarchy grows, this ensures that startup and shutdown tasks
are always performed in the proper order.
Constructor Summary | |
---|---|
AbstractCapability()
|
Method Summary | |
---|---|
Collection |
getActions()
|
String |
getCapabilityURI()
|
Environment |
getEnvironment()
|
String |
getInitializationParameter(String name)
|
Map |
getInitializationParameters()
|
Logger |
getLog()
|
MessageHandler |
getMessageHandler(String action)
|
Persistence |
getPersistence()
|
Resource |
getResource()
|
boolean |
hasBeenInitialized()
|
boolean |
hasBeenShutdown()
|
void |
initialize()
|
void |
initializeCompleted()
This method is called by the containing Resource after all other capabilities have been initialized via initialize(). |
void |
prepareShutdown()
This method is called prior to shutdown() and allows the capability to do any shutdown tasks that require the presence of certain other capabilities. |
void |
setCapabilityURI(String capabilityURI)
|
void |
setEnvironment(Environment environment)
|
void |
setInitializationParameters(Map parameters)
Allows the resource's creator to provide it with arbitrary name-value pairs that may be used during initialization. |
void |
setLog(Logger log)
|
protected void |
setMessageHandler(MessageHandler handler)
|
void |
setMessageHandlers(Collection handlers)
|
void |
setPersistence(Persistence persistence)
|
void |
setResource(Resource resource)
|
void |
shutdown()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AbstractCapability()
Method Detail |
---|
public Collection getActions()
getActions
in interface Capability
Capability.getMessageHandler(String)
public String getCapabilityURI()
getCapabilityURI
in interface Capability
public Environment getEnvironment()
getEnvironment
in interface Capability
public String getInitializationParameter(String name)
getInitializationParameter
in interface InitializationParameters
public Map getInitializationParameters()
getInitializationParameters
in interface InitializationParameters
public Logger getLog()
getLog
in interface Capability
public MessageHandler getMessageHandler(String action)
getMessageHandler
in interface Capability
Capability.getActions()
public Persistence getPersistence()
getPersistence
in interface Capability
public Resource getResource()
getResource
in interface Capability
public boolean hasBeenInitialized()
hasBeenInitialized
in interface Initialization
public boolean hasBeenShutdown()
hasBeenShutdown
in interface Shutdown
public void initialize() throws SoapFault
initialize
in interface Initialization
SoapFault
public void initializeCompleted() throws SoapFault
Capability
initializeCompleted
in interface Capability
SoapFault
public void prepareShutdown() throws SoapFault
Capability
prepareShutdown
in interface Capability
SoapFault
public void setCapabilityURI(String capabilityURI)
setCapabilityURI
in interface Capability
public void setEnvironment(Environment environment)
setEnvironment
in interface Capability
public void setInitializationParameters(Map parameters)
InitializationParameters
setInitializationParameters
in interface InitializationParameters
parameters
- A simple set of name-value pairs - Map[String, String] - that
contains initialization parameters for the resource.public void setLog(Logger log)
setLog
in interface Capability
protected void setMessageHandler(MessageHandler handler)
public void setMessageHandlers(Collection handlers)
setMessageHandlers
in interface Capability
public void setPersistence(Persistence persistence)
setPersistence
in interface Capability
public void setResource(Resource resource)
setResource
in interface Capability
public void shutdown() throws SoapFault
shutdown
in interface Shutdown
SoapFault
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |