IdpInitSSOLogoutRequestProcessor.java

/*
 * Copyright (c) 2015, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
 *
 * WSO2 Inc. licenses this file to you 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 org.wso2.carbon.identity.sso.saml.processors;

import org.wso2.carbon.identity.base.IdentityException;
import org.wso2.carbon.identity.sso.saml.dto.QueryParamDTO;
import org.wso2.carbon.identity.sso.saml.dto.SAMLSSOReqValidationResponseDTO;

/**
 * Interface to implement in order to process a received IDP initiated SAML SSO logout request.
 * Implementation class should be defined in <>identity.xml</> under <>SSOService</> element as
 * <IdpInitSSOLogoutRequestProcessor></IdpInitSSOLogoutRequestProcessor>
 */
public interface IdpInitSSOLogoutRequestProcessor {

    /**
     * Processes the logout request according to SAML SSO Web Browser Specification
     *
     * @return SAMLSSOSignInResponseDTO : includes processing outputs
     * @throws IdentityException
     */
    SAMLSSOReqValidationResponseDTO process(String sessionId, QueryParamDTO[] queryParamDTOs,
                                            String serverURL) throws IdentityException;
}