KeyInfo

All Superinterfaces:

XMLObject

All Known Subinterfaces:

OriginatorKeyInfo, RecipientKeyInfo

All Known Implementing Classes:

KeyInfoImpl, OriginatorKeyInfoImpl, RecipientKeyInfoImpl
```
public interface KeyInfo
extends XMLObject
```
XMLObject representing XML Digital Signature, version 20020212, KeyInfo element.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`DEFAULT_ELEMENT_LOCAL_NAME` Element local name.
`static javax.xml.namespace.QName`	`DEFAULT_ELEMENT_NAME` Default element name.
`static java.lang.String`	`ID_ATTRIB_NAME` Id attribute name.
`static java.lang.String`	`TYPE_LOCAL_NAME` Local name of the XSI type.
`static javax.xml.namespace.QName`	`TYPE_NAME` QName of the XSI type.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.util.List<AgreementMethod>`	`getAgreementMethods()` Get the list of AgreementMethod child elements.
`java.util.List<DEREncodedKeyValue>`	`getDEREncodedKeyValues()` Get the list of DEREncodedKeyValue child elements.
`java.util.List<EncryptedKey>`	`getEncryptedKeys()` Get the list of EncryptedKey child elements Note: EncryptedKey is actually defined in the XML Encryption schema, and is not explicitly defined in the KeyInfoType content model, but for convenience this named getter method is exposed.
`java.lang.String`	`getID()` Get the Id attribute value.
`java.util.List<KeyInfoReference>`	`getKeyInfoReferences()` Get the list of KeyInfoReference child elements.
`java.util.List<KeyName>`	`getKeyNames()` Get the list of KeyName child elements.
`java.util.List<KeyValue>`	`getKeyValues()` Get the list of KeyValue child elements.
`java.util.List<MgmtData>`	`getMgmtDatas()` Get the list of MgmtData child elements.
`java.util.List<PGPData>`	`getPGPDatas()` Get the list of PGPData child elements.
`java.util.List<RetrievalMethod>`	`getRetrievalMethods()` Get the list of RetrievalMethod child elements.
`java.util.List<SPKIData>`	`getSPKIDatas()` Get the list of SPKIData child elements.
`java.util.List<X509Data>`	`getX509Datas()` Get the list of X509Data child elements.
`java.util.List<XMLObject>`	`getXMLObjects()` Get the list of all XMLObject children.
`java.util.List<XMLObject>`	`getXMLObjects(javax.xml.namespace.QName typeOrName)` Get the list of XMLObject children whose type or element QName matches the specified QName.
`void`	`setID(java.lang.String newID)` Set the Id attribute value.

Methods inherited from interface org.opensaml.core.xml.XMLObject
detach, getDOM, getElementQName, getIDIndex, getNamespaceManager, getNamespaces, getNoNamespaceSchemaLocation, getObjectMetadata, getOrderedChildren, getParent, getSchemaLocation, getSchemaType, hasChildren, hasParent, isNil, isNilXSBoolean, releaseChildrenDOM, releaseDOM, releaseParentDOM, resolveID, resolveIDFromRoot, setDOM, setNil, setNil, setNoNamespaceSchemaLocation, setParent, setSchemaLocation

- Field Detail
  - DEFAULT_ELEMENT_LOCAL_NAME
```
static final java.lang.String DEFAULT_ELEMENT_LOCAL_NAME
```
    Element local name.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_ELEMENT_NAME
```
static final javax.xml.namespace.QName DEFAULT_ELEMENT_NAME
```
    Default element name.
  - TYPE_LOCAL_NAME
```
static final java.lang.String TYPE_LOCAL_NAME
```
    Local name of the XSI type.
    
    See Also:
    
    Constant Field Values
  - TYPE_NAME
```
static final javax.xml.namespace.QName TYPE_NAME
```
    QName of the XSI type.
  - ID_ATTRIB_NAME
```
static final java.lang.String ID_ATTRIB_NAME
```
    Id attribute name.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getID
```
@Nullable
java.lang.String getID()
```
    Get the Id attribute value.
    
    Returns:
    
    the Id attribute value
  - setID
```
void setID(@Nullable
           java.lang.String newID)
```
    Set the Id attribute value.
    
    Parameters:
    
    newID - the new Id attribute value
  - getXMLObjects
```
@Nonnull
java.util.List<XMLObject> getXMLObjects()
```
    Get the list of all XMLObject children.
    
    Returns:
    
    the list of XMLObject children
  - getXMLObjects
```
@Nonnull
java.util.List<XMLObject> getXMLObjects(@Nonnull
                                                 javax.xml.namespace.QName typeOrName)
```
    Get the list of XMLObject children whose type or element QName matches the specified QName.
    
    Parameters:
    
    typeOrName - the QName of the desired elements
    
    Returns:
    
    the matching list of XMLObject children
  - getKeyNames
```
@Nonnull
java.util.List<KeyName> getKeyNames()
```
    Get the list of KeyName child elements.
    
    Returns:
    
    the list of KeyName child elements
  - getKeyValues
```
@Nonnull
java.util.List<KeyValue> getKeyValues()
```
    Get the list of KeyValue child elements.
    
    Returns:
    
    the list of KeyValue child elements
  - getDEREncodedKeyValues
```
@Nonnull
java.util.List<DEREncodedKeyValue> getDEREncodedKeyValues()
```
    Get the list of DEREncodedKeyValue child elements.
    
    Returns:
    
    the list of DEREncodedKeyValue child elements
  - getRetrievalMethods
```
@Nonnull
java.util.List<RetrievalMethod> getRetrievalMethods()
```
    Get the list of RetrievalMethod child elements.
    
    Returns:
    
    the list of RetrievalMethod child elements
  - getKeyInfoReferences
```
@Nonnull
java.util.List<KeyInfoReference> getKeyInfoReferences()
```
    Get the list of KeyInfoReference child elements.
    
    Returns:
    
    the list of KeyInfoReference child elements
  - getX509Datas
```
@Nonnull
java.util.List<X509Data> getX509Datas()
```
    Get the list of X509Data child elements.
    
    Returns:
    
    the list of X509Data child elements
  - getPGPDatas
```
@Nonnull
java.util.List<PGPData> getPGPDatas()
```
    Get the list of PGPData child elements.
    
    Returns:
    
    the list of PGPData child elements
  - getSPKIDatas
```
@Nonnull
java.util.List<SPKIData> getSPKIDatas()
```
    Get the list of SPKIData child elements.
    
    Returns:
    
    the list of SPKIData child elements
  - getMgmtDatas
```
@Nonnull
java.util.List<MgmtData> getMgmtDatas()
```
    Get the list of MgmtData child elements.
    
    Returns:
    
    the list of MgmtData child elements
  - getAgreementMethods
```
@Nonnull
java.util.List<AgreementMethod> getAgreementMethods()
```
    Get the list of AgreementMethod child elements. Note: AgreementMethod is actually defined in the XML Encryption schema, and is not explicitly defined in the KeyInfoType content model, but for convenience this named getter method is exposed.
    
    Returns:
    
    the list of AgreementMethod child elements
  - getEncryptedKeys
```
@Nonnull
java.util.List<EncryptedKey> getEncryptedKeys()
```
    Get the list of EncryptedKey child elements Note: EncryptedKey is actually defined in the XML Encryption schema, and is not explicitly defined in the KeyInfoType content model, but for convenience this named getter method is exposed.
    
    Returns:
    
    the list of EncryptedKey child elements

Interface KeyInfo

Field Summary

Method Summary

Methods inherited from interface org.opensaml.core.xml.XMLObject

Field Detail

DEFAULT_ELEMENT_LOCAL_NAME

DEFAULT_ELEMENT_NAME

TYPE_LOCAL_NAME

TYPE_NAME

ID_ATTRIB_NAME

Method Detail

getID

setID

getXMLObjects

getXMLObjects

getKeyNames

getKeyValues

getDEREncodedKeyValues

getRetrievalMethods

getKeyInfoReferences

getX509Datas

getPGPDatas

getSPKIDatas

getMgmtDatas

getAgreementMethods

getEncryptedKeys