A B C D G H I O P Q S T U

A

addAuditEntry(String, AuditEntry) - Method in class org.overlord.sramp.client.SrampAtomApiClient

Adds a new audit entry on the artifact with the given UUID.

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.

AuditEntrySummary - Class in org.overlord.sramp.client.audit

Models a summary of a single S-RAMP audit entry.

AuditEntrySummary(Entry) - Constructor for class org.overlord.sramp.client.audit.AuditEntrySummary

Constructor.

AuditResultSet - Class in org.overlord.sramp.client.audit

An instance of this class is returned by the Atom API client when consumers ask for an audit trail (either by artifact or by user).

AuditResultSet(Feed) - Constructor for class org.overlord.sramp.client.audit.AuditResultSet

Constructor.

AuthenticationProvider - Interface in org.overlord.sramp.client.auth

Clients can supply their own authentication implementation by implementing this interface.

AuthorizationHeaderAuthenticationProvider - Class in org.overlord.sramp.client.auth

Provides authentication via the Authorization HTTP header.

AuthorizationHeaderAuthenticationProvider() - Constructor for class org.overlord.sramp.client.auth.AuthorizationHeaderAuthenticationProvider

Constructor.

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

Constructor.

B

BasicAuthenticationProvider - Class in org.overlord.sramp.client.auth

Provides BASIC authentication.

BasicAuthenticationProvider(String, String) - Constructor for class org.overlord.sramp.client.auth.BasicAuthenticationProvider

Constructor.

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

Build a query that can be parameterized and then executed.

C

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

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

Creates a new artifact in the S-RAMP repository.

createBasicAuthHeader(String, String) - Static method in class org.overlord.sramp.client.auth.BasicAuthenticationProvider

Creates the BASIC auth header value.

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

Creates the RESTEasy client request object, configured appropriately.

D

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.

G

get(int) - Method in class org.overlord.sramp.client.audit.AuditResultSet

Gets an item at the given index.

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

Gets an item at the given index.

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

Gets the content for an artifact as an input stream.

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

Convenience method for getting the artifact content given an artifact summary (which are typically returned when performing s-ramp queries).

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(ArtifactSummary) - Method in class org.overlord.sramp.client.SrampAtomApiClient

Convenience method to get the artifact meta-data given an artifact summary (which are typically returned when performing s-ramp queries).

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.

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

Gets the full audit entry for the given artifact + audit event pair.

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

Gets the audit trail for the artifact with the given UUID.

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

Gets the audit trail for the artifact with the given UUID.

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

Gets the audit trail for the artifact with the given UUID.

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

Gets the audit trail for the artifact with the given UUID.

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

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

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

getHeaderName() - Method in class org.overlord.sramp.client.auth.HttpHeaderAuthenticationProvider

getHeaderValue() - Method in class org.overlord.sramp.client.auth.HttpHeaderAuthenticationProvider

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

getItemsPerPage() - Method in class org.overlord.sramp.client.audit.AuditResultSet

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

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

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.

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

Gets a single ontology by UUID.

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

Gets the S-RAMP service document.

getStartIndex() - Method in class org.overlord.sramp.client.audit.AuditResultSet

Returns the starting index for the result set.

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.audit.AuditResultSet

Returns the total results matched by the query.

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.audit.AuditEntrySummary

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

getUuid() - Method in class org.overlord.sramp.client.audit.AuditEntrySummary

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

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

getWhen() - Method in class org.overlord.sramp.client.audit.AuditEntrySummary

getWho() - Method in class org.overlord.sramp.client.audit.AuditEntrySummary

H

HttpHeaderAuthenticationProvider - Class in org.overlord.sramp.client.auth

Provides authentication via an HTTP header.

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

Constructor.

HttpHeaderAuthenticationProvider(String, String) - Constructor for class org.overlord.sramp.client.auth.HttpHeaderAuthenticationProvider

Constructor.

I

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.audit.AuditResultSet

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

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.audit - package org.overlord.sramp.client.audit

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

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

provideAuthentication(HttpRequest) - Method in interface org.overlord.sramp.client.auth.AuthenticationProvider

Called by the S-RAMP atom API client to add authentication to the HttpRequest.

provideAuthentication(HttpRequest) - Method in class org.overlord.sramp.client.auth.HttpHeaderAuthenticationProvider

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

setHeaderName(String) - Method in class org.overlord.sramp.client.auth.HttpHeaderAuthenticationProvider

setHeaderValue(String) - Method in class org.overlord.sramp.client.auth.HttpHeaderAuthenticationProvider

size() - Method in class org.overlord.sramp.client.audit.AuditResultSet

Returns the number of artifacts that matched the query.

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.

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

Constructor.

SrampAtomApiClient(String, AuthenticationProvider, 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

T

toString() - Method in class org.overlord.sramp.client.audit.AuditEntrySummary

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

Creates a new artifact in the repository by uploading a document.

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

Creates a new artifact in the repository by uploading a document.

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 H I O P Q S T U