-
- All Superinterfaces:
- XMLStructure
public interface KeyInfo extends XMLStructure
A representation of the XMLKeyInfo
element as defined in the W3C Recommendation for XML-Signature Syntax and Processing. AKeyInfo
contains a list ofXMLStructure
s, each of which contain information that enables the recipient(s) to obtain the key needed to validate an XML signature. The XML Schema Definition is defined as:<element name="KeyInfo" type="ds:KeyInfoType"/> <complexType name="KeyInfoType" mixed="true"> <choice maxOccurs="unbounded"> <element ref="ds:KeyName"/> <element ref="ds:KeyValue"/> <element ref="ds:RetrievalMethod"/> <element ref="ds:X509Data"/> <element ref="ds:PGPData"/> <element ref="ds:SPKIData"/> <element ref="ds:MgmtData"/> <any processContents="lax" namespace="##other"/> <!-- (1,1) elements from (0,unbounded) namespaces --> </choice> <attribute name="Id" type="ID" use="optional"/> </complexType>
AKeyInfo
instance may be created by invoking one of thenewKeyInfo
methods of theKeyInfoFactory
class, and passing it a list of one or moreXMLStructure
s and an optional id parameter; for example:KeyInfoFactory factory = KeyInfoFactory.getInstance("DOM"); KeyInfo keyInfo = factory.newKeyInfo (Collections.singletonList(factory.newKeyName("Alice"), "keyinfo-1"));
KeyInfo
objects can also be marshalled to XML by invoking themarshal
method.- Since:
- 1.6
- See Also:
KeyInfoFactory.newKeyInfo(List)
,KeyInfoFactory.newKeyInfo(List, String)
-
-
Method Summary
Methods Modifier and Type Method and Description List
getContent()
Returns anunmodifiable list
containing the key information.String
getId()
Return the optional Id attribute of thisKeyInfo
, which may be useful for referencing thisKeyInfo
from other XML structures.void
marshal(XMLStructure parent, XMLCryptoContext context)
Marshals the key info to XML.-
Methods inherited from interface javax.xml.crypto.XMLStructure
isFeatureSupported
-
-
-
-
Method Detail
-
getContent
List getContent()
Returns anunmodifiable list
containing the key information. Each entry of the list is anXMLStructure
.If there is a public subclass representing the type of
XMLStructure
, it is returned as an instance of that class (ex: anX509Data
element would be returned as an instance ofX509Data
).- Returns:
- an unmodifiable list of one or more
XMLStructure
s in thisKeyInfo
. Never returnsnull
or an empty list.
-
getId
String getId()
Return the optional Id attribute of thisKeyInfo
, which may be useful for referencing thisKeyInfo
from other XML structures.- Returns:
- the Id attribute of this
KeyInfo
(may benull
if not specified)
-
marshal
void marshal(XMLStructure parent, XMLCryptoContext context) throws MarshalException
Marshals the key info to XML.- Parameters:
parent
- a mechanism-specific structure containing the parent node that the marshalled key info will be appended tocontext
- theXMLCryptoContext
containing additional context (may be null if not applicable)- Throws:
ClassCastException
- if the type ofparent
orcontext
is not compatible with this key infoMarshalException
- if the key info cannot be marshalledNullPointerException
- ifparent
isnull
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
22/12/2024 04:06:32 Cette version de la page est en cache (à la date du 22/12/2024 04:06:32) afin d'accélérer le traitement. Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la dernère version de la page.Document créé le 11/06/2005, dernière modification le 04/03/2020
Source du document imprimé : https://www.gaudry.be/java-api-rf-javax/xml/crypto/dsig/keyinfo/KeyInfo.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.