org.jasig.portlet.notice.service.ssp

Interface ISSPApi

All Known Implementing Classes:

SSPApi

public interface ISSPApi

Author:

Josh Helmer, jhelmer.unicon.net

Method Summary

Modifier and Type	Method and Description
<T> org.springframework.http.ResponseEntity<T>	doRequest(SSPApiRequest<T> request) Make a request to the SSP REST API.
URL	getSSPUrl(String urlFragment, boolean useContext) Get an SSP URL.

Method Detail

doRequest

<T> org.springframework.http.ResponseEntity<T> doRequest(SSPApiRequest<T> request)
                                                  throws MalformedURLException,
                                                         org.springframework.web.client.RestClientException

Make a request to the SSP REST API.

Type Parameters:

T - The type of the response content

Parameters:

request - the SSP Request

Returns:

A response entity that holds the SSP response

Throws:

MalformedURLException - if the URL is invalid

org.springframework.web.client.RestClientException - if an error occurs communicating with SSP

getSSPUrl

URL getSSPUrl(String urlFragment,
              boolean useContext)
       throws MalformedURLException

Get an SSP URL.

Parameters:

urlFragment - The URL fragment.

useContext - if True, prepend the SSP api context, otherwise just use urlFragment as the path

Returns:

A URL object

Throws:

MalformedURLException - if the URL can not be constructed