tech.aroma.data.UserPreferencesRepository Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2017 RedRoma, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */


package tech.aroma.data;

import java.util.Set;

import org.apache.thrift.TException;
import sir.wellington.alchemy.collections.sets.Sets;
import tech.aroma.thrift.User;
import tech.aroma.thrift.channels.MobileDevice;
import tech.aroma.thrift.exceptions.InvalidArgumentException;
import tech.sirwellington.alchemy.annotations.arguments.NonEmpty;
import tech.sirwellington.alchemy.annotations.arguments.Required;
import tech.sirwellington.alchemy.annotations.concurrency.ThreadSafe;
import tech.sirwellington.alchemy.annotations.designs.patterns.StrategyPattern;

import static tech.aroma.data.assertions.RequestAssertions.validMobileDevice;
import static tech.aroma.data.assertions.RequestAssertions.validUserId;
import static tech.sirwellington.alchemy.annotations.designs.patterns.StrategyPattern.Role.INTERFACE;
import static tech.sirwellington.alchemy.arguments.Arguments.*;


/**
 * This Repository is responsible for storing information about Users, and their Preferences.
 * 
 *  * 
 * Examples:
 * + Mobile Devices (used to send Push Notifications)
 * + Personal Reactions (applied to messages that hit their Inboxes)
 * + User Activity 
 * 
 * 
 * @author SirWellington
 */
@StrategyPattern(role = INTERFACE)
@ThreadSafe
public interface UserPreferencesRepository 
{
    default boolean containsMobileDevice(String userId, MobileDevice mobileDevice) throws TException
    {
        checkThat(userId)
            .throwing(InvalidArgumentException.class)
            .is(validUserId());
        
        checkThat(mobileDevice)
            .throwing(InvalidArgumentException.class)
            .is(validMobileDevice());
        
        Set devices = getMobileDevices(userId);
        
        if (Sets.isEmpty(devices))
        {
            return false;
        }
        
        return devices.contains(mobileDevice);
    }
    
    void saveMobileDevice(@NonEmpty String userId, @Required MobileDevice mobileDevice) throws TException;
    
    /**
     * This Operation overwrites all existing Mobile Devices registered for the specified User.
     * 
     * @param userId The {@linkplain User#userId User ID} to save and associate the devices with.
     * @param mobileDevices The Set of Mobile Devices belonging to the user.
     * @throws TException 
     */
    void saveMobileDevices(@NonEmpty String userId, @Required Set mobileDevices) throws TException;
    
    /**
     * Get the Set of all Mobile Devices registered to a {@link User}.
     * 
     * @param userId The {@linkplain User#userId User ID} of the User.
     * @return
     * @throws TException 
     */
    Set getMobileDevices(@NonEmpty String userId) throws TException;
    
    /**
     * Disassociates and removes a device associated with a particular user.
     * 
     * @param userId The User ID the Device is associated with.
     * @param mobileDevice The Device to remove.
     * @throws TException 
     */
    void deleteMobileDevice(@NonEmpty String userId, @Required MobileDevice mobileDevice) throws TException;
    
    /**
     * Removes an Disassociates all devices registered to the specified {@link User}.
     * 
     * @param userId
     * @throws TException 
     */
    void deleteAllMobileDevices(@NonEmpty String userId) throws TException;
}