package com.armedia.acm.portalgateway.service;

/*-
 * #%L
 * ACM Service: Portal Gateway Service
 * %%
 * Copyright (C) 2014 - 2018 ArkCase LLC
 * %%
 * This file is part of the ArkCase software.
 *
 * If the software was purchased under a paid ArkCase license, the terms of
 * the paid license agreement will prevail.  Otherwise, the software is
 * provided under the following open source license terms:
 *
 * ArkCase 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 3 of the License, or
 * (at your option) any later version.
 *
 * ArkCase 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 ArkCase. If not, see <http://www.gnu.org/licenses/>.
 * #L%
 */

import com.armedia.acm.core.exceptions.AcmObjectNotFoundException;
import com.armedia.acm.services.users.model.ldap.AcmLdapActionFailedException;

import org.springframework.security.core.Authentication;

/**
 * @author Lazo Lazarev a.k.a. Lazarius Borg @ zerogravity May 28, 2018
 *
 */
public interface PortalAdminService
{

    String GET_INFO_METHOD = "GET_PORTAL_INFO_PORTAL_NOT_FOUND";

    String UNREGISTER_METHOD = "UNREGISTER_PORTAL_PORTAL_NOT_FOUND";

    String UPDATE_METHOD_USER = "UPDATE_PORTAL_USER_NOT_FOUND";

    String UPDATE_METHOD_PORTAL = "UPDATE_PORTAL_PORTAL_NOT_FOUND";

    /**
     * @return
     */
    String generateId();


    /**
     * @param se
     * @return
     */
    PortalServiceExceptionMapper getExceptionMapper(PortalAdminServiceException se);

    void moveExistingLdapUsersToGroup(String groupName, PortalConfigurationService portalConfigurationService, String directoryName, Authentication auth)
            throws AcmLdapActionFailedException, AcmObjectNotFoundException;
}