org.forgerock.openam.oauth2.resources

Class ResourceSetRegistrationEndpoint

java.lang.Object

org.restlet.resource.Resource

org.restlet.resource.ServerResource

org.forgerock.openam.oauth2.resources.ResourceSetRegistrationEndpoint

public class ResourceSetRegistrationEndpoint
extends org.restlet.resource.ServerResource

Restlet endpoint for OAuth2 resource servers to register resource set that should be protected.

Since:

13.0.0

Constructor Summary

Constructors

Constructor and Description

ResourceSetRegistrationEndpoint(OAuth2ProviderSettingsFactory providerSettingsFactory, ResourceSetDescriptionValidator validator, OAuth2RequestFactory requestFactory, Set<ResourceSetRegistrationHook> hooks, ResourceSetLabelRegistration labelRegistration, ExtensionFilterManager extensionFilterManager, ExceptionHandler exceptionHandler, UmaLabelsStore umaLabelsStore, JacksonRepresentationFactory jacksonRepresentationFactory) Construct a new ResourceSetRegistrationEndpoint instance.

Method Summary

Modifier and Type	Method and Description
org.restlet.representation.Representation	createResourceSet(org.restlet.ext.json.JsonRepresentation entity) Creates or updates a resource set description.
org.restlet.representation.Representation	deleteResourceSet() Deletes the resource set description for the request resource set id as long as the If-Match header matches the current version of the resource set.
protected void	doCatch(Throwable throwable)
org.restlet.representation.Representation	readOrListResourceSet() Reads the requested resource set description or queries all the client's (resource server's) resource sets.
org.restlet.representation.Representation	updateResourceSet(org.restlet.ext.json.JsonRepresentation entity)

Methods inherited from class org.restlet.resource.ServerResource

abort, commit, delete, delete, describeVariants, doConditionalHandle, doError, doHandle, doHandle, doHandle, doNegotiatedHandle, get, get, getAnnotation, getAnnotation, getAnnotations, getAttribute, getDescription, getInfo, getInfo, getName, getOnSent, getPreferredVariant, getRole, getVariants, getVariants, handle, hasAnnotations, head, head, isAnnotated, isAutoCommitting, isCommitted, isConditional, isExisting, isInRole, isNegotiated, options, options, patch, patch, post, post, put, put, redirectPermanent, redirectPermanent, redirectSeeOther, redirectSeeOther, redirectTemporary, redirectTemporary, setAllowedMethods, setAnnotated, setAttribute, setAutoCommitting, setChallengeRequests, setCommitted, setConditional, setCookieSettings, setDescription, setDimensions, setExisting, setLocationRef, setLocationRef, setName, setNegotiated, setOnSent, setProxyChallengeRequests, setServerInfo, setStatus, setStatus, setStatus, setStatus, updateAllowedMethods, updateDimensions

Methods inherited from class org.restlet.resource.Resource

doError, doInit, doRelease, getAllowedMethods, getApplication, getChallengeRequests, getChallengeResponse, getClientInfo, getConditions, getConnegService, getContext, getConverterService, getCookies, getCookieSettings, getDimensions, getHostRef, getLocationRef, getLogger, getMatrix, getMatrixValue, getMaxForwards, getMetadataService, getMethod, getOriginalRef, getProtocol, getProxyChallengeRequests, getProxyChallengeResponse, getQuery, getQueryValue, getRanges, getReference, getReferrerRef, getRequest, getRequestAttributes, getRequestCacheDirectives, getRequestEntity, getResponse, getResponseAttributes, getResponseCacheDirectives, getResponseEntity, getRootRef, getServerInfo, getStatus, getStatusService, init, isConfidential, isLoggable, release, setApplication, setQueryValue, setRequest, setResponse, toBoolean, toByte, toDouble, toFloat, toInteger, toLong, toObject, toRepresentation, toRepresentation, toRepresentation, toShort, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceSetRegistrationEndpoint

@Inject
public ResourceSetRegistrationEndpoint(OAuth2ProviderSettingsFactory providerSettingsFactory,
                                               ResourceSetDescriptionValidator validator,
                                               OAuth2RequestFactory requestFactory,
                                               Set<ResourceSetRegistrationHook> hooks,
                                               ResourceSetLabelRegistration labelRegistration,
                                               ExtensionFilterManager extensionFilterManager,
                                               ExceptionHandler exceptionHandler,
                                               UmaLabelsStore umaLabelsStore,
                                               JacksonRepresentationFactory jacksonRepresentationFactory)

Construct a new ResourceSetRegistrationEndpoint instance.

Parameters:

providerSettingsFactory - An instance of the OAuth2ProviderSettingsFactory.

validator - An instance of the ResourceSetDescriptionValidator.

requestFactory - An instance of the OAuth2RequestFactory.

hooks - A Set of ResourceSetRegistrationHooks.

labelRegistration - An instance of the ResourceSetLabelRegistration.

extensionFilterManager - An instance of the ExtensionFilterManager.

exceptionHandler - An instance of the ExceptionHandler.

umaLabelsStore - An instance of the Uma Label Store

jacksonRepresentationFactory - The factory for JacksonRepresentation instances.

Method Detail

createResourceSet

@Post
public org.restlet.representation.Representation createResourceSet(org.restlet.ext.json.JsonRepresentation entity)
                                                                  throws NotFoundException,
                                                                         ServerException,
                                                                         BadRequestException

Creates or updates a resource set description.

If the request contains a If-Match header an update is performed, otherwise a create is performed.

An update will replace the current description of the resource set with the contents of the request body.

Parameters:

entity - The new resource set description.

Returns:

A JSON object containing the authorization server's unique id for the resource set and, optionally, a policy uri.

Throws:

NotFoundException - If the requested resource set description does not exist.

ServerException - When an error occurs during creating or updating.

BadRequestException - If the request JSON is invalid.

updateResourceSet

@Put
public org.restlet.representation.Representation updateResourceSet(org.restlet.ext.json.JsonRepresentation entity)
                                                                 throws NotFoundException,
                                                                        ServerException,
                                                                        BadRequestException

Throws:

NotFoundException

ServerException

BadRequestException

readOrListResourceSet

@Get
public org.restlet.representation.Representation readOrListResourceSet()
                                                                     throws NotFoundException,
                                                                            ServerException

Reads the requested resource set description or queries all the client's (resource server's) resource sets.

Returns:

When reading returns a JSON object of the authorization server's unique id and the description of the resource set. When querying returns a JSON array of the resource set ids.

Throws:

NotFoundException - If the requested resource set description does not exist.

ServerException - When the resource set description cannot be loaded.

deleteResourceSet

@Delete
public org.restlet.representation.Representation deleteResourceSet()
                                                                    throws NotFoundException,
                                                                           ServerException

Deletes the resource set description for the request resource set id as long as the If-Match header matches the current version of the resource set.

If no If-Match header is present on the request a 512 Precondition Failed response will be returned.

Returns:

An empty representation.

Throws:

NotFoundException - If the requested resource set description does not exist.

ServerException - When an error occurs during removal.

doCatch

protected void doCatch(Throwable throwable)

Overrides:

doCatch in class org.restlet.resource.ServerResource