|
1 | 1 | /** |
2 | | - * Private URL for unpublished datasets. |
| 2 | + * Preview URL for unpublished datasets. |
3 | 3 | * <p> |
4 | | - * The Private URL feature has been implemented as a specialized role assignment |
| 4 | + * The Preview (formerly Private) URL feature has been implemented as a specialized role assignment |
5 | 5 | * with an associated token that permits read-only access to the metadata and |
6 | 6 | * all files (regardless of if the files are restricted or not) of a draft |
7 | 7 | * version of a dataset. |
8 | 8 | * <p> |
9 | | - * As of this note, a second option - to create a Private URL that provides an |
| 9 | + * As of this note, a second option - to create a Preview URL that provides an |
10 | 10 | * anonymized view of the dataset has been added. This option works the same as |
11 | 11 | * the original except that it hides author names in the citation block, hides |
12 | 12 | * the values for an admin specified list of metadata fields, disables citation |
13 | 13 | * downloads, and disables API access (except for file and file thumbnail |
14 | 14 | * downloads which are used by the UI). |
15 | 15 | * <p> |
16 | | - * The primary use case for a Private URL is for journal editors to send a link |
| 16 | + * The primary use case for a Preview URL is for journal editors to send a link |
17 | 17 | * to reviewers of a dataset before publication. In most cases, these journal |
18 | 18 | * editors do not permit depositors to publish on their own, which is to say |
19 | 19 | * they only allow depositors to have the "Contributor" role on the datasets |
|
24 | 24 | * the depositor, who is in charge of both the security of the dataset and the |
25 | 25 | * timing of when the dataset is published. |
26 | 26 | * <p> |
27 | | - * A secondary use case for a Private URL is for depositors who have the ability |
| 27 | + * A secondary use case for a Preview URL is for depositors who have the ability |
28 | 28 | * to manage permissions on their dataset (depositors who have the "Curator" or |
29 | 29 | * "Admin" role, which grants much more power than the "Contributor" role) to |
30 | 30 | * send a link to coauthors or other trusted parties to preview the dataset |
31 | 31 | * before the depositors publish the dataset on their own. For better security, |
32 | 32 | * these depositors could ask their coauthors to create Dataverse accounts and |
33 | | - * assign roles to them directly, rather than using a Private URL which requires |
| 33 | + * assign roles to them directly, rather than using a Preview URL which requires |
34 | 34 | * no username or password. |
35 | 35 | * <p> |
36 | 36 | * As of this note, a second option aimed specifically at the review use case - |
37 | | - * to create a Private URL that provides an anonymized view of the dataset - has |
| 37 | + * to create a Preview URL that provides an anonymized view of the dataset - has |
38 | 38 | * been added. This option works the same as the original except that it hides |
39 | 39 | * author names in the citation block, hides the values for an admin specified |
40 | 40 | * list of metadata fields, disables citation downloads, and disables API access |
41 | 41 | * (except for file and file thumbnail downloads which are used by the UI). |
42 | 42 | * <p> |
43 | | - * The token associated with the Private URL role assignment that can be used |
| 43 | + * The token associated with the Preview URL role assignment that can be used |
44 | 44 | * either in the GUI or, for the non-anonymized-access option, via the API to |
45 | 45 | * elevate privileges beyond what a "Guest" can see. The ability to use a |
46 | | - * Private URL token via API was added mostly to facilitate automated testing of |
47 | | - * the feature but the far more common case is expected to be use of the Private |
| 46 | + * Preview URL token via API was added mostly to facilitate automated testing of |
| 47 | + * the feature but the far more common case is expected to be use of the Preview |
48 | 48 | * URL token in a link that is clicked to open a browser, similar to links |
49 | 49 | * shared via Dropbox, Google, etc. |
50 | 50 | * <p> |
51 | | - * When reviewers click a Private URL their browser sessions are set to the |
| 51 | + * When reviewers click a Preview URL their browser sessions are set to the |
52 | 52 | * "{@link edu.harvard.iq.dataverse.authorization.users.PrivateUrlUser}" that |
53 | 53 | * has the "Member" role only on the dataset in question and redirected to that |
54 | 54 | * dataset, where they will see an indication in blue at the top of the page |
55 | 55 | * that they are viewing an unpublished dataset. If the reviewer happens to be |
56 | 56 | * logged into Dataverse already, clicking the link will log them out because |
57 | 57 | * the review is meant to be blind. Because the dataset is always in draft when |
58 | | - * a Private URL is in effect, no downloads or any other activity by the |
59 | | - * reviewer are logged to the guestbook. All reviewers click the same Private |
| 58 | + * a Preview URL is in effect, no downloads or any other activity by the |
| 59 | + * reviewer are logged to the guestbook. All reviewers click the same Preview |
60 | 60 | * URL containing the same token, and with the exception of an IP address being |
61 | 61 | * logged, it should be impossible to trace which reviewers have clicked a |
62 | | - * Private URL. If the reviewer navigates to the home page, the session is set |
| 62 | + * Preview URL. If the reviewer navigates to the home page, the session is set |
63 | 63 | * to the Guest user and they will see what a Guest would see. |
64 | 64 | * <p> |
65 | 65 | * The "Member" role is used because it contains the necessary read-only |
|
76 | 76 | * version. A Member can also download restricted files that have been deleted |
77 | 77 | * from previously published versions. |
78 | 78 | * <p> |
79 | | - * Likewise, when a Private URL token is used via API, commands are executed |
| 79 | + * Likewise, when a Preview URL token is used via API, commands are executed |
80 | 80 | * using the "PrivateUrlUser" that has the "Member" role only on the dataset in |
81 | 81 | * question. This means that read-only operations such as downloads of the |
82 | | - * dataset's files are permitted. The Search API does not respect the Private |
| 82 | + * dataset's files are permitted. The Search API does not respect the Preview |
83 | 83 | * URL token but you can download files using the Access API, and, with the |
84 | 84 | * non-anonymized-access option, download unpublished metadata using the Native |
85 | 85 | * API. |
86 | 86 | * <p> |
87 | | - * A Private URL cannot be created for a published version of a dataset. In the |
| 87 | + * A Preview URL cannot be created for a published version of a dataset. In the |
88 | 88 | * GUI, you will be reminded of this fact with a popup. The API will explain |
89 | 89 | * this as well. |
90 | 90 | * <p> |
91 | | - * An anonymized-access Private URL can't be created if any published dataset |
| 91 | + * An anonymized-access Preview URL can't be created if any published dataset |
92 | 92 | * version exists. The primary reason for this is that, since datasets have |
93 | 93 | * DOIs, the full metadata about published versions is available directly from |
94 | 94 | * the DOI provider. (While the metadata for that version could be somewhat |
95 | 95 | * different, in practice it would probably provide a means of identifying |
96 | 96 | * some/all of the authors). |
97 | 97 | * <p> |
98 | | - * If a draft dataset containing a Private URL is |
99 | | - * published, the Private URL is deleted. This means that reviewers who click |
| 98 | + * If a draft dataset containing a Preview URL is |
| 99 | + * published, the Preview URL is deleted. This means that reviewers who click |
100 | 100 | * the link after publication will see a 404. |
101 | 101 | * <p> |
102 | | - * If a post-publication draft containing a Private URL is deleted, the Private |
| 102 | + * If a post-publication draft containing a Preview URL is deleted, the Preview |
103 | 103 | * URL is deleted. This is to ensure that if a new draft is created in the |
104 | 104 | * future, a new token will be used. |
105 | 105 | * <p> |
106 | | - * The creation and deletion of a Private URL are limited to the "Curator" and |
| 106 | + * The creation and deletion of a Preview URL are limited to the "Curator" and |
107 | 107 | * "Admin" roles because only those roles have the permission called |
108 | 108 | * "ManageDatasetPermissions", which is the permission used by the |
109 | 109 | * "AssignRoleCommand" and "RevokeRoleCommand" commands. If you have the |
110 | | - * permission to create or delete a Private URL, the fact that a Private URL is |
| 110 | + * permission to create or delete a Preview URL, the fact that a Preview URL is |
111 | 111 | * enabled for a dataset will be indicated in blue at the top of the page. |
112 | 112 | * Success messages are shown at the top of the page when you create or delete a |
113 | | - * Private URL. In the GUI, deleting a Private URL is called "disabling" and you |
| 113 | + * Preview URL. In the GUI, deleting a Preview URL is called "disabling" and you |
114 | 114 | * will be prompted for a confirmation. No matter what you call it the role is |
115 | | - * revoked. You can also delete a Private URL by revoking the role. |
| 115 | + * revoked. You can also delete a Preview URL by revoking the role. |
116 | 116 | * <p> |
117 | 117 | * A "Contributor" does not have the "ManageDatasetPermissions" permission and |
118 | | - * cannot see "Permissions" nor "Private URL" under the "Edit" menu of their |
119 | | - * dataset. When a Curator or Admin has enabled a Private URL on a Contributor's |
120 | | - * dataset, the Contributor does not see a visual indication that a Private URL |
| 118 | + * cannot see "Permissions" nor "Preview URL" under the "Edit" menu of their |
| 119 | + * dataset. When a Curator or Admin has enabled a Preview URL on a Contributor's |
| 120 | + * dataset, the Contributor does not see a visual indication that a Preview URL |
121 | 121 | * has been enabled for their dataset. |
122 | 122 | * <p> |
123 | | - * There is no way for an "Admin" or "Curator" to see when a Private URL was |
| 123 | + * There is no way for an "Admin" or "Curator" to see when a Preview URL was |
124 | 124 | * created or deleted for a dataset but someone who has access to the database |
125 | 125 | * can see that the following commands are logged to the "actionlogrecord" |
126 | 126 | * database table: |
|
129 | 129 | * <li>{@link edu.harvard.iq.dataverse.engine.command.impl.CreatePrivateUrlCommand}</li> |
130 | 130 | * <li>{@link edu.harvard.iq.dataverse.engine.command.impl.DeletePrivateUrlCommand}</li> |
131 | 131 | * </ul> |
132 | | - * See also the Private URL To Unpublished Dataset BRD at <a href= |
| 132 | + * See also the Preview URL To Unpublished Dataset BRD at <a href= |
133 | 133 | * "https://docs.google.com/document/d/1FT47QkZKcmjSgRnePaJO2g1nzcotLyN3Yb2ORvBr6cs/edit?usp=sharing"> |
134 | 134 | * https://docs.google.com/document/d/1FT47QkZKcmjSgRnePaJO2g1nzcotLyN3Yb2ORvBr6cs/edit?usp=sharing</a> |
135 | 135 | */ |
|
0 commit comments