XWIKI-23915: Introduce a rest endpoint for user information #5199
+1,324
−0
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| /* | ||
| * See the NOTICE file distributed with this work for additional | ||
| * information regarding copyright ownership. | ||
| * | ||
| * This is free software; you can redistribute it and/or modify it | ||
| * under the terms of the GNU Lesser General Public License as | ||
| * published by the Free Software Foundation; either version 2.1 of | ||
| * the License, or (at your option) any later version. | ||
| * | ||
| * This software is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | ||
| * Lesser General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU Lesser General Public | ||
| * License along with this software; if not, write to the Free | ||
| * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA | ||
| * 02110-1301 USA, or see the FSF site: http://www.fsf.org. | ||
| */ | ||
| package org.xwiki.rest.resources.user; | ||
|
|
||
| import javax.ws.rs.GET; | ||
| import javax.ws.rs.Path; | ||
| import javax.ws.rs.PathParam; | ||
| import javax.ws.rs.QueryParam; | ||
|
|
||
| import org.xwiki.rest.XWikiRestException; | ||
| import org.xwiki.rest.model.jaxb.User; | ||
|
|
||
| /** | ||
| * @since 18.2.0RC1 | ||
| * @version $Id$ | ||
| */ | ||
| @Path("/wikis/{wikiName}/user") | ||
| public interface CurrentUserResource | ||
| { | ||
| @GET User getUser( | ||
| @PathParam("wikiName") String wikiName, | ||
| @QueryParam("preferences") boolean preferences | ||
| ) throws XWikiRestException; | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| /* | ||
| * See the NOTICE file distributed with this work for additional | ||
| * information regarding copyright ownership. | ||
| * | ||
| * This is free software; you can redistribute it and/or modify it | ||
| * under the terms of the GNU Lesser General Public License as | ||
| * published by the Free Software Foundation; either version 2.1 of | ||
| * the License, or (at your option) any later version. | ||
| * | ||
| * This software is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | ||
| * Lesser General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU Lesser General Public | ||
| * License along with this software; if not, write to the Free | ||
| * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA | ||
| * 02110-1301 USA, or see the FSF site: http://www.fsf.org. | ||
| */ | ||
| package org.xwiki.rest.resources.user; | ||
|
|
||
| import javax.ws.rs.GET; | ||
| import javax.ws.rs.Path; | ||
| import javax.ws.rs.PathParam; | ||
| import javax.ws.rs.QueryParam; | ||
|
|
||
| import org.xwiki.rest.XWikiRestException; | ||
| import org.xwiki.rest.model.jaxb.User; | ||
|
|
||
| /** | ||
| * @since 18.2.0RC1 | ||
| * @version $Id$ | ||
| */ | ||
| @Path("/wikis/{wikiName}/users/{userId}") | ||
| public interface UserResource | ||
| { | ||
| @GET User getUser( | ||
| @PathParam("wikiName") String wikiName, | ||
| @PathParam("userId") String userId, | ||
| @QueryParam("preferences") boolean preferences | ||
| ) throws XWikiRestException; | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| /* | ||
| * See the NOTICE file distributed with this work for additional | ||
| * information regarding copyright ownership. | ||
| * | ||
| * This is free software; you can redistribute it and/or modify it | ||
| * under the terms of the GNU Lesser General Public License as | ||
| * published by the Free Software Foundation; either version 2.1 of | ||
| * the License, or (at your option) any later version. | ||
| * | ||
| * This software is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | ||
| * Lesser General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU Lesser General Public | ||
| * License along with this software; if not, write to the Free | ||
| * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA | ||
| * 02110-1301 USA, or see the FSF site: http://www.fsf.org. | ||
| */ | ||
| package org.xwiki.rest.resources.user; | ||
|
|
||
| import javax.ws.rs.DefaultValue; | ||
| import javax.ws.rs.GET; | ||
| import javax.ws.rs.Path; | ||
| import javax.ws.rs.PathParam; | ||
| import javax.ws.rs.QueryParam; | ||
|
|
||
| import org.xwiki.rest.XWikiRestException; | ||
| import org.xwiki.rest.model.jaxb.Users; | ||
|
|
||
| /** | ||
| * @since 18.2.0RC1 | ||
| * @version $Id$ | ||
| */ | ||
| @Path("/wikis/{wikiName}/users") | ||
| public interface UsersResource | ||
| { | ||
| @GET Users getUsers( | ||
| @PathParam("wikiName") String wikiName, | ||
| @QueryParam("start") @DefaultValue("0") Integer start, | ||
| @QueryParam("number") Integer number | ||
| ) throws XWikiRestException; | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| /* | ||
| * See the NOTICE file distributed with this work for additional | ||
| * information regarding copyright ownership. | ||
| * | ||
| * This is free software; you can redistribute it and/or modify it | ||
| * under the terms of the GNU Lesser General Public License as | ||
| * published by the Free Software Foundation; either version 2.1 of | ||
| * the License, or (at your option) any later version. | ||
| * | ||
| * This software is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | ||
| * Lesser General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU Lesser General Public | ||
| * License along with this software; if not, write to the Free | ||
| * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA | ||
| * 02110-1301 USA, or see the FSF site: http://www.fsf.org. | ||
| */ | ||
| package org.xwiki.rest; | ||
|
|
||
| import java.net.URI; | ||
|
|
||
| import org.xwiki.component.annotation.Role; | ||
| import org.xwiki.rest.model.jaxb.User; | ||
| import org.xwiki.rest.model.jaxb.UserSummary; | ||
| import org.xwiki.user.UserReference; | ||
|
|
||
| import com.xpn.xwiki.XWikiException; | ||
|
|
||
| /** | ||
| * A component that converts a User Reference to REST API model elements. | ||
| * | ||
| * @since 18.2.0RC1 | ||
| * @version $Id$ | ||
| */ | ||
| @Role | ||
| public interface UserReferenceModelSerializer | ||
| { | ||
| /** | ||
| * Return a summary of the user's information to include in, e.g., user lists. | ||
| * | ||
| * @param baseUri the base URL of the current instance | ||
| * @param userId the id of the user (e.g., "wikiName:Space.Page" for a user stored as a document) | ||
| * @param userReference the user reference to serialize | ||
| * @return a user summary | ||
| * @throws XWikiException if there was a problem during serialization | ||
| */ | ||
| UserSummary toRestUserSummary(URI baseUri, String userId, UserReference userReference) throws XWikiException; | ||
|
|
||
| /** | ||
| * Return all the information available on the user. | ||
| * | ||
| * @param baseUri the base URL of the current instance | ||
| * @param userId the id of the user (e.g., "wikiName:Space.Page" for a user stored as a document) | ||
| * @param userReference the user reference to serialize | ||
| * @param preferences whether to include user preferences in the output | ||
| * @return a user | ||
| * @throws XWikiException if there was a problem during serialization | ||
| */ | ||
| User toRestUser(URI baseUri, String userId, UserReference userReference, boolean preferences) throws XWikiException; | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
| /* | ||
| * See the NOTICE file distributed with this work for additional | ||
| * information regarding copyright ownership. | ||
| * | ||
| * This is free software; you can redistribute it and/or modify it | ||
| * under the terms of the GNU Lesser General Public License as | ||
| * published by the Free Software Foundation; either version 2.1 of | ||
| * the License, or (at your option) any later version. | ||
| * | ||
| * This software is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | ||
| * Lesser General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU Lesser General Public | ||
| * License along with this software; if not, write to the Free | ||
| * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA | ||
| * 02110-1301 USA, or see the FSF site: http://www.fsf.org. | ||
| */ | ||
| package org.xwiki.rest.internal.resources.user; | ||
|
|
||
| import java.net.URI; | ||
|
|
||
| import javax.ws.rs.ServerErrorException; | ||
| import javax.ws.rs.WebApplicationException; | ||
| import javax.ws.rs.core.Response; | ||
|
|
||
| import org.xwiki.component.annotation.Component; | ||
| import org.xwiki.localization.ContextualLocalizationManager; | ||
| import org.xwiki.model.reference.DocumentReference; | ||
| import org.xwiki.rest.UserReferenceModelSerializer; | ||
| import org.xwiki.rest.XWikiResource; | ||
| import org.xwiki.rest.XWikiRestException; | ||
| import org.xwiki.rest.model.jaxb.User; | ||
| import org.xwiki.rest.resources.user.CurrentUserResource; | ||
| import org.xwiki.user.UserReference; | ||
| import org.xwiki.user.UserReferenceResolver; | ||
| import org.xwiki.user.UserReferenceSerializer; | ||
|
|
||
| import com.xpn.xwiki.XWikiException; | ||
|
|
||
| import jakarta.inject.Inject; | ||
| import jakarta.inject.Named; | ||
| import jakarta.inject.Provider; | ||
|
|
||
| /** | ||
| * @since 18.2.0RC1 | ||
| * @version $Id$ | ||
| */ | ||
| @Component | ||
| @Named("org.xwiki.rest.internal.resources.user.CurrentUserResourceImpl") | ||
| public class CurrentUserResourceImpl extends XWikiResource implements CurrentUserResource | ||
| { | ||
| @Inject | ||
| @Named("document") | ||
| private UserReferenceResolver<DocumentReference> userReferenceResolver; | ||
|
|
||
| @Inject | ||
| private UserReferenceSerializer<String> stringUserReferenceSerializer; | ||
|
|
||
| @Inject | ||
| private Provider<UserReferenceModelSerializer> userReferenceModelSerializerProvider; | ||
|
|
||
| @Inject | ||
| private ContextualLocalizationManager contextualLocalizationManager; | ||
|
|
||
| @Override | ||
| public User getUser(String wikiName, boolean preferences) throws XWikiRestException | ||
| { | ||
| URI baseUri = this.uriInfo.getBaseUri(); | ||
|
|
||
| // Fail if we don't have a serializer for the current user store. | ||
| UserReferenceModelSerializer userReferenceModelSerializer = this.userReferenceModelSerializerProvider.get(); | ||
| if (userReferenceModelSerializer == null) { | ||
| throw new ServerErrorException(Response.status(Response.Status.NOT_IMPLEMENTED).entity( | ||
| this.contextualLocalizationManager.getTranslationPlain( | ||
| "rest.exception.userResource.unsupportedStore")).build()); | ||
| } | ||
|
|
||
| DocumentReference userDocumentReference = this.xcontextProvider.get().getUserReference(); | ||
| if (userDocumentReference == null) { | ||
| throw new WebApplicationException(Response.Status.UNAUTHORIZED); | ||
| } | ||
|
|
||
| try { | ||
| UserReference userReference = this.userReferenceResolver.resolve(userDocumentReference); | ||
|
|
||
| return userReferenceModelSerializer.toRestUser(baseUri, | ||
| this.stringUserReferenceSerializer.serialize(userReference), userReference, preferences); | ||
| } catch (XWikiException e) { | ||
| throw new XWikiRestException(e); | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.