001/*
002 * (C) Copyright 2014 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     Nelson Silva <[email protected]>
018 */
019package org.nuxeo.ecm.platform.auth.saml.slo;
020
021import org.nuxeo.ecm.platform.auth.saml.SAMLCredential;
022import org.opensaml.common.SAMLException;
023import org.opensaml.common.binding.SAMLMessageContext;
024import org.opensaml.saml2.core.LogoutRequest;
025import org.opensaml.saml2.metadata.Endpoint;
026
027/**
028 * WebSLO (Single Log Out) profile.
029 *
030 * @since 6.0
031 */
032public interface SLOProfile {
033
034    /**
035     * Identifier of the Single Logout profile.
036     */
037    public static final String PROFILE_URI = "urn:oasis:names:tc:SAML:2.0:profiles:SSO:logout";
038
039    LogoutRequest buildLogoutRequest(SAMLMessageContext context, SAMLCredential credential) throws SAMLException;
040
041    void processLogoutResponse(SAMLMessageContext context) throws SAMLException;
042
043    boolean processLogoutRequest(SAMLMessageContext context, SAMLCredential credential) throws SAMLException;
044
045    Endpoint getEndpoint();
046}