Eclipse Platform
Kepler (4.3)

org.eclipse.equinox.p2.core
Interface IProvisioningAgent


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.

Since:
2.0
Restriction:
This interface is not intended to be implemented by clients.
Restriction:
This interface is not intended to be extended by clients.

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.
static String SHARED_BASE_AGENT
          When running in "shared mode", this allows to retrieve from the IProvisioningAgent the agent representing what is in the shared location aka the base
static String SHARED_CURRENT_AGENT
          When running in "shared mode", this allows to retrieve from the IProvisioningAgent identified by SHARED_BASE_AGENT the current agent
 
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

SERVICE_NAME

static final String SERVICE_NAME
Service name constant for the agent service. Note that an agent obtained directly as a service typically represents the agent of the currently running system. To obtain an agent for a different system the IProvisioningAgentProvider service must be used.


INSTALLER_AGENT

static final String INSTALLER_AGENT
See Also:
Constant Field Values

INSTALLER_PROFILEID

static final String INSTALLER_PROFILEID
See Also:
Constant Field Values

SHARED_BASE_AGENT

static final String SHARED_BASE_AGENT
When running in "shared mode", this allows to retrieve from the IProvisioningAgent the agent representing what is in the shared location aka the base

Since:
2.3
See Also:
Constant Field Values

SHARED_CURRENT_AGENT

static final String SHARED_CURRENT_AGENT
When running in "shared mode", this allows to retrieve from the IProvisioningAgent identified by SHARED_BASE_AGENT the current agent

Since:
2.3
See Also:
Constant Field Values

SERVICE_CURRENT

static final String SERVICE_CURRENT
Service property identifying whether an agent is the default agent.

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.

See Also:
Constant Field Values
Method Detail

getService

Object getService(String serviceName)
Returns the service with the given service name, or null if no such service is available in this agent.

Throws:
IllegalStateException - if this agent has been stopped

registerService

void registerService(String serviceName,
                     Object service)
Registers a service with this provisioning agent.

Parameters:
serviceName - The name of the service to register
service - The service implementation
Throws:
IllegalStateException - if this agent has been stopped

stop

void stop()
Stops the provisioning agent. This causes services provided by this agent to be cleaned up and discarded. No services provided by the agent should be referenced after the agent has been stopped, and subsequent attempts to obtain services after the agent has stopped will fail.

An agent should only be stopped by the client who first created the agent by invoking IProvisioningAgentProvider.createAgent(java.net.URI).


unregisterService

void unregisterService(String serviceName,
                       Object service)
Unregisters a service that has previously been registered with this agent via registerService(String, Object). This method has no effect if no such service is registered with this agent.

Parameters:
serviceName - The name of the service to unregister
service - The service implementation to unregister.

Eclipse Platform
Kepler (4.3)

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2012. All rights reserved.