com.sun.xml.ws.security.opt.impl.reference
Class DirectReference

java.lang.Object
  com.sun.xml.ws.security.secext10.ReferenceType
      com.sun.xml.ws.security.opt.impl.reference.DirectReference

All Implemented Interfaces:

DirectReference, Reference, SecurityElement, SecurityElementWriter, SecurityHeaderElement

public class DirectReference
extends ReferenceType
implements DirectReference, SecurityHeaderElement, SecurityElementWriter

Class for DirectReference reference type inside a STR

Author:

Ashutosh.Shahi@sun.com

Field Summary

Fields inherited from class com.sun.xml.ws.security.secext10.ReferenceType

uri, valueType

Constructor Summary

DirectReference(com.sun.xml.ws.api.SOAPVersion sv)
Creates a new instance of DirectReference

Method Summary

void	addReferencedSecHeaderElement(java.lang.String id)
java.lang.String	getAttribute(javax.xml.namespace.QName name)
java.lang.String	getAttribute(java.lang.String nsUri, java.lang.String localName)
java.lang.String	getId()
java.lang.String	getLocalPart() Gets the local name of this header element.
java.lang.String	getNamespaceURI()
java.util.List<java.lang.String>	getReferencedSecHeaderElements()
java.lang.String	getType()
java.lang.String	getURI()
java.lang.String	getValueType()
javax.xml.stream.XMLStreamReader	readHeader() Reads the header as a XMLStreamReader.
boolean	refersToSecHdrWithId(java.lang.String id)
java.lang.String	setAttribute(javax.xml.namespace.QName name, java.lang.String value)
java.lang.String	setAttribute(java.lang.String nsUri, java.lang.String localName, java.lang.String value)
void	setId(java.lang.String id)
void	setURI(java.lang.String uri)
void	setValueType(java.lang.String valueType)
void	writeTo(java.io.OutputStream os)
void	writeTo(javax.xml.stream.XMLStreamWriter streamWriter) Writes out the header.
void	writeTo(javax.xml.stream.XMLStreamWriter streamWriter, java.util.HashMap props)

Methods inherited from class com.sun.xml.ws.security.secext10.ReferenceType

getOtherAttributes

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DirectReference

public DirectReference(com.sun.xml.ws.api.SOAPVersion sv)

Creates a new instance of DirectReference

Method Detail

getValueType

public java.lang.String getValueType()

Specified by:

getValueType in interface DirectReference

Overrides:

getValueType in class ReferenceType

Returns:

the valueType attribute of direct reference

setValueType

public void setValueType(java.lang.String valueType)

Specified by:

setValueType in interface DirectReference

Overrides:

setValueType in class ReferenceType

Parameters:

valueType - sets the valueType attribute

getURI

public java.lang.String getURI()

Specified by:

getURI in interface DirectReference

Overrides:

getURI in class ReferenceType

Returns:

the URI attribute

setURI

public void setURI(java.lang.String uri)

Specified by:

setURI in interface DirectReference

Overrides:

setURI in class ReferenceType

Parameters:

uri - sets the uri attribute

getType

public java.lang.String getType()

Specified by:

getType in interface Reference

Returns:

the reference type used

getId

public java.lang.String getId()

Specified by:

getId in interface SecurityElement

Returns:

id

setId

public void setId(java.lang.String id)

Specified by:

setId in interface SecurityElement

getNamespaceURI

public java.lang.String getNamespaceURI()

Specified by:

getNamespaceURI in interface SecurityElement

Returns:

namespace uri of the security header element.

getLocalPart

public java.lang.String getLocalPart()

Description copied from interface: SecurityElement

Gets the local name of this header element.

Specified by:

getLocalPart in interface SecurityElement

Returns:

this string must be interned.

setAttribute

public java.lang.String setAttribute(@NotNull
                                     java.lang.String nsUri,
                                     @NotNull
                                     java.lang.String localName,
                                     @NotNull
                                     java.lang.String value)

setAttribute

public java.lang.String setAttribute(@NotNull
                                     javax.xml.namespace.QName name,
                                     @NotNull
                                     java.lang.String value)

getAttribute

public java.lang.String getAttribute(@NotNull
                                     java.lang.String nsUri,
                                     @NotNull
                                     java.lang.String localName)

getAttribute

public java.lang.String getAttribute(@NotNull
                                     javax.xml.namespace.QName name)

readHeader

public javax.xml.stream.XMLStreamReader readHeader()
                                            throws javax.xml.stream.XMLStreamException

Description copied from interface: SecurityElement

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.

Specified by:

readHeader in interface SecurityElement

Returns:

must not null.

Throws:

javax.xml.stream.XMLStreamException

writeTo

public void writeTo(javax.xml.stream.XMLStreamWriter streamWriter)
             throws javax.xml.stream.XMLStreamException

Writes out the header.

Specified by:

writeTo in interface SecurityElementWriter

Throws:

javax.xml.stream.XMLStreamException - if the operation fails for some reason. This leaves the writer to an undefined state.

writeTo

public void writeTo(javax.xml.stream.XMLStreamWriter streamWriter,
                    java.util.HashMap props)
             throws javax.xml.stream.XMLStreamException

Specified by:

writeTo in interface SecurityElementWriter

Parameters:

streamWriter -

props -

Throws:

javax.xml.stream.XMLStreamException

writeTo

public void writeTo(java.io.OutputStream os)

Specified by:

writeTo in interface SecurityElementWriter

Parameters:

os -

getReferencedSecHeaderElements

public java.util.List<java.lang.String> getReferencedSecHeaderElements()

addReferencedSecHeaderElement

public void addReferencedSecHeaderElement(java.lang.String id)

refersToSecHdrWithId

public boolean refersToSecHdrWithId(java.lang.String id)

Specified by:

refersToSecHdrWithId in interface SecurityHeaderElement

Parameters:

id -

Returns: