@ConsumerType public interface ProvisioningHandler
ProvisioningHandler
defines the service API to be implemented by service providers extending the
provisioning mechanism. Service providers may register OSGi services of this type to be used by the provisioning
default servlet to handle the provisioning of a specific service integration.
The ProvisioningHandler
service must be registered with a CLOUDSERVICE_ID
registration property giving the name of the service integration supported by the service. The names will be used by
the provisioning default servlet to match the request parameter servicename
with the correct handler to
trigger the provisioning.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLOUDSERVICE_ID
The name of the service registration property indicating the name(s) of the service provided by the provisioning
implementation.
|
Modifier and Type | Method and Description |
---|---|
void |
applyToPaths(ResourceResolver resourceResolver,
java.lang.String[] paths,
Resource configuration)
Applies the
configuration to the specified paths . |
void |
revokeFromPaths(ResourceResolver resourceResolver,
java.lang.String[] paths,
Resource configuration)
Revokes the
configuration from the specified paths . |
void |
rollback(ResourceResolver resourceResolver,
java.util.Map<java.lang.String,java.lang.Object> properties)
Is rolling back the setup step.
|
Resource |
setup(ResourceResolver resourceResolver,
java.util.Map<java.lang.String,java.lang.Object> properties)
Triggers the provisioning of a cloud service.
|
static final java.lang.String CLOUDSERVICE_ID
Resource setup(ResourceResolver resourceResolver, java.util.Map<java.lang.String,java.lang.Object> properties) throws ProvisioningException
resourceResolver
- A ResourceResolver
instanceproperties
- A Map
of the properties required to do the provisioning.ProvisioningException
- if an error occurs during the setupvoid rollback(ResourceResolver resourceResolver, java.util.Map<java.lang.String,java.lang.Object> properties) throws ProvisioningException
resourceResolver
- A ResourceResolver
instanceproperties
- A Map
of the properties required to do the provisioning.ProvisioningException
- if an error occurs during the rollbackvoid applyToPaths(ResourceResolver resourceResolver, java.lang.String[] paths, Resource configuration) throws ProvisioningException
configuration
to the specified paths
.resourceResolver
- A ResourceResolver
instancepaths
- An Array of paths to apply the configuration
toconfiguration
- Configuration Resource
created by the setup(ResourceResolver, Map)
method.ProvisioningException
- if an error occurs during applicationvoid revokeFromPaths(ResourceResolver resourceResolver, java.lang.String[] paths, Resource configuration) throws ProvisioningException
configuration
from the specified paths
.resourceResolver
- A ResourceResolver
instancepaths
- the paths to revoke the configuration
fromconfiguration
- configuration Resource
ProvisioningException
- if an error occurs during the revokeCopyright © 2010 - 2020 Adobe. All Rights Reserved