io.cdap.cdap.api.artifact

Interface ArtifactManager

All Known Subinterfaces:

HttpServiceContext, ServiceContext

@Beta
public interface ArtifactManager

Provides access to artifacts

Method Summary

Modifier and Type	Method and Description
CloseableClassLoader	createClassLoader(ArtifactInfo artifactInfo, ClassLoader parentClassLoader) Create a class loader using the artifact represented by artifactInfo with parent as parentClassloader Call to this method might take a long time based on the size of the artifact.
CloseableClassLoader	createClassLoader(String namespace, ArtifactInfo artifactInfo, ClassLoader parentClassLoader) Create a class loader using the artifact represented by artifactInfo with parent as parentClassloader Call to this method might take a long time based on the size of the artifact.
List<ArtifactInfo>	listArtifacts() Get the list of artifacts in the repository in the current and system namespace
List<ArtifactInfo>	listArtifacts(String namespace) Get the list of artifacts in the repository in the specified namespace and system namespace

Method Detail

listArtifacts

List<ArtifactInfo> listArtifacts()
                          throws IOException,
                                 AccessException

Get the list of artifacts in the repository in the current and system namespace

Returns:

list of artifact info

Throws:

IOException - when there is an error retrieving artifacts

AccessException

listArtifacts

List<ArtifactInfo> listArtifacts(String namespace)
                          throws IOException,
                                 AccessException

Get the list of artifacts in the repository in the specified namespace and system namespace

Parameters:

namespace - the namespace to list artifacts for

Returns:

list of artifact info

Throws:

IOException - when there is an error retrieving artifacts

AccessException

createClassLoader

CloseableClassLoader createClassLoader(ArtifactInfo artifactInfo,
                                       @Nullable
                                       ClassLoader parentClassLoader)
                                throws IOException,
                                       AccessException

Create a class loader using the artifact represented by artifactInfo with parent as parentClassloader Call to this method might take a long time based on the size of the artifact. If called from short transactions, it is possible this call will timeout if the artifact size is large

Parameters:

artifactInfo - artifact info

parentClassLoader - parent class loader, if null bootstrap classLoader shall be used as parent

Returns:

Closeable class loader, calling close on this does the necessary cleanup.

Throws:

IOException - if there were any exception while creating the class loader or if the artifact is not found

AccessException

createClassLoader

CloseableClassLoader createClassLoader(String namespace,
                                       ArtifactInfo artifactInfo,
                                       @Nullable
                                       ClassLoader parentClassLoader)
                                throws IOException,
                                       AccessException

Create a class loader using the artifact represented by artifactInfo with parent as parentClassloader Call to this method might take a long time based on the size of the artifact. If called from short transactions, it is possible this call will timeout if the artifact size is large

Parameters:

namespace - the namespace of the specified artifact. This should be the same namespace that was used when calling listArtifacts(String)

artifactInfo - artifact info

parentClassLoader - parent class loader, if null bootstrap classLoader shall be used as parent

Returns:

Closeable class loader, calling close on this does the necessary cleanup.

Throws:

IOException - if there were any exception while creating the class loader or if the artifact is not found

AccessException