org.fabric3.spi.contribution.Contribution Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of fabric3-spi Show documentation
Show all versions of fabric3-spi Show documentation
SPIs for runtime extensions
/*
* Fabric3
* Copyright (c) 2009-2011 Metaform Systems
*
* Fabric3 is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as
* published by the Free Software Foundation, either version 3 of
* the License, or (at your option) any later version, with the
* following exception:
*
* Linking this software statically or dynamically with other
* modules is making a combined work based on this software.
* Thus, the terms and conditions of the GNU General Public
* License cover the whole combination.
*
* As a special exception, the copyright holders of this software
* give you permission to link this software with independent
* modules to produce an executable, regardless of the license
* terms of these independent modules, and to copy and distribute
* the resulting executable under terms of your choice, provided
* that you also meet, for each linked independent module, the
* terms and conditions of the license of that module. An
* independent module is a module which is not derived from or
* based on this software. If you modify this software, you may
* extend this exception to your version of the software, but
* you are not obligated to do so. If you do not wish to do so,
* delete this exception statement from your version.
*
* Fabric3 is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty
* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU General Public License for more details.
*
* You should have received a copy of the
* GNU General Public License along with Fabric3.
* If not, see profiles;
private URL location;
private long timestamp;
private String contentType;
private boolean persistent;
private ContributionManifest manifest = new ContributionManifest();
private List resources = new ArrayList();
private Map metadata = new HashMap();
private List> wires = new ArrayList>();
private List resolvedExtensionProviders = new ArrayList();
private List lockOwners = new ArrayList();
public Contribution(URI uri) {
this.uri = uri;
profiles = new ArrayList();
}
/**
* Constructor.
*
* @param uri the contribution URI
* @param source the source for reading the contribution contents
* @param location the URL for the contribution archive. This can be null for contributions that are not physical archives.
* @param timestamp the contribution artifact time stamp
* @param contentType the contribution MIME type
* @param persistent true if the contribution is persistent
*/
public Contribution(URI uri, Source source, URL location, long timestamp, String contentType, boolean persistent) {
this.uri = uri;
this.source = source;
this.profiles = new ArrayList();
this.location = location;
this.timestamp = timestamp;
this.contentType = contentType;
this.persistent = persistent;
}
/**
* Returns the contribution URI.
*
* @return the contribution URI
*/
public URI getUri() {
return uri;
}
/**
* Returns the contribution lifecycle state.
*
* @return the contribution lifecycle state
*/
public ContributionState getState() {
return state;
}
/**
* Sets the contribution lifecycle state.
*
* @param state the contribution lifecycle state
*/
public void setState(ContributionState state) {
this.state = state;
}
/**
* Returns true if the contribution is persistent.
*
* @return true if the contribution is persistent.
*/
public boolean isPersistent() {
return persistent;
}
/**
* 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).
*
* @return the dereferenceable URL for the contribution artifact or null
*/
public URL getLocation() {
return location;
}
/**
* Returns the MIME type for the contribution.
*
* @return the MIME type for the contribution
*/
public String getContentType() {
return contentType;
}
/**
* Returns a source for reading contents of the contribution.
*
* @return a source for reading contents of the contribution
*/
public Source getSource() {
return source;
}
/**
* Returns the timestamp of the most recent update to the artifact.
*
* @return the timestamp of the most recent update to the artifact
*/
public long getTimestamp() {
return timestamp;
}
/**
* Returns the contribution manifest.
*
* @return the contribution manifest
*/
public ContributionManifest getManifest() {
return manifest;
}
/**
* Sets the contribution manifest.
*
* @param manifest the contribution manifest
*/
public void setManifest(ContributionManifest manifest) {
this.manifest = manifest;
}
/**
* Adds a resource to the contribution.
*
* @param resource the resource
*/
public void addResource(Resource resource) {
resources.add(resource);
}
/**
* Returns the list of resources for the contribution.
*
* @return the list of resources
*/
public List getResources() {
return resources;
}
/**
* Returns the profiles this contribution is associated with.
*
* @return the profiles this contribution is associated with
*/
public List getProfiles() {
return profiles;
}
/**
* Adds an associated profile.
*
* @param uri the profile URI
*/
public void addProfile(URI uri) {
profiles.add(uri);
}
/**
* Adds associated profiles.
*
* @param uris the profile URIs
*/
public void addProfiles(List uris) {
profiles.addAll(uris);
}
/**
* Removes the profile from the contribution. Contributions track the profiles they are members of.
*
* @param uri the profile URI
*/
public void removeProfile(URI uri) {
profiles.remove(uri);
}
/**
* Adds a wire for an import
*
* @param wire the wire
*/
public void addWire(ContributionWire wire) {
wires.add(wire);
}
/**
* Returns the wires for this contribution.
*
* @return the wires for this contribution
*/
public List> getWires() {
return wires;
}
/**
* Adds the URI of the resolved extension provider.
*
* @param uri the URI of the resolved extension provider.
*/
public void addResolvedExtensionProvider(URI uri) {
resolvedExtensionProviders.add(uri);
}
/**
* Gets the URIs of the resolved extension providers.
*
* @return the URIs of the resolved extension providers
*/
public List getResolvedExtensionProviders() {
return resolvedExtensionProviders;
}
/**
* Adds metadata to the context.
*
* @param key the metadata key
* @param value the metadata value
*/
public void addMetaData(Object key, Object value) {
metadata.put(key, value);
}
/**
* Removes metadata to the context.
*
* @param key the metadata key
*/
public void removeMetaData(Object key) {
metadata.remove(key);
}
/**
* Returns metadata stored metadata.
*
* @param type the expected metadata type
* @param key the metadata key
* @return the metadata value or null if not found
*/
public T getMetaData(Class type, Object key) {
return type.cast(metadata.get(key));
}
/**
* Acquires a lock for the contribution. If a contribution is locked, it cannot be uninstalled. Locks may be acquired by multiple owners, for
* example, deployable composites that are contained in a contribution when they are deployed.
*
* @param owner the lock owner
*/
public void acquireLock(QName owner) {
if (lockOwners.contains(owner)) {
throw new IllegalStateException("Lock already held by owner for contribution " + uri + " :" + owner);
}
lockOwners.add(owner);
}
/**
* Releases a lock held by the given owner.
*
* @param owner the lock owner
*/
public void releaseLock(QName owner) {
if (lockOwners.isEmpty()) {
return;
}
if (!lockOwners.remove(owner)) {
throw new IllegalStateException("Lock not held by owner for contribution " + uri + " :" + owner);
}
}
/**
* Returns the set of current lock owners ordered by time of lock acquisition.
*
* @return the set of current lock owners
*/
public List getLockOwners() {
return lockOwners;
}
/**
* Returns true if the contribution is locked. Locked contributions cannot be uninstalled.
*
* @return true if the contribution is locked
*/
public boolean isLocked() {
return !lockOwners.isEmpty();
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
Contribution that = (Contribution) o;
return !(uri != null ? !uri.equals(that.uri) : that.uri != null);
}
}