Package org.silverpeas.core.webapi.admin.scim

Interface ScimProtectedWebResource

All Superinterfaces:

ProtectedWebResource, SilverpeasWebResource, WebAuthenticationValidation, WebAuthorizationValidation

All Known Implementing Classes:

ScimV2BulkResource, ScimV2GroupResource, ScimV2ResourceTypeResource, ScimV2SchemaResource, ScimV2SearchResource, ScimV2SelfResource, ScimV2ServiceProviderConfigResource, ScimV2UserResource

public interface ScimProtectedWebResource
extends ProtectedWebResource

All WEB services handling the SCIM client requests in front must implement this interface.

The authorization mechanism is not the same as the one implemented into ProtectedWebResource.

Author:

silveryocha

Field Summary

Fields inherited from interface org.silverpeas.core.web.SilverpeasWebResource

BASE_PATH

Method Summary

Modifier and Type	Method	Description
default AdminController	getAdminController()
default String	getComponentId()	Gets the identifier of the component instance to which the requested resource belongs to.
default javax.servlet.http.HttpServletRequest	getHttpRequest()	Gets the current HTTP request received by this Web resource.
org.silverpeas.core.webapi.admin.scim.ScimRequestContext	getSilverpeasContext()	Gets the context of Silverpeas linked to the current request.
default WebResourceUri	getUri()	Gets the URI targeted by the current HTTP request in the form of a WebResourceUri.
default void	validateUserAuthorization(UserPrivilegeValidation validation)	Validates the authorization of the user to request this web service.

Methods inherited from interface org.silverpeas.core.web.rs.WebAuthenticationValidation

validateUserAuthentication

Method Detail

getSilverpeasContext

org.silverpeas.core.webapi.admin.scim.ScimRequestContext getSilverpeasContext()

Description copied from interface: WebAuthenticationValidation

Gets the context of Silverpeas linked to the current request. This context must be initialized before the functional request processing.

Specified by:

getSilverpeasContext in interface WebAuthenticationValidation

Specified by:

getSilverpeasContext in interface WebAuthorizationValidation

Returns:

SilverpeasRequestContext instance.

validateUserAuthorization

default void validateUserAuthorization(UserPrivilegeValidation validation)

Description copied from interface: ProtectedWebResource

Validates the authorization of the user to request this web service. For doing, the user must have the rights to access the component instance that manages this web resource. If no such component instance exists, a Not Found HTTP error is thrown (status code 404). Otherwise the validation is delegated to the validation service by passing it the required information.

This method should be invoked for web service requiring an authorized access. For doing, the authentication of the user must be first valdiated. Otherwise, the annotation Authorized can be also used instead at class level for both authentication and authorization.

Specified by:

validateUserAuthorization in interface ProtectedWebResource

Specified by:

validateUserAuthorization in interface WebAuthorizationValidation

Parameters:

validation - the validation instance to use.

See Also:

UserPrivilegeValidator

getAdminController

default AdminController getAdminController()

getHttpRequest

default javax.servlet.http.HttpServletRequest getHttpRequest()

Description copied from interface: SilverpeasWebResource

Gets the current HTTP request received by this Web resource.

Specified by:

getHttpRequest in interface SilverpeasWebResource

Returns:

the current HTTP request.

getUri

default WebResourceUri getUri()

Description copied from interface: SilverpeasWebResource

Gets the URI targeted by the current HTTP request in the form of a WebResourceUri.

Specified by:

getUri in interface SilverpeasWebResource

Returns:

the WebResourceUri initialized with the URI request.

getComponentId

default String getComponentId()

Description copied from interface: SilverpeasWebResource

Gets the identifier of the component instance to which the requested resource belongs to.

Specified by:

getComponentId in interface SilverpeasWebResource

Returns:

the identifier of the Silverpeas component instance.