|
Eclipse Platform Release 3.6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IProvisioningAgent
A provisioning agent is comprised of a modular, extensible set of related services. Each agent instance has its own separate instances of these services that are not shared with other agents. There is at most one instance of a given service tracked by an agent at any given time, which ensures all services that make up an agent instance share common service instances with each other.
Services are registered with an agent either directly, via the registerService(String, Object)
method, or indirectly by registering an IAgentServiceFactory
in the OSGi
service registry.
Field Summary | |
---|---|
static String |
INSTALLER_AGENT
|
static String |
INSTALLER_PROFILEID
|
static String |
SERVICE_CURRENT
Service property identifying whether an agent is the default agent. |
static String |
SERVICE_NAME
Service name constant for the agent service. |
Method Summary | |
---|---|
Object |
getService(String serviceName)
Returns the service with the given service name, or null
if no such service is available in this agent. |
void |
registerService(String serviceName,
Object service)
Registers a service with this provisioning agent. |
void |
stop()
Stops the provisioning agent. |
void |
unregisterService(String serviceName,
Object service)
Unregisters a service that has previously been registered with this agent via registerService(String, Object) . |
Field Detail |
---|
static final String SERVICE_NAME
IProvisioningAgentProvider
service must be used.
static final String INSTALLER_AGENT
static final String INSTALLER_PROFILEID
static final String SERVICE_CURRENT
This property may be used by clients wishing to obtain or track the
provisioning agent for the currently running system. When the value of
this property is "true"
then the corresponding service is
the agent for the currently running system. If the property is undefined or
has any other value, then the service is not the agent for the currently running system.
Method Detail |
---|
Object getService(String serviceName)
null
if no such service is available in this agent.
IllegalStateException
- if this agent has been stoppedvoid registerService(String serviceName, Object service)
serviceName
- The name of the service to registerservice
- The service implementation
IllegalStateException
- if this agent has been stoppedvoid stop()
An agent should only be stopped by the client who first created the agent
by invoking IProvisioningAgentProvider.createAgent(java.net.URI)
.
void unregisterService(String serviceName, Object service)
registerService(String, Object)
. This method has
no effect if no such service is registered with this agent.
serviceName
- The name of the service to unregisterservice
- The service implementation to unregister.
|
Eclipse Platform Release 3.6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2010. All rights reserved.