Package org.silverpeas.core.webapi.base

Interface WebAuthenticationValidation

All Known Subinterfaces:

ProtectedWebResource, ScimProtectedWebResource, WbeProtectedWebResource

All Known Implementing Classes:

AbstractAdminResource, AbstractAttachmentResource, AbstractCalendarResource, AbstractContributionResource, AbstractLoggingResource, AbstractLookResource, AbstractMessageResource, AbstractNodeResource, AbstractPasswordResource, AbstractPublicationResource, AbstractSimpleDocumentResource, AbstractSubscriptionResource, AbstractWbeFileResource, AttachmentResource, AuthenticationResource, BundleResource, CalendarResource, CipherKeyResource, CmisUserAuthenticator, CommentResource, ComponentResource, ComponentsResource, ContributionContentResource, DisplayResource, DocumentViewResource, EmbedMediaPlayerResource, EmbedMediaViewerResource, FileUploadResource, FilteredPdcResource, ICalendarResource, InboxUserNotificationResource, InvitationResource, LanguageResource, ListNodeResource, LogResource, MessageResource, MyLinksResource, MyPreferencesResource, NodeResource, PasswordResource, PdcClassificationResource, PdcPredefinedClassificationResource, PdcResource, PreviewResource, PublicationResource, RatingResource, RelationResource, ReminderResource, ReplacementResource, RESTWebService, ScimV2BulkResource, ScimV2GroupResource, ScimV2ResourceTypeResource, ScimV2SchemaResource, ScimV2SearchResource, ScimV2SelfResource, ScimV2ServiceProviderConfigResource, ScimV2UserResource, SearchResource, SharedAttachmentResource, SharedNodeResource, SharedPublicationResource, SharingResource, SilverLoggerConfigurationResource, SimpleDocumentListResource, SimpleDocumentResource, SimpleDocumentResourceCreator, SpaceResource, SubscribeResource, SubscriptionResource, ThesaurusResource, ThumbnailResource, TicketResource, UnsubscribeResource, UserCalendarResource, UserGroupProfileResource, UserICalendarResource, UserProfileResource, VariablesResource, VolatileCacheResource, WysiwygEditorConfigResource

public interface WebAuthenticationValidation

Validation of the authentication of a user accessing a web endpoint in Silverpeas. This interface requires to be implemented by all of authentication validators in Silverpeas.

Author:

mmoquillon

Method Summary

Modifier and Type	Method	Description
SilverpeasRequestContext	getSilverpeasContext()	Gets the context of Silverpeas linked to the current request.
default void	validateUserAuthentication(UserPrivilegeValidation validation)	Validates the authentication of the user requesting currently a web endpoint by using the specified user privilege validation service.

Method Detail

getSilverpeasContext

SilverpeasRequestContext getSilverpeasContext()

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

Returns:

SilverpeasRequestContext instance.

validateUserAuthentication

default void validateUserAuthentication(UserPrivilegeValidation validation)

Validates the authentication of the user requesting currently a web endpoint by using the specified user privilege validation service. If no session was opened for the user, then open a new one.

This method should be invoked for web services requiring an authenticated user. Otherwise, the annotation Authenticated can be also used instead at class level.

Parameters:

validation - the validation instance to use.

Throws:

javax.ws.rs.WebApplicationException - if the authentication isn't valid (no authentication and authentication failure).

See Also:

UserPrivilegeValidator