org.fabric3.spi.contribution

Class Contribution

java.lang.Object

org.fabric3.spi.contribution.Contribution

All Implemented Interfaces:

java.io.Serializable

public class Contribution
extends java.lang.Object
implements java.io.Serializable

The base representation of a deployed contribution

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Contribution(java.net.URI uri)
Contribution(java.net.URI uri, org.fabric3.api.host.stream.Source source, java.net.URL location, long timestamp, java.lang.String contentType) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addAdditionalLocation(java.net.URL location) Adds an additional content location.
void	addMetaData(java.lang.Object key, java.lang.Object value) Adds metadata to the context.
void	addResolvedExtensionProvider(java.net.URI uri) Adds the URI of the resolved extension provider.
void	addResource(Resource resource) Adds a resource to the contribution.
void	addWire(ContributionWire<?,?> wire) Adds a wire for an import
void	deploy() Deploys the contribution.
boolean	equals(java.lang.Object o)
java.util.List<java.net.URL>	getAdditionalLocations() Returns additional content locations for the contribution.
java.lang.String	getContentType() Returns the MIME type for the contribution.
java.net.URL	getLocation() Returns the local URL for the contribution artifact or null if the contribution is not a physical artifact (e.g.
ContributionManifest	getManifest() Returns the contribution manifest.
<T> T	getMetaData(java.lang.Class<T> type, java.lang.Object key) Returns metadata stored metadata.
java.util.List<java.net.URI>	getResolvedExtensionProviders() Gets the URIs of the resolved extension providers.
java.util.List<Resource>	getResources() Returns the list of resources for the contribution.
org.fabric3.api.host.stream.Source	getSource() Returns a source for reading contents of the contribution.
ContributionState	getState() Returns the contribution lifecycle state.
long	getTimestamp() Returns the timestamp of the most recent update to the artifact.
java.net.URI	getUri() Returns the contribution URI.
java.util.List<ContributionWire<?,?>>	getWires() Returns the wires for this contribution.
void	install() Marks the contribution as installed.
void	overrideLocation(java.net.URL location) Used to override the contribution location during processing.
void	removeMetaData(java.lang.Object key) Removes metadata to the context.
void	setManifest(ContributionManifest manifest) Sets the contribution manifest.
void	undeploy() Undeploys the contribution.
void	uninstall() Uninstalls the contribution.

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Contribution

public Contribution(java.net.URI uri)

Contribution

public Contribution(java.net.URI uri,
                    org.fabric3.api.host.stream.Source source,
                    java.net.URL location,
                    long timestamp,
                    java.lang.String contentType)

Constructor.

Parameters:

uri - the contribution URI

source - the source for reading the contribution contents

location - the URL for the contribution archive. This can be null for contributions that are not physical archives.

timestamp - the contribution artifact time stamp

contentType - the contribution MIME type

Method Detail

getUri

public java.net.URI getUri()

Returns the contribution URI.

Returns:

the contribution URI

getState

public ContributionState getState()

Returns the contribution lifecycle state.

Returns:

the contribution lifecycle state

install

public void install()

Marks the contribution as installed.

uninstall

public void uninstall()

Uninstalls the contribution.

deploy

public void deploy()

Deploys the contribution.

undeploy

public void undeploy()

Undeploys the contribution.

getLocation

public java.net.URL getLocation()

Returns the local URL for the contribution artifact or null if the contribution is not a physical artifact (e.g. it is synthesized from some source).

Returns:

the dereferenceable URL for the contribution artifact or null

overrideLocation

public void overrideLocation(java.net.URL location)

Used to override the contribution location during processing.

Parameters:

location - the new contribution location

getAdditionalLocations

public java.util.List<java.net.URL> getAdditionalLocations()

Returns additional content locations for the contribution. For example, exploded web applications may be composed of multiple directories mapped from a development environment.

Returns:

the locations.

addAdditionalLocation

public void addAdditionalLocation(java.net.URL location)

Adds an additional content location.

Parameters:

location - the location

getContentType

public java.lang.String getContentType()

Returns the MIME type for the contribution.

Returns:

the MIME type for the contribution

getSource

public org.fabric3.api.host.stream.Source getSource()

Returns a source for reading contents of the contribution.

Returns:

a source for reading contents of the contribution

getTimestamp

public long getTimestamp()

Returns the timestamp of the most recent update to the artifact.

Returns:

the timestamp of the most recent update to the artifact

getManifest

public ContributionManifest getManifest()

Returns the contribution manifest.

Returns:

the contribution manifest

setManifest

public void setManifest(ContributionManifest manifest)

Sets the contribution manifest.

Parameters:

manifest - the contribution manifest

addResource

public void addResource(Resource resource)

Adds a resource to the contribution.

Parameters:

resource - the resource

getResources

public java.util.List<Resource> getResources()

Returns the list of resources for the contribution.

Returns:

the list of resources

addWire

public void addWire(ContributionWire<?,?> wire)

Adds a wire for an import

Parameters:

wire - the wire

getWires

public java.util.List<ContributionWire<?,?>> getWires()

Returns the wires for this contribution.

Returns:

the wires for this contribution

addResolvedExtensionProvider

public void addResolvedExtensionProvider(java.net.URI uri)

Adds the URI of the resolved extension provider.

Parameters:

uri - the URI of the resolved extension provider.

getResolvedExtensionProviders

public java.util.List<java.net.URI> getResolvedExtensionProviders()

Gets the URIs of the resolved extension providers.

Returns:

the URIs of the resolved extension providers

addMetaData

public void addMetaData(java.lang.Object key,
                        java.lang.Object value)

Adds metadata to the context.

Parameters:

key - the metadata key

value - the metadata value

removeMetaData

public void removeMetaData(java.lang.Object key)

Removes metadata to the context.

Parameters:

key - the metadata key

getMetaData

public <T> T getMetaData(java.lang.Class<T> type,
                         java.lang.Object key)

Returns metadata stored metadata.

Parameters:

type - the expected metadata type

key - the metadata key

Returns:

the metadata value or null if not found

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object