org.apache.ws.security.saml.SAMLIssuer Maven / Gradle / Ivy

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF 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.apache.ws.security.saml;

import javax.security.auth.callback.CallbackHandler;

import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.saml.ext.AssertionWrapper;

/**
 * Builds a WS SAML Assertion and inserts it into the SOAP Envelope.
 * Refer to the WS specification, SAML Token profile
 *
 * @author Davanum Srinivas ([email protected]).
 */
public interface SAMLIssuer {

    /**
     * Creates a new AssertionWrapper.
     * 
     * A complete AssertionWrapper is constructed.
     *
     * @return AssertionWrapper
     * @throws WSSecurityException
     */
    AssertionWrapper newAssertion() throws WSSecurityException;
    
    /**
     * Set whether to send the key value or whether to include the entire cert.
     * @param sendKeyValue whether to send the key value.
     */
    void setSendKeyValue(boolean sendKeyValue);
    
    /**
     * Get whether to send the key value or whether to include the entire cert.
     * @return whether to send the key value
     */
    boolean isSendKeyValue();
    
    /**
     * Set whether to sign the assertion or not.
     * @param signAssertion whether to sign the assertion or not.
     */
    void setSignAssertion(boolean signAssertion);
    
    /**
     * Get whether to sign the assertion or not
     * @return whether to sign the assertion or not
     */
    boolean isSignAssertion();
    
    /**
     * Set the CallbackHandler to use
     * @param callbackHandler the CallbackHandler to use
     */
    void setCallbackHandler(CallbackHandler callbackHandler);
    
    /**
     * Get the CallbackHandler in use
     * @return the CallbackHandler in use
     */
    CallbackHandler getCallbackHandler();
    
    /**
     * Set the issuer crypto
     * @param issuerCrypto the issuer crypto
     */
    void setIssuerCrypto(Crypto issuerCrypto);

    /**
     * @return Returns the issuerCrypto.
     */
    Crypto getIssuerCrypto();
    
    /**
     * Set the issuer name
     * @param issuer the issuer name
     */
    void setIssuerName(String issuer);
    
    /**
     * Get the issuer name
     * @return the issuer name
     */
    String getIssuerName();
    
    /**
     * Set the issuer key name
     * @param issuerKeyName the issuer key name
     */
    void setIssuerKeyName(String issuerKeyName);

    /**
     * @return Returns the issuerKeyName.
     */
    String getIssuerKeyName();

    /**
     * Set the issuer key password
     * @param issuerKeyPassword the issuerKeyPassword.
     */
    void setIssuerKeyPassword(String issuerKeyPassword);
    
    /**
     * @return Returns the issuerKeyPassword.
     */
    String getIssuerKeyPassword();

}