org.jasig.portlet.notice.service.ssp

Class SSPApi

java.lang.Object

org.jasig.portlet.notice.service.ssp.SSPApi

All Implemented Interfaces:

ISSPApi

public class SSPApi
extends java.lang.Object
implements ISSPApi

Helper service to simplify interacting with the SSP REST Api. Class is will take care of authentication and holds information about the SSP host and context.

Constructor Summary

Constructors

Constructor and Description
SSPApi()

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.
java.net.URL	getSSPUrl(java.lang.String urlFragment, boolean useContext) Get an SSP URL.
void	setAuthenticationUrl(java.lang.String authenticationUrl)
void	setClientId(java.lang.String clientId)
void	setClientSecret(java.lang.String clientSecret)
void	setRestTemplate(org.springframework.web.client.RestTemplate restTemplate)
void	setSspContext(java.lang.String sspContext) Set the SSP API Context.
void	setSspHost(java.lang.String sspHost)
void	setSspPort(int sspPort)
void	setSspProtocol(java.lang.String sspProtocol)

Methods inherited from class java.lang.Object

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

Constructor Detail

SSPApi

public SSPApi()

Method Detail

setRestTemplate

@Autowired
public void setRestTemplate(org.springframework.web.client.RestTemplate restTemplate)

setClientId

@Value(value="${studentSuccessPlanService.clientId:}")
public void setClientId(java.lang.String clientId)

setClientSecret

@Value(value="${studentSuccessPlanService.clientSecret:}")
public void setClientSecret(java.lang.String clientSecret)

setAuthenticationUrl

@Value(value="${studentSuccessPlanService.authenticationUrl:/api/1/oauth2/token}")
public void setAuthenticationUrl(java.lang.String authenticationUrl)

setSspProtocol

@Value(value="${studentSuccessPlanService.sspProtocol:https}")
public void setSspProtocol(java.lang.String sspProtocol)

setSspHost

@Value(value="${studentSuccessPlanService.sspHost:}")
public void setSspHost(java.lang.String sspHost)

setSspPort

@Value(value="${studentSuccessPlanService.sspPort:443}")
public void setSspPort(int sspPort)

setSspContext

@Value(value="${studentSuccessPlanService.sspContext:/ssp}")
public void setSspContext(java.lang.String sspContext)

Set the SSP API Context. Note: this method will ensure that that the API context starts with '/' and ensures that it does not end with a '/'.

Parameters:

sspContext - the API context

doRequest

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

Make a request to the SSP REST API.

Specified by:

doRequest in interface ISSPApi

Type Parameters:

T - The type of the response content

Parameters:

request - the SSP Request

Returns:

A response entity that holds the SSP response

Throws:

java.net.MalformedURLException - if the URL is invalid

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

getSSPUrl

public java.net.URL getSSPUrl(java.lang.String urlFragment,
                              boolean useContext)
                       throws java.net.MalformedURLException

Get an SSP URL.

Specified by:

getSSPUrl in interface ISSPApi

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:

java.net.MalformedURLException - if the URL can not be constructed