org.opensaml.soap.wssecurity.IdBearing 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;

/**
 * Interface for element having a @wsu:Id attribute.
 * 
 */
public interface IdBearing {

    /** the Id attribute local name. */
    public static final String WSU_ID_ATTR_LOCAL_NAME = "Id";

    /** the wsu:Id qualified attribute name. */
    public static final QName WSU_ID_ATTR_NAME =
        new QName(WSSecurityConstants.WSU_NS, WSU_ID_ATTR_LOCAL_NAME, WSSecurityConstants.WSU_PREFIX);

    /**
     * Returns the @wsu:Id attribute value.
     * 
     * @return The @wsu:Id attribute value or null.
     */
    public String getWSUId();

    /**
     * Sets the @wsu:Id attribute value.
     * 
     * @param newId The @wsu:Id attribute value
     */
    public void setWSUId(String newId);

}