org.eclipse.lyo.client

Interface IOslcClient

All Known Implementing Classes:

OslcClient, OslcOAuthClient

public interface 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.

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createResource(String url, Object artifact, String mediaType) Create (POST) an artifact to a URL - usually an OSLC Creation Factory
javax.ws.rs.core.Response	createResource(String url, Object artifact, String mediaType, String acceptType) Create (POST) an artifact to a URL - usually an OSLC Creation Factory
javax.ws.rs.core.Response	createResource(String url, Object artifact, String mediaType, String acceptType, String configurationContext)
javax.ws.rs.core.Response	deleteResource(String url) Delete an OSLC resource and return a Wink ClientResponse
javax.ws.rs.core.Response	deleteResource(String url, String configurationContext)
javax.ws.rs.client.Client	getClient() Returns the JAX-RS client for this OslcClient.
javax.ws.rs.core.Response	getResource(String url) Gets an OSLC resource using application/rdf+xml.
javax.ws.rs.core.Response	getResource(String url, Map<String,String> requestHeaders) Gets an OSLC resource.
javax.ws.rs.core.Response	getResource(String url, Map<String,String> requestHeaders, String mediaType)
javax.ws.rs.core.Response	getResource(String url, Map<String,String> requestHeaders, String mediaType, boolean handleRedirects)
javax.ws.rs.core.Response	getResource(String url, Map<String,String> requestHeaders, String mediaType, String configurationContext)
javax.ws.rs.core.Response	getResource(String url, Map<String,String> requestHeaders, String mediaType, String configurationContext, boolean handleRedirects)
javax.ws.rs.core.Response	getResource(String url, String mediaType) Gets an OSLC resource.
javax.ws.rs.core.Response	updateResource(String url, Object artifact, String mediaType) Update (PUT) an artifact to a URL - usually the URL for an existing OSLC artifact
javax.ws.rs.core.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
javax.ws.rs.core.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
javax.ws.rs.core.Response	updateResource(String url, Object artifact, String mediaType, String acceptType, String ifMatch, String configurationContext)

Method Detail

getClient

javax.ws.rs.client.Client getClient()

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

Returns:

the JAX-RS client

getResource

javax.ws.rs.core.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.

getResource

javax.ws.rs.core.Response getResource(String url,
                                      String mediaType)

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

Parameters:

url - the resource URL

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

getResource

javax.ws.rs.core.Response getResource(String url,
                                      Map<String,String> requestHeaders)

Gets an OSLC resource.

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

javax.ws.rs.core.Response getResource(String url,
                                      Map<String,String> requestHeaders,
                                      String mediaType)

getResource

javax.ws.rs.core.Response getResource(String url,
                                      Map<String,String> requestHeaders,
                                      String mediaType,
                                      String configurationContext)

getResource

javax.ws.rs.core.Response getResource(String url,
                                      Map<String,String> requestHeaders,
                                      String mediaType,
                                      boolean handleRedirects)

getResource

javax.ws.rs.core.Response getResource(String url,
                                      Map<String,String> requestHeaders,
                                      String mediaType,
                                      String configurationContext,
                                      boolean handleRedirects)

deleteResource

javax.ws.rs.core.Response deleteResource(String url)

Delete an OSLC resource and return a Wink ClientResponse

Parameters:

url -

deleteResource

javax.ws.rs.core.Response deleteResource(String url,
                                         String configurationContext)

createResource

javax.ws.rs.core.Response createResource(String url,
                                         Object artifact,
                                         String mediaType)

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

createResource

javax.ws.rs.core.Response createResource(String url,
                                         Object artifact,
                                         String mediaType,
                                         String acceptType)

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

createResource

javax.ws.rs.core.Response createResource(String url,
                                         Object artifact,
                                         String mediaType,
                                         String acceptType,
                                         String configurationContext)

updateResource

javax.ws.rs.core.Response updateResource(String url,
                                         Object artifact,
                                         String mediaType)

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

updateResource

javax.ws.rs.core.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

updateResource

javax.ws.rs.core.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

updateResource

javax.ws.rs.core.Response updateResource(String url,
                                         Object artifact,
                                         String mediaType,
                                         String acceptType,
                                         String ifMatch,
                                         String configurationContext)