org.jasig.portlet.courses.dao.xml

Class HttpClientCoursesDaoImpl

java.lang.Object

org.jasig.portlet.courses.dao.xml.HttpClientCoursesDaoImpl

All Implemented Interfaces:

ICacheableCoursesDao<HttpClientCoursesDaoImpl.CoursesCacheKey,HttpClientCoursesDaoImpl.CoursesCacheKey>

public class HttpClientCoursesDaoImpl
extends Object
implements ICacheableCoursesDao<HttpClientCoursesDaoImpl.CoursesCacheKey,HttpClientCoursesDaoImpl.CoursesCacheKey>

HttpClientCoursesDaoImpl retrieves courses from a Basic Authentication protected XML feed.

Version:

$Revision$

Author:

Jen Bourey, jennifer.bourey@gmail.com

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpClientCoursesDaoImpl.CoursesCacheKey

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROPERTY_KEY_TERMCODE

Constructor Summary

Constructors

Constructor and Description
HttpClientCoursesDaoImpl()

Method Summary

Methods

Modifier and Type	Method and Description
protected Map<String,String>	createParameters(javax.portlet.PortletRequest request, Map<String,IParameterEvaluator> params)
CoursesByTerm	getCoursesByTerm(HttpClientCoursesDaoImpl.CoursesCacheKey key) Get courses for a term for the current user
HttpClientCoursesDaoImpl.CoursesCacheKey	getCoursesByTermKey(javax.portlet.PortletRequest request, String termCode, TermList termList) A cache key for the courses that would be retrieved by this request
protected org.springframework.http.HttpEntity<?>	getRequestEntity(HttpClientCoursesDaoImpl.CoursesCacheKey credentials) Get a request entity prepared for basic authentication.
TermList	getTermList(HttpClientCoursesDaoImpl.CoursesCacheKey key) Get a term list for the current user
HttpClientCoursesDaoImpl.CoursesCacheKey	getTermListKey(javax.portlet.PortletRequest request) A cache key for the term list that would be retrieved by this request
protected TermsAndCourses	getTermsAndCourses(HttpClientCoursesDaoImpl.CoursesCacheKey key, String url)
void	setCoursesUrlFormat(String urlFormat)
void	setPasswordEvaluator(IParameterEvaluator passwordEvaluator)
void	setRestTemplate(org.springframework.web.client.RestOperations restTemplate)
protected void	setTermCodeRequestAttribute(javax.portlet.PortletRequest request, String termCode)
void	setTermsUrlFormat(String urlFormat)
void	setUrlParams(Map<String,IParameterEvaluator> params)
void	setUsernameEvaluator(IParameterEvaluator usernameEvaluator)

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_KEY_TERMCODE

public static final String PROPERTY_KEY_TERMCODE

See Also:

Constant Field Values

Constructor Detail

HttpClientCoursesDaoImpl

public HttpClientCoursesDaoImpl()

Method Detail

setTermsUrlFormat

public void setTermsUrlFormat(String urlFormat)

setCoursesUrlFormat

public void setCoursesUrlFormat(String urlFormat)

setUrlParams

public void setUrlParams(Map<String,IParameterEvaluator> params)

setUsernameEvaluator

public void setUsernameEvaluator(IParameterEvaluator usernameEvaluator)

setPasswordEvaluator

public void setPasswordEvaluator(IParameterEvaluator passwordEvaluator)

setRestTemplate

public void setRestTemplate(org.springframework.web.client.RestOperations restTemplate)

getTermListKey

public HttpClientCoursesDaoImpl.CoursesCacheKey getTermListKey(javax.portlet.PortletRequest request)

Description copied from interface: ICacheableCoursesDao

A cache key for the term list that would be retrieved by this request

Specified by:

getTermListKey in interface ICacheableCoursesDao<HttpClientCoursesDaoImpl.CoursesCacheKey,HttpClientCoursesDaoImpl.CoursesCacheKey>

getTermList

public TermList getTermList(HttpClientCoursesDaoImpl.CoursesCacheKey key)

Description copied from interface: ICacheableCoursesDao

Get a term list for the current user

Specified by:

getTermList in interface ICacheableCoursesDao<HttpClientCoursesDaoImpl.CoursesCacheKey,HttpClientCoursesDaoImpl.CoursesCacheKey>

getCoursesByTermKey

public HttpClientCoursesDaoImpl.CoursesCacheKey getCoursesByTermKey(javax.portlet.PortletRequest request,
                                                           String termCode,
                                                           TermList termList)

Description copied from interface: ICacheableCoursesDao

A cache key for the courses that would be retrieved by this request

Specified by:

getCoursesByTermKey in interface ICacheableCoursesDao<HttpClientCoursesDaoImpl.CoursesCacheKey,HttpClientCoursesDaoImpl.CoursesCacheKey>

getCoursesByTerm

public CoursesByTerm getCoursesByTerm(HttpClientCoursesDaoImpl.CoursesCacheKey key)

Description copied from interface: ICacheableCoursesDao

Get courses for a term for the current user

Specified by:

getCoursesByTerm in interface ICacheableCoursesDao<HttpClientCoursesDaoImpl.CoursesCacheKey,HttpClientCoursesDaoImpl.CoursesCacheKey>

getTermsAndCourses

protected TermsAndCourses getTermsAndCourses(HttpClientCoursesDaoImpl.CoursesCacheKey key,
                                 String url)

getRequestEntity

protected org.springframework.http.HttpEntity<?> getRequestEntity(HttpClientCoursesDaoImpl.CoursesCacheKey credentials)

Get a request entity prepared for basic authentication.

setTermCodeRequestAttribute

protected void setTermCodeRequestAttribute(javax.portlet.PortletRequest request,
                               String termCode)

createParameters

protected Map<String,String> createParameters(javax.portlet.PortletRequest request,
                                  Map<String,IParameterEvaluator> params)