com.sun.xml.ws.security.opt.api

Interface SecurityElement

All Known Subinterfaces:

SecurityHeaderElement

All Known Implementing Classes:

BinarySecurityToken, DerivedKey, DerivedKeyToken, DirectReference, EncryptedData, EncryptedHeader, EncryptedHeader, EncryptedKey, EncryptedSignedMessageHeader, EnvelopedSignedMessageHeader, GSHeaderElement, JAXBEncryptedData, JAXBEncryptedKey, JAXBSignatureHeaderElement, KerberosBinarySecurityToken, KeyIdentifier, ReferenceListHeader, SAMLAssertion, SAMLToken, SecurityContextToken, SecurityContextToken, SecurityContextToken13, SecurityTokenReference, Signature, SignatureConfirmation, SignatureConfirmation, SignedMessageHeader, SignedMessagePart, Timestamp, TimestampHeader, UsernameToken, UsernameTokenHeader, X509BinarySecurityToken, X509Data, X509IssuerSerial

public interface SecurityElement

Author:

K.Venugopal@sun.com

Method Summary

Modifier and Type	Method and Description
String	getId()
String	getLocalPart() Gets the local name of this header element.
String	getNamespaceURI()
XMLStreamReader	readHeader() Reads the header as a XMLStreamReader.
void	setId(String id)

Method Detail

getId

String getId()

Returns:

id

setId

void setId(String id)

Parameters:

id -

getNamespaceURI

String getNamespaceURI()

Returns:

namespace uri of the security header element.

getLocalPart

String getLocalPart()

Gets the local name of this header element.

Returns:

this string must be interned.

readHeader

XMLStreamReader readHeader()
                    throws XMLStreamException

Reads the header as a XMLStreamReader.

The returned parser points at the start element of this header. (IOW, XMLStreamReader.getEventType() would return XMLStreamConstants.START_ELEMENT.

Performance Expectation

For some Header implementations, this operation is a non-trivial operation. Therefore, use of this method is discouraged unless the caller is interested in reading the whole header.

Similarly, if the caller wants to use this method only to do the API conversion (such as simply firing SAX events from XMLStreamReader), then the JAX-WS team requests that you talk to us.

Messages that come from tranport usually provides a reasonably efficient implementation of this method.

Returns:

must not null.

Throws:

XMLStreamException