WebServicesDelegate.java

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-2011 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package com.sun.enterprise.security.jmac;

import com.sun.enterprise.deployment.ServiceReferenceDescriptor;
import com.sun.enterprise.deployment.runtime.common.MessageSecurityBindingDescriptor;
import com.sun.enterprise.security.jmac.config.ConfigHelper;
import java.util.Map;
import javax.security.auth.message.MessageInfo;
import com.sun.enterprise.security.jauth.AuthParam;
import org.glassfish.api.invocation.ComponentInvocation;
import org.jvnet.hk2.annotations.Contract;

/**
 * A Delegate Interface for handling WebServices Specific Security and  JSR 196 Providers
 * This insulates the GF Web-Bundle from any WebServices Dependencies.
 * @author kumar.jayanti
 */
@Contract
public interface  WebServicesDelegate {
    /**
     * 
     * @param svcRef The ServiceReferenceDescriptor
     * @param properties The Properties Map passed to WebServices Code Via PipeCreator
     * @return The MessageSecurityBindingDescriptor
     */
    public MessageSecurityBindingDescriptor getBinding(ServiceReferenceDescriptor svcRef, Map properties);
    /**
     * remove the registration of the argument listener from the Pipe
     * @param listener
     */
    public void removeListener(ConfigHelper.AuthConfigRegistrationWrapper listener);
    /** 
     * @return the classname of the Default JSR 196 WebServices Security Provider (A.k.a Metro Security Provider)
     */
    public String  getDefaultWebServicesProvider();
    
    /**
     * @param messageInfo  The MessageInfo
     * @return the AuthContextID computed from the argument MessageInfo
     */
    public String getAuthContextID(MessageInfo messageInfo);
    
    /**
     * @param messageInfo TheMessageInfo
     * @return a new instance of SOAPAuthParam
     */
    public AuthParam newSOAPAuthParam(MessageInfo messageInfo);
    
    /**
     * return the SOAP Message from the invocation, to be used by JACC PolicyContextHandler
     * @param inv the invocation
     * @return the SOAP Message
     */
    public Object getSOAPMessage(ComponentInvocation inv);
}