org.opensaml.xmlsec.encryption.EncryptionProperty Maven / Gradle / Ivy
/*
* 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.xmlsec.encryption;
import javax.annotation.Nullable;
import javax.xml.namespace.QName;
import org.opensaml.core.xml.AttributeExtensibleXMLObject;
import org.opensaml.core.xml.ElementExtensibleXMLObject;
import org.opensaml.xmlsec.encryption.support.EncryptionConstants;
/**
* XMLObject representing XML Encryption, version 20021210, EncryptionProperty element.
*/
public interface EncryptionProperty extends AttributeExtensibleXMLObject, ElementExtensibleXMLObject {
/** Element local name. */
public static final String DEFAULT_ELEMENT_LOCAL_NAME = "EncryptionProperty";
/** Default element name. */
public static final QName DEFAULT_ELEMENT_NAME = new QName(EncryptionConstants.XMLENC_NS,
DEFAULT_ELEMENT_LOCAL_NAME, EncryptionConstants.XMLENC_PREFIX);
/** Local name of the XSI type. */
public static final String TYPE_LOCAL_NAME = "EncryptionPropertyType";
/** QName of the XSI type. */
public static final QName TYPE_NAME = new QName(EncryptionConstants.XMLENC_NS, TYPE_LOCAL_NAME,
EncryptionConstants.XMLENC_PREFIX);
/** Target attribute name. */
public static final String TARGET_ATTRIB_NAME = "Target";
/** Id attribute name. */
public static final String ID_ATTRIB_NAME = "Id";
/**
* Get the target URI attribute which specifies to which element this. property applies
*
* @return the target URI attribute
*/
@Nullable public String getTarget();
/**
* Set the target URI attribute which specifies to which element this property applies.
*
* @param newTarget the new target URI attribute
*/
public void setTarget(@Nullable final String newTarget);
/**
* Get the ID attribute which uniquely identifies this element.
*
* @return the ID attribute value
*/
@Nullable public String getID();
/**
* Set the ID attribute which uniquely identifies this element.
*
* @param newID the new ID attribute
*/
public void setID(@Nullable final String newID);
}