org.fabric3.spi.contribution

Interface ContributionProcessor

public interface ContributionProcessor

Interface for services that process contributions. Contribution processing occurs in several phases. Contribution metadata is first processed, after which contained resources are indexed. Indexed Resources contain 0..n ResourceElements, which are addressable parts. ResourceElements contain a key for a symbol space and a value. When a resource is indexed, only ResourceElement keys are available; their values have not yet been loaded. The final processing phase is when the contribution is loaded. At this point, all contribution artifacts, including those in dependent contributions, are made available through the provided classloader. Indexed Resources are iterated and all ResourceElement values are loaded via the loader framework. As ResourceElements may refer to other ResourceElements, loading may occur recursively.

Method Summary

Modifier and Type	Method and Description
boolean	canProcess(Contribution contribution) Returns true if the processor can process the contribution.
void	index(Contribution contribution, IntrospectionContext context) Indexes all contribution resources
void	process(Contribution contribution, IntrospectionContext context) Loads all resources in the contribution.
void	processManifest(Contribution contribution, IntrospectionContext context) Processes manifest information for the contribution, including imports and exports.

Method Detail

canProcess

boolean canProcess(Contribution contribution)

Returns true if the processor can process the contribution.

Parameters:

contribution - the contribution

Returns:

true if the processor can process the contribution.

processManifest

void processManifest(Contribution contribution,
                     IntrospectionContext context)
              throws org.fabric3.api.host.Fabric3Exception

Processes manifest information for the contribution, including imports and exports.

Parameters:

contribution - the contribution that will be used to hold the results from the processing

context - the context to which validation errors and warnings are reported

Throws:

org.fabric3.api.host.Fabric3Exception - if there was a problem with the contribution

index

void index(Contribution contribution,
           IntrospectionContext context)
    throws org.fabric3.api.host.Fabric3Exception

Indexes all contribution resources

Parameters:

contribution - the contribution to index

context - the context to which validation errors and warnings are reported

Throws:

org.fabric3.api.host.Fabric3Exception - if there was a problem indexing

process

void process(Contribution contribution,
             IntrospectionContext context)
      throws org.fabric3.api.host.Fabric3Exception

Loads all resources in the contribution.

Parameters:

contribution - the contribution

context - the context to which validation errors and warnings are reported

Throws:

org.fabric3.api.host.Fabric3Exception - if there was a problem loading the contribution resources