001/** 002 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. 003 * 004 * Copyright (c) 2006 Sun Microsystems Inc. All Rights Reserved 005 * 006 * The contents of this file are subject to the terms 007 * of the Common Development and Distribution License 008 * (the License). You may not use this file except in 009 * compliance with the License. 010 * 011 * You can obtain a copy of the License at 012 * https://opensso.dev.java.net/public/CDDLv1.0.html or 013 * opensso/legal/CDDLv1.0.txt 014 * See the License for the specific language governing 015 * permission and limitations under the License. 016 * 017 * When distributing Covered Code, include this CDDL 018 * Header Notice in each file and include the License file 019 * at opensso/legal/CDDLv1.0.txt. 020 * If applicable, add the following below the CDDL Header, 021 * with the fields enclosed by brackets [] replaced by 022 * your own identifying information: 023 * "Portions Copyrighted [year] [name of copyright owner]" 024 * 025 * $Id: MechanismHandler.java,v 1.2 2008/06/25 05:47:07 qcheng Exp $ 026 * 027 */ 028 029 030package com.sun.identity.liberty.ws.authnsvc.mechanism; 031 032import com.sun.identity.liberty.ws.authnsvc.protocol.SASLRequest; 033import com.sun.identity.liberty.ws.authnsvc.protocol.SASLResponse; 034import com.sun.identity.liberty.ws.soapbinding.Message; 035 036/** 037 * The <code>MechanismHandler</code> interface needs to be implemented 038 * for different SASL mechanisms to authenticate. Each SASL mechanism 039 * will correspond to one handler implementation which processes incoming 040 * SASL request and generates SASL response. 041 * @supported.all.api 042 */ 043public interface MechanismHandler { 044 /** 045 * Generates a SASL response according to the SASL request. 046 * @param saslReq a SASL request 047 * @param message a SOAP Message containing the SASL request 048 * @param respMessageID messageID of SOAP Message response that will 049 * contain returned SASL response 050 * @return a SASL response 051 */ 052 public SASLResponse processSASLRequest(SASLRequest saslReq, 053 Message message, String respMessageID); 054}