Package org.eclipse.lyo.client

Class RootServicesHelper

java.lang.Object

org.eclipse.lyo.client.RootServicesHelper

public class RootServicesHelper
extends Object

Helper class to assist in retrieval of attributes from the IBM Rational Jazz rootservices document This class is not currently thread safe.

Field Summary

Fields

Modifier and Type	Field	Description
static String	JD_NAMESPACE
static String	JFS_NAMESPACE

Constructor Summary

Constructors

Constructor	Description
RootServicesHelper(String url, String catalogDomain, OslcClient client)	Initialize Jazz rootservices-related URLs such as the catalog location and OAuth URLs rootservices is unprotected and access does not require authentication

Method Summary

Modifier and Type	Method	Description
String	getAccessTokenUrl()
String	getAuthorizationRealm()
String	getAuthorizationTokenUrl()
String	getCatalogUrl()	Get the OSLC Catalog URL
String	getConsumerApprovalUrl()	Gets the URL for approving an OAuth consumer
String	getConsumerApprovalUrl(String consumerKey)
org.apache.jena.rdf.model.Model	getRdfModel()	Returns the underlying RDF model for the rootservices document.
String	getRequestConsumerKeyUrl()	Gets the URL for requesting an OAuth consumer key.
String	getRequestTokenUrl()
String	requestConsumerKey(String consumerName, String consumerSecret)

Methods inherited from class java.lang.Object

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

Field Detail

JFS_NAMESPACE

public static final String JFS_NAMESPACE

See Also:

Constant Field Values

JD_NAMESPACE

public static final String JD_NAMESPACE

See Also:

Constant Field Values

Constructor Detail

RootServicesHelper

public RootServicesHelper(String url,
                          String catalogDomain,
                          OslcClient client)
                   throws RootServicesException

Initialize Jazz rootservices-related URLs such as the catalog location and OAuth URLs rootservices is unprotected and access does not require authentication

Parameters:

url - - base URL of the Jazz server, no including /rootservices. Example: https://example.com:9443/ccm

catalogDomain - - Namespace of the OSLC domain to find the catalog for. Example: OSLCConstants.OSLC_CM

Throws:

RootServicesException

Method Detail

getCatalogUrl

public String getCatalogUrl()

Get the OSLC Catalog URL

Returns:

the catalog URL

getRdfModel

public org.apache.jena.rdf.model.Model getRdfModel()

Returns the underlying RDF model for the rootservices document. This allows clients to read other service URLs not directly supported by this class.

Returns:

the RDF model

getAuthorizationRealm

public String getAuthorizationRealm()

getRequestTokenUrl

public String getRequestTokenUrl()

getAuthorizationTokenUrl

public String getAuthorizationTokenUrl()

getAccessTokenUrl

public String getAccessTokenUrl()

getRequestConsumerKeyUrl

public String getRequestConsumerKeyUrl()

Gets the URL for requesting an OAuth consumer key.

Returns:

the request consumer key URL

See Also:

RootServicesSpecAddendum2

getConsumerApprovalUrl

public String getConsumerApprovalUrl()

Gets the URL for approving an OAuth consumer

Returns:

the approval URL

See Also:

RootServicesSpecAddendum2

getConsumerApprovalUrl

public String getConsumerApprovalUrl(String consumerKey)

requestConsumerKey

public String requestConsumerKey(String consumerName,
                                 String consumerSecret)
                          throws org.apache.http.client.ClientProtocolException,
                                 IOException

Throws:

org.apache.http.client.ClientProtocolException

IOException