org.opensaml.soap.wssecurity.Password Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opensaml-soap-api Show documentation

SOAP Provider API

There is a newer version: 4.0.1

/*
 * Licensed to the University Corporation for Advanced Internet Development, 
 * Inc. (UCAID) under one or more contributor license agreements.  See the 
 * NOTICE file distributed with this work for additional information regarding
 * copyright ownership. The UCAID 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.opensaml.soap.wssecurity;

import javax.xml.namespace.QName;

/**
 * The Password element.
 * 
 * @see "WS-Security UsernameToken Profile 1.1"
 * 
 */
public interface Password extends AttributedString {
    /** Element local name. */
    public static final String ELEMENT_LOCAL_NAME = "Password";

    /** Qualified element name. */
    public static final QName ELEMENT_NAME = 
        new QName(WSSecurityConstants.WSSE_NS, ELEMENT_LOCAL_NAME, WSSecurityConstants.WSSE_PREFIX);

    /** The Type attribute local name. */
    public static final String TYPE_ATTRIB_NAME = "Type";
    
    /**
     * The wsse:Password/@Type attribute URI value #PasswordText (DEFAULT).
     */
    public static final String TYPE_PASSWORD_TEXT = WSSecurityConstants.WSSE_NS + "#PasswordText";

    /**
     * The wsse:Password/@Type attribute URI value #PasswordDigest.
     */
    public static final String TYPE_PASSWORD_DIGEST = WSSecurityConstants.WSSE_NS + "#PasswordDigest";

    /**
     * Returns the wsse:Password/@Type attribute URI value.
     * 
     * @return the Type attribute URI value.
     */
    public String getType();

    /**
     * Sets the wsse:Password/@Type attribute URI value.
     * 
     * @param type the Type attribute URI value to set.
     */
    public void setType(String type);

}