Package edu.ucsb.cs156.frontiers.services

Class ApiCourseKeyService

java.lang.Object

edu.ucsb.cs156.frontiers.services.ApiCourseKeyService

@Service
public class ApiCourseKeyService
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ApiCourseKeyService.ExpirationChoice
static final record	ApiCourseKeyService.GeneratedApiCourseKey

Field Summary

Fields

Modifier and Type	Field	Description
static final String	API_KEY_HEADER

Constructor Summary

Constructors

Constructor	Description
ApiCourseKeyService(ApiCourseKeyRepository apiCourseKeyRepository, CourseRepository courseRepository)

Method Summary

Modifier and Type	Method	Description
boolean	authenticateFromRequestForCourse(Long courseId)
Optional<ApiCourseKey>	authenticateRawKeyForCourse(String rawKey, Long courseId)
ApiCourseKeyService.GeneratedApiCourseKey	createKey(Long courseId, User creator, ApiCourseKeyService.ExpirationChoice expirationChoice)
List<ApiCourseKey>	listActiveKeys(Long courseId)
ApiCourseKey	revokeKey(Long courseId, Long apiKeyId)

Methods inherited from class java.lang.Object

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

Field Details

API_KEY_HEADER

public static final String API_KEY_HEADER

See Also:

• Constant Field Values

Constructor Details

ApiCourseKeyService

public ApiCourseKeyService(ApiCourseKeyRepository apiCourseKeyRepository,
 CourseRepository courseRepository)

Method Details

createKey

public ApiCourseKeyService.GeneratedApiCourseKey createKey(Long courseId,
 User creator,
 ApiCourseKeyService.ExpirationChoice expirationChoice)

listActiveKeys

public List<ApiCourseKey> listActiveKeys(Long courseId)

revokeKey

public ApiCourseKey revokeKey(Long courseId,
 Long apiKeyId)

authenticateFromRequestForCourse

public boolean authenticateFromRequestForCourse(Long courseId)

authenticateRawKeyForCourse

public Optional<ApiCourseKey> authenticateRawKeyForCourse(String rawKey,
 Long courseId)