Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revert "O3-3002: Queue Module - REST endpoints can be accessed without authentication." #70

Merged
merged 1 commit into from
Apr 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,12 @@
import org.openmrs.Location;
import org.openmrs.Visit;
import org.openmrs.VisitAttributeType;
import org.openmrs.annotation.Authorized;
import org.openmrs.api.APIException;
import org.openmrs.module.queue.api.search.QueueEntrySearchCriteria;
import org.openmrs.module.queue.api.sort.SortWeightGenerator;
import org.openmrs.module.queue.model.Queue;
import org.openmrs.module.queue.model.QueueEntry;
import org.openmrs.module.queue.model.QueueEntryTransition;
import org.openmrs.module.queue.utils.PrivilegeConstants;

public interface QueueEntryService {

Expand All @@ -34,7 +32,6 @@ public interface QueueEntryService {
* @param uuid uuid of the queue entry to be returned.
* @return {@link org.openmrs.module.queue.model.QueueEntry}
*/
@Authorized({ PrivilegeConstants.GET_QUEUE_ENTRIES })
Optional<QueueEntry> getQueueEntryByUuid(@NotNull String uuid);

/**
Expand All @@ -43,7 +40,6 @@ public interface QueueEntryService {
* @param id queueEntryId - the id of the queue entry to retrieve.
* @return {@link org.openmrs.module.queue.model.QueueEntry}
*/
@Authorized({ PrivilegeConstants.GET_QUEUE_ENTRIES })
Optional<QueueEntry> getQueueEntryById(@NotNull Integer id);

/**
Expand All @@ -52,7 +48,6 @@ public interface QueueEntryService {
* @param queueEntry the queue entry to be saved
* @return saved {@link org.openmrs.module.queue.model.QueueEntry}
*/
@Authorized({ PrivilegeConstants.MANAGE_QUEUE_ENTRIES })
QueueEntry saveQueueEntry(@NotNull QueueEntry queueEntry);

/**
Expand All @@ -62,7 +57,6 @@ public interface QueueEntryService {
* @param queueEntryTransition the queueEntryTransition
* @return the new QueueEntry that is created
*/
@Authorized({ PrivilegeConstants.MANAGE_QUEUE_ENTRIES })
QueueEntry transitionQueueEntry(@NotNull QueueEntryTransition queueEntryTransition);

/**
Expand All @@ -75,7 +69,6 @@ public interface QueueEntryService {
* @throws IllegalArgumentException if the previous queue entry does not exist
* @throws IllegalStateException if multiple previous entries are identified
*/
@Authorized({ PrivilegeConstants.MANAGE_QUEUE_ENTRIES })
QueueEntry undoTransition(@NotNull QueueEntry queueEntry);

/**
Expand All @@ -84,7 +77,6 @@ public interface QueueEntryService {
* @param queueEntry the queue entry to be voided
* @param voidReason the reason for voiding the queue entry
*/
@Authorized({ PrivilegeConstants.MANAGE_QUEUE_ENTRIES })
void voidQueueEntry(@NotNull QueueEntry queueEntry, String voidReason);

/**
Expand All @@ -93,42 +85,36 @@ public interface QueueEntryService {
* @param queueEntry queue entry to be deleted
* @throws org.openmrs.api.APIException
*/
@Authorized({ PrivilegeConstants.PURGE_QUEUE_ENTRIES })
void purgeQueueEntry(@NotNull QueueEntry queueEntry) throws APIException;

/**
* @return {@link List} of queue entries that match the given %{@link QueueEntrySearchCriteria}
*/
@Authorized({ PrivilegeConstants.GET_QUEUE_ENTRIES })
List<QueueEntry> getQueueEntries(@NotNull QueueEntrySearchCriteria searchCriteria);

/**
* @return {@link Long} count of queue entries that match the given
* %{@link QueueEntrySearchCriteria}
*/
@Authorized({ PrivilegeConstants.GET_QUEUE_ENTRIES })
Long getCountOfQueueEntries(@NotNull QueueEntrySearchCriteria searchCriteria);

/**
* @param location
* @param queue
* @return VisitQueueNumber - used to identify patients in the queue instead of using patient name
*/
@Authorized({ org.openmrs.util.PrivilegeConstants.ADD_VISITS, org.openmrs.util.PrivilegeConstants.EDIT_VISITS })
String generateVisitQueueNumber(@NotNull Location location, @NotNull Queue queue, @NotNull Visit visit,
@NotNull VisitAttributeType visitAttributeType);

/**
* Closes all active queue entries
*/
@Authorized({ PrivilegeConstants.MANAGE_QUEUE_ENTRIES })
void closeActiveQueueEntries();

/**
* @return the instance of SortWeightGenerator that is configured via global property, or null if
* none configured
*/
@Authorized({ PrivilegeConstants.GET_SORT_WEIGHT_GENERATOR })
SortWeightGenerator getSortWeightGenerator();

/**
Expand All @@ -138,7 +124,6 @@ String generateVisitQueueNumber(@NotNull Location location, @NotNull Queue queue
*
* @param sortWeightGenerator the SortWeightGenerator to set
*/
@Authorized({ PrivilegeConstants.MANAGE_SORT_WEIGHT_GENERATOR })
void setSortWeightGenerator(SortWeightGenerator sortWeightGenerator);

/**
Expand All @@ -150,6 +135,5 @@ String generateVisitQueueNumber(@NotNull Location location, @NotNull Queue queue
* @return the previous queue entry, null otherwise.
* @throws IllegalStateException if multiple previous queue entries are identified
*/
@Authorized({ PrivilegeConstants.GET_QUEUE_ENTRIES })
QueueEntry getPreviousQueueEntry(@NotNull QueueEntry queueEntry);
}
Original file line number Diff line number Diff line change
Expand Up @@ -14,73 +14,23 @@
import java.util.List;
import java.util.Optional;

import org.openmrs.annotation.Authorized;
import org.openmrs.api.APIException;
import org.openmrs.module.queue.api.search.QueueRoomSearchCriteria;
import org.openmrs.module.queue.model.QueueRoom;
import org.openmrs.module.queue.utils.PrivilegeConstants;

public interface QueueRoomService {

/**
* Gets a queue room given a uuid.
*
* @param uuid uuid of the queue room to be returned.
* @return {@link org.openmrs.module.queue.model.QueueRoom}
*/
@Authorized({ PrivilegeConstants.GET_QUEUE_ROOMS })
Optional<QueueRoom> getQueueRoomByUuid(@NotNull String uuid);

/**
* Gets a queue room by id.
*
* @param id the id of the queue room to retrieve.
* @return {@link org.openmrs.module.queue.model.QueueRoom}
*/
@Authorized({ PrivilegeConstants.GET_QUEUE_ROOMS })
Optional<QueueRoom> getQueueRoomById(@NotNull int id);

/**
* Gets a List of all Queue Rooms.
*
* @return {@link List} of all queue rooms
*/
@Authorized({ PrivilegeConstants.GET_QUEUE_ROOMS })
List<QueueRoom> getAllQueueRooms();

/**
* Saves a queue room
*
* @param queueRoom the queue room to be saved
* @return saved {@link org.openmrs.module.queue.model.QueueRoom}
*/
@Authorized({ PrivilegeConstants.MANAGE_QUEUE_ROOMS })
QueueRoom saveQueueRoom(@NotNull QueueRoom queueRoom);

/**
* Gets a List of all Queue Rooms that match the given QueueRoomSearchCriteria.
*
* @return {@link List} of queue rooms that match the given
* {@link org.openmrs.module.queue.api.search.QueueRoomSearchCriteria}
*/
@Authorized({ PrivilegeConstants.GET_QUEUE_ROOMS })
List<QueueRoom> getQueueRooms(QueueRoomSearchCriteria searchCriteria);

/**
* Retires a queue room.
*
* @param queueRoom the queue room to retire
* @param retireReason the reason for retiring the queue room
*/
@Authorized({ PrivilegeConstants.MANAGE_QUEUE_ROOMS })
void retireQueueRoom(@NotNull QueueRoom queueRoom, String retireReason);
void retireQueueRoom(@NotNull QueueRoom queueRoom, String voidReason);

/**
* Completely remove a queue room from the database
*
* @param queueRoom queue room to be deleted
* @throws org.openmrs.api.APIException
*/
@Authorized({ PrivilegeConstants.PURGE_QUEUE_ROOMS })
void purgeQueueRoom(@NotNull QueueRoom queueRoom) throws APIException;
}
10 changes: 0 additions & 10 deletions api/src/main/java/org/openmrs/module/queue/api/QueueService.java
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,9 @@
import java.util.List;
import java.util.Optional;

import org.openmrs.annotation.Authorized;
import org.openmrs.api.APIException;
import org.openmrs.module.queue.api.search.QueueSearchCriteria;
import org.openmrs.module.queue.model.Queue;
import org.openmrs.module.queue.utils.PrivilegeConstants;

/**
* This interface defines methods for Queue objects
Expand All @@ -31,7 +29,6 @@ public interface QueueService {
* @param uuid uuid of the queue to be returned.
* @return {@link org.openmrs.module.queue.model.Queue}
*/
@Authorized({ PrivilegeConstants.GET_QUEUES })
Optional<Queue> getQueueByUuid(@NotNull String uuid);

/**
Expand All @@ -40,7 +37,6 @@ public interface QueueService {
* @param id queueId - the id of the queue to retrieve.
* @return {@link org.openmrs.module.queue.model.Queue}
*/
@Authorized({ PrivilegeConstants.GET_QUEUES })
Optional<Queue> getQueueById(@NotNull Integer id);

/**
Expand All @@ -49,7 +45,6 @@ public interface QueueService {
* @param queue the queue to be saved
* @return saved {@link org.openmrs.module.queue.model.Queue}
*/
@Authorized({ PrivilegeConstants.MANAGE_QUEUES })
Queue createQueue(@NotNull Queue queue);

/**
Expand All @@ -58,19 +53,16 @@ public interface QueueService {
* @param queue the queue to be saved
* @return saved {@link org.openmrs.module.queue.model.Queue}
*/
@Authorized({ PrivilegeConstants.MANAGE_QUEUES })
Queue saveQueue(@NotNull Queue queue);

/**
* @return all queues
*/
@Authorized({ PrivilegeConstants.GET_QUEUES })
List<Queue> getAllQueues();

/**
* @return {@link List} of queues that match the given %{@link QueueSearchCriteria}
*/
@Authorized({ PrivilegeConstants.GET_QUEUES })
List<Queue> getQueues(@NotNull QueueSearchCriteria searchCriteria);

/**
Expand All @@ -79,7 +71,6 @@ public interface QueueService {
* @param queue the queue to retire
* @param retireReason the reason for voiding the queue
*/
@Authorized({ PrivilegeConstants.MANAGE_QUEUES })
void retireQueue(@NotNull Queue queue, String retireReason);

/**
Expand All @@ -88,6 +79,5 @@ public interface QueueService {
* @param queue queue to be deleted
* @throws APIException <strong>Should</strong> delete the given queue from the database
*/
@Authorized({ PrivilegeConstants.PURGE_QUEUES })
void purgeQueue(@NotNull Queue queue) throws APIException;
}
Original file line number Diff line number Diff line change
Expand Up @@ -14,74 +14,24 @@
import java.util.List;
import java.util.Optional;

import org.openmrs.annotation.Authorized;
import org.openmrs.api.APIException;
import org.openmrs.module.queue.api.search.RoomProviderMapSearchCriteria;
import org.openmrs.module.queue.model.RoomProviderMap;
import org.openmrs.module.queue.utils.PrivilegeConstants;

public interface RoomProviderMapService {

/**
* Gets a room provider map given a uuid.
*
* @param uuid uuid of the room provider map to be returned.
* @return {@link org.openmrs.module.queue.model.RoomProviderMap}
*/
@Authorized({ PrivilegeConstants.GET_ROOM_PROVIDER_MAPS })
Optional<RoomProviderMap> getRoomProviderMapByUuid(@NotNull String uuid);

/**
* Gets a room provider map by id.
*
* @param id the id of the room provider map to retrieve.
* @return {@link org.openmrs.module.queue.model.RoomProviderMap}
*/
@Authorized({ PrivilegeConstants.GET_ROOM_PROVIDER_MAPS })
Optional<RoomProviderMap> getRoomProviderMapById(@NotNull int id);

/**
* Saves a room provider map
*
* @param roomProviderMap the room provider map to be saved
* @return saved {@link org.openmrs.module.queue.model.RoomProviderMap}
*/
@Authorized({ PrivilegeConstants.MANAGE_ROOM_PROVIDER_MAPS })
RoomProviderMap saveRoomProviderMap(@NotNull RoomProviderMap roomProviderMap);

/**
* Gets a List of all Room Provider Maps.
*
* @return {@link List} of all room provider maps
*/
@Authorized({ PrivilegeConstants.GET_ROOM_PROVIDER_MAPS })
List<RoomProviderMap> getAllRoomProviderMaps();

/**
* Gets a List of all Room Provider Maps that match the given RoomProviderMapSearchCriteria.
*
* @return {@link List} of room provider maps that match the given
* {@link org.openmrs.module.queue.api.search.RoomProviderMapSearchCriteria}
*/
@Authorized({ PrivilegeConstants.GET_ROOM_PROVIDER_MAPS })
List<RoomProviderMap> getRoomProviderMaps(RoomProviderMapSearchCriteria searchCriteria);

/**
* Voids a room provider map
*
* @param roomProviderMap the room provider map to void
* @param voidReason the reason for voiding the room provider map
*/
@Authorized({ PrivilegeConstants.MANAGE_ROOM_PROVIDER_MAPS })
void voidRoomProviderMap(@NotNull RoomProviderMap roomProviderMap, String voidReason);

/**
* Completely remove a room provider map from the database
*
* @param roomProviderMap room provider map to be deleted
* @throws org.openmrs.api.APIException
*/
@Authorized({ PrivilegeConstants.PURGE_ROOM_PROVIDER_MAPS })
void purgeRoomProviderMap(@NotNull RoomProviderMap roomProviderMap) throws APIException;

}
Loading
Loading