|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
T
- type of service being managedpublic interface ManagedService<T>
Manages a service throughout its lifetime of the service. A ManagedService provides information about the service's dependencies and tracks their availability. As dependencies become available, unavailable, or change, the ManagedService updates the services and its availability within the ServiceRegistry.
Field Summary | |
---|---|
static String |
PROP_DEPENDENCY_CHANGED
Property change event name for a dependency's status changing |
static String |
PROP_SERVICE_CHANGED
Property change event name for the managed service being modified. |
static String |
PROP_SERVICE_TYPE
Property name for the type of service managed. |
Method Summary | |
---|---|
void |
dispose()
Stops and unregisters the service, cleans up the service lifecycle and management, and stops and unregisters the ManagedService. |
int |
getAvailableDependencyCount()
Returns the number of satisfied dependencies. |
List<DependencyDescriptor> |
getDependencies()
Returns a list describing the service dependencies of this ManagedService. |
int |
getDependencyCount()
Returns the number of dependencies for this ManagedService. |
boolean |
getDependencyStatus(String dependencyName)
Returns true if the specified dependency is available. |
boolean |
getRegistrationEnabled()
Returns true if automatic service registration is enabled. |
Properties |
getRegistrationProperties()
Returns the registration properties to use when registering the service. |
String[] |
getServiceClassNames()
Returns the class names of service being managed. |
boolean |
isAvailable()
Returns true if the service is available and ready to use. |
boolean |
isRegistered()
Returns true if the service has been added to the Service Registry. |
void |
register()
Registers the service if it is available. |
void |
setRegistrationEnabled(boolean enabled)
If set true, the Service being managed will be automatically added to the Service Registry when available. |
void |
start()
Starts tracking dependencies and managing the service. |
void |
stop()
Stops tracking dependencies. |
void |
unregister()
Unregisters the service if it is registered. |
Methods inherited from interface org.robokind.api.common.property.PropertyChangeSource |
---|
addPropertyChangeListener, addPropertyChangeListener, removePropertyChangeListener, removePropertyChangeListener |
Field Detail |
---|
static final String PROP_SERVICE_TYPE
static final String PROP_SERVICE_CHANGED
static final String PROP_DEPENDENCY_CHANGED
Method Detail |
---|
void start()
void stop()
void dispose()
List<DependencyDescriptor> getDependencies()
int getDependencyCount()
int getAvailableDependencyCount()
boolean getDependencyStatus(String dependencyName)
dependencyName
- name of the dependency to check
void setRegistrationEnabled(boolean enabled)
enabled
- if true the service will be automatically registered to
the Service Registry when available.boolean getRegistrationEnabled()
void register()
void unregister()
Properties getRegistrationProperties()
String[] getServiceClassNames()
boolean isAvailable()
boolean isRegistered()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |