UseKey (OpenSAML :: SOAP Provider API 4.1.1 API)

All Superinterfaces:

WSTrustObject, XMLObject
```
public interface UseKey
extends WSTrustObject
```
The wst:UseKey element.

See Also:

"WS-Trust 1.3, Chapter 9.2 Key and Encryption Requirements."

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`ELEMENT_LOCAL_NAME`	Element local name.
`static QName`	`ELEMENT_NAME`	Default element name.
`static String`	`SIG_ATTRIB_NAME`	The wst:UseKey/@Sig attribute local name.
`static String`	`TYPE_LOCAL_NAME`	Local name of the XSI type.
`static QName`	`TYPE_NAME`	QName of the XSI type.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`getSig()`	Returns the wst:UseKey/@Sig attribute value.
`XMLObject`	`getUnknownXMLObject()`	Get the unknown child element.
`void`	`setSig(String sig)`	Sets the wst:UseKey/@Sig attribute value.
`void`	`setUnknownXMLObject(XMLObject unknownObject)`	Set the unknown child element.

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
  - ELEMENT_LOCAL_NAME
```
static final String ELEMENT_LOCAL_NAME
```
    Element local name.
    
    See Also:
    
    Constant Field Values
  - ELEMENT_NAME
```
static final QName ELEMENT_NAME
```
    Default element name.
  - TYPE_LOCAL_NAME
```
static final String TYPE_LOCAL_NAME
```
    Local name of the XSI type.
    
    See Also:
    
    Constant Field Values
  - TYPE_NAME
```
static final QName TYPE_NAME
```
    QName of the XSI type.
  - SIG_ATTRIB_NAME
```
static final String SIG_ATTRIB_NAME
```
    The wst:UseKey/@Sig attribute local name.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getUnknownXMLObject
```
XMLObject getUnknownXMLObject()
```
    Get the unknown child element.
    
    Returns:
    
    the child element
  - setUnknownXMLObject
```
void setUnknownXMLObject(XMLObject unknownObject)
```
    Set the unknown child element.
    
    Parameters:
    
    unknownObject - the new child element
  - getSig
```
String getSig()
```
    Returns the wst:UseKey/@Sig attribute value.
    
    Returns:
    
    the Sig attribute value or null
  - setSig
```
void setSig(String sig)
```
    Sets the wst:UseKey/@Sig attribute value.
    
    Parameters:
    
    sig - the Sig attribute value to set.