Package org.eclipse.lyo.client

Class OslcClient

java.lang.Object

org.eclipse.lyo.client.OslcClient

All Implemented Interfaces:

IOslcClient

public class OslcClient
extends Object
implements IOslcClient

An OSLC Client that extends the JAX-RS 2.0 REST client with OSLC specific CRUD and discovery capabilities. Client applications would typically provide a ClientBuilder to the constructor to configure the REST client too meet their needs.

Constructor Summary

Constructors

Constructor	Description
OslcClient()	A simple OslcClient that provides http access to unprotected resources
OslcClient(ClientBuilder clientBuilder)	An OslcClient that allows client applications to provide a configured (but not built) ClientBuilder typically used for supporting https, and various kinds of authentication.
OslcClient(ClientBuilder clientBuilder, String version)	An OslcClient that allows client applications to provide a configured (but not built) ClientBuilder typically used for supporting https, and various kinds of authentication.
OslcClient(ClientBuilder clientBuilder, String version, Set<Class<?>> providers)	An OslcClient that allows client applications to provide a configured (but not built) ClientBuilder typically used for supporting https, and various kinds of authentication.
OslcClient(String version)

Method Summary

Modifier and Type	Method	Description
Response	createResource(String url, Object artifact, String mediaType)	Create (POST) an artifact to a URL - usually an OSLC Creation Factory
Response	createResource(String url, Object artifact, String mediaType, String acceptType)	Create (POST) an artifact to a URL - usually an OSLC Creation Factory
Response	createResource(String url, Object artifact, String mediaType, String acceptType, String configurationContext)
Response	deleteResource(String url)	Delete an OSLC resource and return the Response
Response	deleteResource(String url, String configurationContext)	Delete an OSLC resource in the given configuration context and return the Response
Client	getClient()	Returns the JAX-RS client for this OslcClient.
Response	getResource(String url)	Gets an OSLC resource using application/rdf+xml.
<T> T	getResource(String link, Class<T> clazz)	Gets an OSLC resource from a given URI string and unwraps a corresponding entity.
Response	getResource(String url, String mediaType)	Gets an OSLC resource.
Response	getResource(String url, Map<String,String> requestHeaders)	Gets an OSLC resource.
Response	getResource(String url, Map<String,String> requestHeaders, String defaultMediaType)
Response	getResource(String url, Map<String,String> requestHeaders, String defaultMediaType, boolean handleRedirects)
Response	getResource(String url, Map<String,String> requestHeaders, String defaultMediaType, String configurationContext)
Response	getResource(String url, Map<String,String> requestHeaders, String defaultMediaType, String configurationContext, boolean handleRedirects)
<T> T	getResource(URI link, Class<T> clazz)	Gets an OSLC resource from a given URI and unwraps a corresponding entity.
<T> T	getResource(Link link, Class<T> clazz)	Gets an OSLC resource from a URI in a given Link and unwraps a corresponding entity.
<T> List<T>	getResources(URI[] links, Class<T> clazz)	Gets OSLC resources in parallel from an array of URIs and unwraps their corresponding entities.
<T> List<T>	getResources(Collection<URI> links, Class<T> clazz)	Gets OSLC resources in parallel from a collection of URIs and unwraps their corresponding entities.
<T> List<T>	getResourcesFromLinks(Collection<Link> links, Class<T> clazz)	Gets OSLC resources in parallel from a set of Links and unwraps their corresponding entities.
WebTarget	getWebResource(String capabilityUri)	Create a Wink Resource for the given OslcQuery object
String	lookupCreationFactory(String serviceProviderUrl, String oslcDomain, String oslcResourceType)	Find the OSLC Creation Factory URL for a given OSLC resource type.
String	lookupCreationFactory(String serviceProviderUrl, String oslcDomain, String oslcResourceType, String oslcUsage)	Find the OSLC Creation Factory URL for a given OSLC resource type and OSLC usage.
CreationFactory	lookupCreationFactoryResource(String serviceProviderUrl, String oslcDomain, String oslcResourceType)
CreationFactory	lookupCreationFactoryResource(String serviceProviderUrl, String oslcDomain, String oslcResourceType, String oslcUsage)
String	lookupQueryCapability(String serviceProviderUrl, String oslcDomain, String oslcResourceType)	Find the OSLC Query Capability URL for a given OSLC resource type.
String	lookupServiceProviderUrl(String catalogUrl, String serviceProviderTitle)	Lookup the URL of a specific OSLC Service Provider in an OSLC Catalog using the service provider's title
Response	updateResource(String url, Object artifact, String mediaType)	Update (PUT) an artifact to a URL - usually the URL for an existing OSLC artifact
Response	updateResource(String url, Object artifact, String mediaType, String acceptType)	Update (PUT) an artifact to a URL - usually the URL for an existing OSLC artifact
Response	updateResource(String url, Object artifact, String mediaType, String acceptType, String ifMatch)	Update (PUT) an artifact to a URL - usually the URL for an existing OSLC artifact
Response	updateResource(String url, Object artifact, String mediaType, String acceptType, String ifMatch, String configurationContext)

Methods inherited from class java.lang.Object

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

Constructor Details

OslcClient

public OslcClient()

A simple OslcClient that provides http access to unprotected resources

OslcClient

public OslcClient(String version)

Parameters:

version - OSLC version, see OSLCConstants

OslcClient

public OslcClient(ClientBuilder clientBuilder)

An OslcClient that allows client applications to provide a configured (but not built) ClientBuilder typically used for supporting https, and various kinds of authentication.

Parameters:

clientBuilder - HTTP client configuration

OslcClient

public OslcClient(ClientBuilder clientBuilder,
 String version)

An OslcClient that allows client applications to provide a configured (but not built) ClientBuilder typically used for supporting https, and various kinds of authentication.

Parameters:

clientBuilder - HTTP client configuration

version - OSLC version, see OSLCConstants

OslcClient

public OslcClient(ClientBuilder clientBuilder,
 String version,
 Set<Class<?>> providers)

An OslcClient that allows client applications to provide a configured (but not built) ClientBuilder typically used for supporting https, and various kinds of authentication.

Parameters:

clientBuilder - HTTP client configuration

version - OSLC version, see OSLCConstants

providers - Set of Providers for MessageBodyReader and MessageBodyWriter

Method Details

getClient

public Client getClient()

Returns the JAX-RS client for this OslcClient. Do not touch unless needed.

Specified by:

getClient in interface IOslcClient

Returns:

the JAX-RS client

getResource

public <T> T getResource(String link,
 Class<T> clazz)

Gets an OSLC resource from a given URI string and unwraps a corresponding entity.

getResource

public <T> T getResource(URI link,
 Class<T> clazz)

Gets an OSLC resource from a given URI and unwraps a corresponding entity.

getResource

public <T> T getResource(Link link,
 Class<T> clazz)

Gets an OSLC resource from a URI in a given Link and unwraps a corresponding entity.

getResources

public <T> List<T> getResources(URI[] links,
 Class<T> clazz)

Gets OSLC resources in parallel from an array of URIs and unwraps their corresponding entities.

getResources

public <T> List<T> getResources(Collection<URI> links,
 Class<T> clazz)

Gets OSLC resources in parallel from a collection of URIs and unwraps their corresponding entities.

getResourcesFromLinks

public <T> List<T> getResourcesFromLinks(Collection<Link> links,
 Class<T> clazz)

Gets OSLC resources in parallel from a set of Links and unwraps their corresponding entities.

Method renamed due to type erasure in Java

getResource

public Response getResource(String url)

Gets an OSLC resource using application/rdf+xml. Use getResource(String, String) to specify the media type or getResource(String, Map) to add other request headers.

Specified by:

getResource in interface IOslcClient

getResource

public Response getResource(String url,
 String mediaType)

Gets an OSLC resource. Use getResource(String, Map) instead to add other request headers.

Specified by:

getResource in interface IOslcClient

Parameters:

url - the resource URL

mediaType - the requested media type to use in the HTTP Accept request header

getResource

public Response getResource(String url,
 Map<String,String> requestHeaders)

Gets an OSLC resource.

Specified by:

getResource in interface IOslcClient

Parameters:

url - the resource URL

requestHeaders - the HTTP request headers to use. If the Accept header is not in the map, it defaults to application/rdf+xml. If OSLC-Core-Version is not in the map, it defaults to 2.0.

getResource

public Response getResource(String url,
 Map<String,String> requestHeaders,
 String defaultMediaType)

Specified by:

getResource in interface IOslcClient

getResource

public Response getResource(String url,
 Map<String,String> requestHeaders,
 String defaultMediaType,
 String configurationContext)

Specified by:

getResource in interface IOslcClient

getResource

public Response getResource(String url,
 Map<String,String> requestHeaders,
 String defaultMediaType,
 boolean handleRedirects)

Specified by:

getResource in interface IOslcClient

getResource

public Response getResource(String url,
 Map<String,String> requestHeaders,
 String defaultMediaType,
 String configurationContext,
 boolean handleRedirects)

Specified by:

getResource in interface IOslcClient

deleteResource

public Response deleteResource(String url)

Delete an OSLC resource and return the Response

Specified by:

deleteResource in interface IOslcClient

Parameters:

url -

deleteResource

public Response deleteResource(String url,
 String configurationContext)

Delete an OSLC resource in the given configuration context and return the Response

Specified by:

deleteResource in interface IOslcClient

createResource

public Response createResource(String url,
 Object artifact,
 String mediaType)

Create (POST) an artifact to a URL - usually an OSLC Creation Factory

Specified by:

createResource in interface IOslcClient

createResource

public Response createResource(String url,
 Object artifact,
 String mediaType,
 String acceptType)

Create (POST) an artifact to a URL - usually an OSLC Creation Factory

Specified by:

createResource in interface IOslcClient

createResource

public Response createResource(String url,
 Object artifact,
 String mediaType,
 String acceptType,
 String configurationContext)

Specified by:

createResource in interface IOslcClient

updateResource

public Response updateResource(String url,
 Object artifact,
 String mediaType)

Update (PUT) an artifact to a URL - usually the URL for an existing OSLC artifact

Specified by:

updateResource in interface IOslcClient

updateResource

public Response updateResource(String url,
 Object artifact,
 String mediaType,
 String acceptType)

Update (PUT) an artifact to a URL - usually the URL for an existing OSLC artifact

Specified by:

updateResource in interface IOslcClient

updateResource

public Response updateResource(String url,
 Object artifact,
 String mediaType,
 String acceptType,
 String ifMatch)

Update (PUT) an artifact to a URL - usually the URL for an existing OSLC artifact

Specified by:

updateResource in interface IOslcClient

updateResource

public Response updateResource(String url,
 Object artifact,
 String mediaType,
 String acceptType,
 String ifMatch,
 String configurationContext)

Specified by:

updateResource in interface IOslcClient

getWebResource

public WebTarget getWebResource(String capabilityUri)

Create a Wink Resource for the given OslcQuery object

lookupServiceProviderUrl

public String lookupServiceProviderUrl(String catalogUrl,
 String serviceProviderTitle)
                                throws IOException,
URISyntaxException,
ResourceNotFoundException

Lookup the URL of a specific OSLC Service Provider in an OSLC Catalog using the service provider's title

Throws:

IOException

URISyntaxException

ResourceNotFoundException

lookupQueryCapability

public String lookupQueryCapability(String serviceProviderUrl,
 String oslcDomain,
 String oslcResourceType)
                             throws IOException,
URISyntaxException,
ResourceNotFoundException

Find the OSLC Query Capability URL for a given OSLC resource type. If no resource type is given, returns the default Query Capability, if it exists.

Parameters:

oslcResourceType - - the resource type of the desired query capability. This may differ from the OSLC artifact type.

Returns:

URL of requested Query Capability or null if not found.

Throws:

IOException

URISyntaxException

ResourceNotFoundException

lookupCreationFactoryResource

public CreationFactory lookupCreationFactoryResource(String serviceProviderUrl,
 String oslcDomain,
 String oslcResourceType)
                                              throws IOException,
URISyntaxException,
ResourceNotFoundException

Throws:

IOException

URISyntaxException

ResourceNotFoundException

lookupCreationFactoryResource

public CreationFactory lookupCreationFactoryResource(String serviceProviderUrl,
 String oslcDomain,
 String oslcResourceType,
 String oslcUsage)
                                              throws IOException,
URISyntaxException,
ResourceNotFoundException

Throws:

IOException

URISyntaxException

ResourceNotFoundException

lookupCreationFactory

public String lookupCreationFactory(String serviceProviderUrl,
 String oslcDomain,
 String oslcResourceType)
                             throws IOException,
URISyntaxException,
ResourceNotFoundException

Find the OSLC Creation Factory URL for a given OSLC resource type. If no resource type is given, returns the default Creation Factory, if it exists.

Parameters:

oslcResourceType - - the resource type of the desired query capability. This may differ from the OSLC artifact type.

Returns:

URL of requested Creation Factory or null if not found.

Throws:

IOException

URISyntaxException

ResourceNotFoundException

lookupCreationFactory

public String lookupCreationFactory(String serviceProviderUrl,
 String oslcDomain,
 String oslcResourceType,
 String oslcUsage)
                             throws IOException,
URISyntaxException,
ResourceNotFoundException

Find the OSLC Creation Factory URL for a given OSLC resource type and OSLC usage. If no resource type is given, returns the default Creation Factory, if it exists.

Parameters:

oslcResourceType - - the resource type of the desired query capability. This may differ from the OSLC artifact type.

Returns:

URL of requested Creation Factory or null if not found.

Throws:

IOException

URISyntaxException

ResourceNotFoundException