A B C D G I J M O P Q S U

A

accepts(CandidateArtifact) - Method in interface org.overlord.sramp.client.jar.ArtifactFilter

Called to determine if a given artifact from the source archive should be included in the target S-RAMP archive.

accepts(CandidateArtifact) - Method in class org.overlord.sramp.client.jar.DefaultArtifactFilter

add(File) - Method in class org.overlord.sramp.client.jar.DiscoveredArtifacts

Adds a candidate artifact to the set of collected (accepted/discovered) artifacts.

ArtifactFilter - Interface in org.overlord.sramp.client.jar

Interface used by the JarToSrampArchive class when discovering artifacts in the source archive that should be included in the target S-RAMP archive.

ArtifactSummary - Class in org.overlord.sramp.client.query

Models a summary of a single S-RAMP artifact from a Feed (result of an S-RAMP query).

ArtifactSummary(Entry) - Constructor for class org.overlord.sramp.client.query.ArtifactSummary

Constructor.

ascending() - Method in class org.overlord.sramp.client.SrampClientQuery

Sets ascending to true.

B

buildQuery(String) - Method in class org.overlord.sramp.client.SrampAtomApiClient

Build a query that can be parameterized and then executed.

C

CandidateArtifact - Class in org.overlord.sramp.client.jar

An artifact that *may* get included in the S-RAMP archive being created from a source JAR archive.

CandidateArtifact(File) - Constructor for class org.overlord.sramp.client.jar.CandidateArtifact

Constructor.

close() - Method in class org.overlord.sramp.client.jar.JarToSrampArchive

This object should be closed once we're done with it.

closeQuietly(JarToSrampArchive) - Static method in class org.overlord.sramp.client.jar.JarToSrampArchive

count(int) - Method in class org.overlord.sramp.client.SrampClientQuery

createMetaData(DiscoveredArtifact) - Method in class org.overlord.sramp.client.jar.DefaultMetaDataFactory

createMetaData(DiscoveredArtifact) - Method in interface org.overlord.sramp.client.jar.MetaDataFactory

Creates the meta-data object (S-RAMP specific) for the given artifact that will be included in the S-RAMP archive being created.

createSrampArchive() - Method in class org.overlord.sramp.client.jar.JarToSrampArchive

Creates an S-RAMP archive from this JAR.

D

DefaultArtifactFilter - Class in org.overlord.sramp.client.jar

A default implementation of an ArtifactFilter that includes only those files that are likely to be understood by the S-RAMP server (XML, Schema, WSDL, etc).

DefaultArtifactFilter() - Constructor for class org.overlord.sramp.client.jar.DefaultArtifactFilter

Constructor.

DefaultMetaDataFactory - Class in org.overlord.sramp.client.jar

Default implementation of a meta-data factory, providing a reasonable starting point for custom extensions (though it can also be used as-is to provide a very S-RAMP strict impl).

DefaultMetaDataFactory() - Constructor for class org.overlord.sramp.client.jar.DefaultMetaDataFactory

Constructor.

deleteArtifact(String, ArtifactType) - Method in class org.overlord.sramp.client.SrampAtomApiClient

Delets an artifact from the s-ramp repository.

deleteOntology(String) - Method in class org.overlord.sramp.client.SrampAtomApiClient

Deletes a single ontology by its UUID.

descending() - Method in class org.overlord.sramp.client.SrampClientQuery

Sets ascending to false.

DiscoveredArtifact - Class in org.overlord.sramp.client.jar

An artifact that will be incuded in the final S-RAMP archive.

DiscoveredArtifact(File) - Constructor for class org.overlord.sramp.client.jar.DiscoveredArtifact

Constructor.

DiscoveredArtifacts - Class in org.overlord.sramp.client.jar

The collection of artifacts found during the discovery process.

DiscoveredArtifacts() - Constructor for class org.overlord.sramp.client.jar.DiscoveredArtifacts

Constructor.

G

get(int) - Method in class org.overlord.sramp.client.query.QueryResultSet

Gets an item at the given index.

getArchivePath() - Method in class org.overlord.sramp.client.jar.DiscoveredArtifact

getArtifactContent(ArtifactType, String) - Method in class org.overlord.sramp.client.SrampAtomApiClient

Gets the content for an artifact as an input stream.

getArtifactMetaData(String) - Method in class org.overlord.sramp.client.SrampAtomApiClient

Gets the full meta-data listing for an Artifact in the S-RAMP repository.

getArtifactMetaData(ArtifactType, String) - Method in class org.overlord.sramp.client.SrampAtomApiClient

Gets the full meta-data listing for an Artifact in the S-RAMP repository.

getArtifacts() - Method in class org.overlord.sramp.client.jar.DiscoveredArtifacts

getBase() - Method in class org.overlord.sramp.client.ontology.OntologySummary

getComment() - Method in class org.overlord.sramp.client.ontology.OntologySummary

getContent() - Method in class org.overlord.sramp.client.jar.DiscoveredArtifact

Returns an InputStream over the content of the artifact.

getCreatedBy() - Method in class org.overlord.sramp.client.ontology.OntologySummary

getCreatedBy() - Method in class org.overlord.sramp.client.query.ArtifactSummary

getCreatedTimestamp() - Method in class org.overlord.sramp.client.ontology.OntologySummary

getCreatedTimestamp() - Method in class org.overlord.sramp.client.query.ArtifactSummary

getCustomPropertyValue(String) - Method in class org.overlord.sramp.client.query.ArtifactSummary

Returns the value of a property included in the query result set.

getDescription() - Method in class org.overlord.sramp.client.query.ArtifactSummary

getEndpoint() - Method in class org.overlord.sramp.client.SrampAtomApiClient

getFile() - Method in class org.overlord.sramp.client.jar.DiscoveredArtifact

getId() - Method in class org.overlord.sramp.client.ontology.OntologySummary

getItemsPerPage() - Method in class org.overlord.sramp.client.query.QueryResultSet

Returns the number of items per page in the result set, even if the total number of items returned is less.

getLabel() - Method in class org.overlord.sramp.client.ontology.OntologySummary

getLastModifiedTimestamp() - Method in class org.overlord.sramp.client.ontology.OntologySummary

getLastModifiedTimestamp() - Method in class org.overlord.sramp.client.query.ArtifactSummary

getMetaData() - Method in class org.overlord.sramp.client.jar.DiscoveredArtifact

getName() - Method in class org.overlord.sramp.client.jar.CandidateArtifact

Gets the name of the candidate artifact.

getName() - Method in class org.overlord.sramp.client.jar.DiscoveredArtifact

Gets the short name of the artifact.

getName() - Method in class org.overlord.sramp.client.query.ArtifactSummary

getOntologies() - Method in class org.overlord.sramp.client.SrampAtomApiClient

Gets a list of all the ontologies currently installed in the S-RAMP repository.

getServiceDocument() - Method in class org.overlord.sramp.client.SrampAtomApiClient

Gets the S-RAMP service document.

getStartIndex() - Method in class org.overlord.sramp.client.query.QueryResultSet

Returns the starting index for the result set.

getTotalResults() - Method in class org.overlord.sramp.client.query.QueryResultSet

Returns the total results matched by the query.

getType() - Method in class org.overlord.sramp.client.query.ArtifactSummary

getUuid() - Method in class org.overlord.sramp.client.ontology.OntologySummary

getUuid() - Method in class org.overlord.sramp.client.query.ArtifactSummary

I

index(File) - Method in class org.overlord.sramp.client.jar.DiscoveredArtifacts

Indexes all of the discovered artifacts using the given directory as the base directory (for determining canonical archive paths).

isDerived() - Method in class org.overlord.sramp.client.query.ArtifactSummary

isExtendedType() - Method in class org.overlord.sramp.client.query.ArtifactSummary

iterator() - Method in class org.overlord.sramp.client.jar.DiscoveredArtifacts

iterator() - Method in class org.overlord.sramp.client.query.QueryResultSet

J

JarToSrampArchive - Class in org.overlord.sramp.client.jar

Class that converts a JAR into an S-RAMP archive.

JarToSrampArchive(File) - Constructor for class org.overlord.sramp.client.jar.JarToSrampArchive

Constructor.

JarToSrampArchive(InputStream) - Constructor for class org.overlord.sramp.client.jar.JarToSrampArchive

Constructor from JAR input stream.

JarToSrampArchiveException - Exception in org.overlord.sramp.client.jar

Exception thrown when a problem with the JarToSrampArchive class encounters an error.

JarToSrampArchiveException() - Constructor for exception org.overlord.sramp.client.jar.JarToSrampArchiveException

Constructor.

JarToSrampArchiveException(String) - Constructor for exception org.overlord.sramp.client.jar.JarToSrampArchiveException

Constructor.

JarToSrampArchiveException(String, Throwable) - Constructor for exception org.overlord.sramp.client.jar.JarToSrampArchiveException

Constructor.

JarToSrampArchiveException(Throwable) - Constructor for exception org.overlord.sramp.client.jar.JarToSrampArchiveException

Constructor.

M

MetaDataFactory - Interface in org.overlord.sramp.client.jar

Factory responsible for creating artifact meta data.

O

OntologySummary - Class in org.overlord.sramp.client.ontology

Models a summary of a single S-RAMP ontology from a Feed.

OntologySummary(Entry) - Constructor for class org.overlord.sramp.client.ontology.OntologySummary

Constructor.

orderBy(String) - Method in class org.overlord.sramp.client.SrampClientQuery

org.overlord.sramp.client - package org.overlord.sramp.client

org.overlord.sramp.client.jar - package org.overlord.sramp.client.jar

org.overlord.sramp.client.ontology - package org.overlord.sramp.client.ontology

org.overlord.sramp.client.query - package org.overlord.sramp.client.query

P

parameter(String) - Method in class org.overlord.sramp.client.SrampClientQuery

Sets a parameter on the query - this should match up to a ? in the query template provided.

parameter(int) - Method in class org.overlord.sramp.client.SrampClientQuery

Sets a parameter on the query - this should match up to a ? in the query template provided.

parameter(long) - Method in class org.overlord.sramp.client.SrampClientQuery

Sets a parameter on the query - this should match up to a ? in the query template provided.

parameter(double) - Method in class org.overlord.sramp.client.SrampClientQuery

Sets a parameter on the query - this should match up to a ? in the query template provided.

parameter(Date) - Method in class org.overlord.sramp.client.SrampClientQuery

Sets a parameter on the query - this should match up to a ? in the query template provided.

parameter(Calendar) - Method in class org.overlord.sramp.client.SrampClientQuery

Sets a parameter on the query.

parameter(float) - Method in class org.overlord.sramp.client.SrampClientQuery

Sets a parameter on the query - this should match up to a ? in the query template provided.

parameter(Number) - Method in class org.overlord.sramp.client.SrampClientQuery

Sets a parameter on the query - this should match up to a ? in the query template provided.

propertyName(String) - Method in class org.overlord.sramp.client.SrampClientQuery

Q

query(String) - Method in class org.overlord.sramp.client.SrampAtomApiClient

Provides a very simple mechanism for querying.

query(String, int, int, String, boolean) - Method in class org.overlord.sramp.client.SrampAtomApiClient

Executes the given s-ramp query xpath and returns a Feed of the matching artifacts.

query(String, int, int, String, boolean, Collection<String>) - Method in class org.overlord.sramp.client.SrampAtomApiClient

Executes the given s-ramp query xpath and returns a Feed of the matching artifacts.

query() - Method in class org.overlord.sramp.client.SrampClientQuery

Formats the query given the replacement params, then issues the query to the S-RAMP repository and returns the result.

QueryResultSet - Class in org.overlord.sramp.client.query

An instance of this class is returned by the Atom API client when consumers call the query methods.

QueryResultSet(Feed) - Constructor for class org.overlord.sramp.client.query.QueryResultSet

Constructor.

S

setArchivePath(String) - Method in class org.overlord.sramp.client.jar.DiscoveredArtifact

setArtifactFilter(ArtifactFilter) - Method in class org.overlord.sramp.client.jar.JarToSrampArchive

setArtifacts(Set<DiscoveredArtifact>) - Method in class org.overlord.sramp.client.jar.DiscoveredArtifacts

setFile(File) - Method in class org.overlord.sramp.client.jar.DiscoveredArtifact

setMetaData(BaseArtifactType) - Method in class org.overlord.sramp.client.jar.DiscoveredArtifact

setMetaDataFactory(MetaDataFactory) - Method in class org.overlord.sramp.client.jar.JarToSrampArchive

size() - Method in class org.overlord.sramp.client.query.QueryResultSet

Returns the number of artifacts that matched the query.

SrampAtomApiClient - Class in org.overlord.sramp.client

Class used to communicate with the S-RAMP server via the S-RAMP Atom API.

SrampAtomApiClient(String) - Constructor for class org.overlord.sramp.client.SrampAtomApiClient

Constructor.

SrampAtomApiClient(String, boolean) - Constructor for class org.overlord.sramp.client.SrampAtomApiClient

Constructor.

SrampClientException - Exception in org.overlord.sramp.client

Exception thrown by the S-RAMP client when an error of some kind is encountered.

SrampClientException() - Constructor for exception org.overlord.sramp.client.SrampClientException

Constructor.

SrampClientException(String) - Constructor for exception org.overlord.sramp.client.SrampClientException

Constructor.

SrampClientException(String, Throwable) - Constructor for exception org.overlord.sramp.client.SrampClientException

Constructor.

SrampClientException(Throwable) - Constructor for exception org.overlord.sramp.client.SrampClientException

Constructor.

SrampClientQuery - Class in org.overlord.sramp.client

An S-RAMP Query, created by the SrampAtomApiClient from an xpath template.

SrampClientQuery(SrampAtomApiClient, String) - Constructor for class org.overlord.sramp.client.SrampClientQuery

Constructor.

startIndex(int) - Method in class org.overlord.sramp.client.SrampClientQuery

U

updateArtifactContent(BaseArtifactType, InputStream) - Method in class org.overlord.sramp.client.SrampAtomApiClient

Updates the content of the artifact.

updateArtifactMetaData(BaseArtifactType) - Method in class org.overlord.sramp.client.SrampAtomApiClient

Called to update the meta-data stored in the s-ramp repository for the given s-ramp artifact.

uploadArtifact(ArtifactType, InputStream, String) - Method in class org.overlord.sramp.client.SrampAtomApiClient

Please refer to javadoc in SrampAtomApiClient#uploadArtifact(String, String, InputStream, String)

uploadArtifact(BaseArtifactType, InputStream) - Method in class org.overlord.sramp.client.SrampAtomApiClient

Please refer to javadoc in SrampAtomApiClient#uploadArtifact(String, String, InputStream, String)

uploadBatch(SrampArchive) - Method in class org.overlord.sramp.client.SrampAtomApiClient

Performs a batch operation by uploading an s-ramp package archive to the s-ramp server for processing.

uploadOntology(InputStream) - Method in class org.overlord.sramp.client.SrampAtomApiClient

Uploads an ontology to the S-RAMP repository.

A B C D G I J M O P Q S U