org.apache.felix.deployment.rp.autoconf
Class AutoConfResourceProcessor

java.lang.Object
  extended by org.apache.felix.deployment.rp.autoconf.AutoConfResourceProcessor
All Implemented Interfaces:
ResourceProcessor

public class AutoConfResourceProcessor
extends Object
implements ResourceProcessor


Constructor Summary
AutoConfResourceProcessor()
           
 
Method Summary
 void begin(DeploymentSession session)
          Called when the Deployment Admin starts a new operation on the given deployment package, and the resource processor is associated a resource within the package.
 void cancel()
          Processing of a resource passed to the resource processor may take long.
 void commit()
          Called when the processing of the current deployment package is finished.
 void dropAllResources()
          This method is called during an "uninstall" deployment session.
 void dropped(String name)
          Called when a resource, associated with a particular resource processor, had belonged to an earlier version of a deployment package but is not present in the current version of the deployment package.
 void prepare()
          This method is called on the Resource Processor immediately before calling the commit method.
 void process(String name, InputStream stream)
          Called when a resource is encountered in the deployment package for which this resource processor has been selected to handle the processing of that resource.
 void rollback()
          Called when the processing of the current deployment package is finished.
 void start()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AutoConfResourceProcessor

public AutoConfResourceProcessor()
Method Detail

start

public void start()
           throws IOException
Throws:
IOException

begin

public void begin(DeploymentSession session)
Description copied from interface: ResourceProcessor
Called when the Deployment Admin starts a new operation on the given deployment package, and the resource processor is associated a resource within the package. Only one deployment package can be processed at a time.

Specified by:
begin in interface ResourceProcessor
Parameters:
session - object that represents the current session to the resource processor
See Also:
DeploymentSession

process

public void process(String name,
                    InputStream stream)
             throws ResourceProcessorException
Description copied from interface: ResourceProcessor
Called when a resource is encountered in the deployment package for which this resource processor has been selected to handle the processing of that resource.

Specified by:
process in interface ResourceProcessor
Parameters:
name - The name of the resource relative to the deployment package root directory.
stream - The stream for the resource.
Throws:
ResourceProcessorException - if the resource cannot be processed. Only ResourceProcessorException.CODE_RESOURCE_SHARING_VIOLATION and ResourceProcessorException.CODE_OTHER_ERROR error codes are allowed.

dropped

public void dropped(String name)
             throws ResourceProcessorException
Description copied from interface: ResourceProcessor
Called when a resource, associated with a particular resource processor, had belonged to an earlier version of a deployment package but is not present in the current version of the deployment package. This provides an opportunity for the processor to cleanup any memory and persistent data being maintained for the particular resource. This method will only be called during "update" deployment sessions.

Specified by:
dropped in interface ResourceProcessor
Parameters:
name - the name of the resource to drop (it is the same as the value of the "Name" attribute in the deployment package's manifest)
Throws:
ResourceProcessorException - if the resource is not allowed to be dropped. Only the ResourceProcessorException.CODE_OTHER_ERROR error code is allowed

dropAllResources

public void dropAllResources()
                      throws ResourceProcessorException
Description copied from interface: ResourceProcessor
This method is called during an "uninstall" deployment session. This method will be called on all resource processors that are associated with resources in the deployment package being uninstalled. This provides an opportunity for the processor to cleanup any memory and persistent data being maintained for the deployment package.

Specified by:
dropAllResources in interface ResourceProcessor
Throws:
ResourceProcessorException - if all resources could not be dropped. Only the ResourceProcessorException.CODE_OTHER_ERROR is allowed.

prepare

public void prepare()
             throws ResourceProcessorException
Description copied from interface: ResourceProcessor
This method is called on the Resource Processor immediately before calling the commit method. The Resource Processor has to check whether it is able to commit the operations since the last begin method call. If it determines that it is not able to commit the changes, it has to raise a ResourceProcessorException with the ResourceProcessorException.CODE_PREPARE error code.

Specified by:
prepare in interface ResourceProcessor
Throws:
ResourceProcessorException - if the resource processor is able to determine it is not able to commit. Only the ResourceProcessorException.CODE_PREPARE error code is allowed.

commit

public void commit()
Description copied from interface: ResourceProcessor
Called when the processing of the current deployment package is finished. This method is called if the processing of the current deployment package was successful, and the changes must be made permanent.

Specified by:
commit in interface ResourceProcessor

rollback

public void rollback()
Description copied from interface: ResourceProcessor
Called when the processing of the current deployment package is finished. This method is called if the processing of the current deployment package was unsuccessful, and the changes made during the processing of the deployment package should be removed.

Specified by:
rollback in interface ResourceProcessor

cancel

public void cancel()
Description copied from interface: ResourceProcessor
Processing of a resource passed to the resource processor may take long. The cancel() method notifies the resource processor that it should interrupt the processing of the current resource. This method is called by the DeploymentAdmin implementation after the DeploymentAdmin.cancel() method is called.

Specified by:
cancel in interface ResourceProcessor


Copyright © 2011 Apache Software Foundation. All Rights Reserved.