Package com.adobe.cq.cloudservices.provisioning

Interface ProvisioningHandler

@ConsumerType
public interface ProvisioningHandler

A 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.

Field Summary

Fields

Modifier and Type	Field	Description
static String	CLOUDSERVICE_ID	The name of the service registration property indicating the name(s) of the service provided by the provisioning implementation.

Method Summary

Modifier and Type	Method	Description
void	applyToPaths(ResourceResolver resourceResolver, String[] paths, Resource configuration)	Applies the configuration to the specified paths.
void	revokeFromPaths(ResourceResolver resourceResolver, String[] paths, Resource configuration)	Revokes the configuration from the specified paths.
void	rollback(ResourceResolver resourceResolver, Map<String,Object> properties)	Is rolling back the setup step.
Resource	setup(ResourceResolver resourceResolver, Map<String,Object> properties)	Triggers the provisioning of a cloud service.

Field Detail

CLOUDSERVICE_ID

static final String CLOUDSERVICE_ID

The name of the service registration property indicating the name(s) of the service provided by the provisioning implementation. The value of this service property must be a single String.

See Also:

Constant Field Values

Method Detail

setup

Resource setup(ResourceResolver resourceResolver,
               Map<String,Object> properties)
        throws ProvisioningException

Triggers the provisioning of a cloud service.

Parameters:

resourceResolver - A ResourceResolver instance

properties - A Map of the properties required to do the provisioning.

Returns:

Newly created service configuration

Throws:

ProvisioningException - if an error occurs during the setup

rollback

void rollback(ResourceResolver resourceResolver,
              Map<String,Object> properties)
       throws ProvisioningException

Is rolling back the setup step.

Parameters:

resourceResolver - A ResourceResolver instance

properties - A Map of the properties required to do the provisioning.

Throws:

ProvisioningException - if an error occurs during the rollback

applyToPaths

void applyToPaths(ResourceResolver resourceResolver,
                  String[] paths,
                  Resource configuration)
           throws ProvisioningException

Applies the configuration to the specified paths.

Parameters:

resourceResolver - A ResourceResolver instance

paths - An Array of paths to apply the configuration to

configuration - Configuration Resource created by the setup(ResourceResolver, Map) method.

Throws:

ProvisioningException - if an error occurs during application

revokeFromPaths

void revokeFromPaths(ResourceResolver resourceResolver,
                     String[] paths,
                     Resource configuration)
              throws ProvisioningException

Revokes the configuration from the specified paths.

Parameters:

resourceResolver - A ResourceResolver instance

paths - the paths to revoke the configuration from

configuration - configuration Resource

Throws:

ProvisioningException - if an error occurs during the revoke