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

java.lang.Object
  extended by com.sun.xml.ws.security.secext10.ReferenceType
      extended by 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(SOAPVersion sv)
          Creates a new instance of DirectReference
 
Method Summary
 void addReferencedSecHeaderElement(String id)
           
 String getAttribute(QName name)
           
 String getAttribute(String nsUri, String localName)
           
 String getId()
           
 String getLocalPart()
          Gets the local name of this header element.
 String getNamespaceURI()
           
 List<String> getReferencedSecHeaderElements()
           
 String getType()
           
 String getURI()
          Gets the value of the uri property.
 String getValueType()
          Gets the value of the valueType property.
 XMLStreamReader readHeader()
          Reads the header as a XMLStreamReader.
 boolean refersToSecHdrWithId(String id)
           
 String setAttribute(QName name, String value)
           
 String setAttribute(String nsUri, String localName, String value)
           
 void setId(String id)
           
 void setURI(String uri)
          Sets the value of the uri property.
 void setValueType(String valueType)
          Sets the value of the valueType property.
 void writeTo(OutputStream os)
           
 void writeTo(XMLStreamWriter streamWriter)
          Writes out the header.
 void writeTo(XMLStreamWriter streamWriter, 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(SOAPVersion sv)
Creates a new instance of DirectReference

Method Detail

getValueType

public String getValueType()
Description copied from class: ReferenceType
Gets the value of the valueType property.

Specified by:
getValueType in interface DirectReference
Overrides:
getValueType in class ReferenceType
Returns:
the valueType attribute of direct reference

setValueType

public void setValueType(String valueType)
Description copied from class: ReferenceType
Sets the value of the valueType property.

Specified by:
setValueType in interface DirectReference
Overrides:
setValueType in class ReferenceType
Parameters:
valueType - sets the valueType attribute

getURI

public String getURI()
Description copied from class: ReferenceType
Gets the value of the uri property.

Specified by:
getURI in interface DirectReference
Overrides:
getURI in class ReferenceType
Returns:
the URI attribute

setURI

public void setURI(String uri)
Description copied from class: ReferenceType
Sets the value of the uri property.

Specified by:
setURI in interface DirectReference
Overrides:
setURI in class ReferenceType
Parameters:
uri - sets the uri attribute

getType

public String getType()
Specified by:
getType in interface Reference
Returns:
the reference type used

getId

public String getId()
Specified by:
getId in interface SecurityElement
Returns:
id

setId

public void setId(String id)
Specified by:
setId in interface SecurityElement

getNamespaceURI

public String getNamespaceURI()
Specified by:
getNamespaceURI in interface SecurityElement
Returns:
namespace uri of the security header element.

getLocalPart

public 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 String setAttribute(@NotNull
                           String nsUri,
                           @NotNull
                           String localName,
                           @NotNull
                           String value)

setAttribute

public String setAttribute(@NotNull
                           QName name,
                           @NotNull
                           String value)

getAttribute

public String getAttribute(@NotNull
                           String nsUri,
                           @NotNull
                           String localName)

getAttribute

public String getAttribute(@NotNull
                           QName name)

readHeader

public XMLStreamReader readHeader()
                           throws 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:
XMLStreamException

writeTo

public void writeTo(XMLStreamWriter streamWriter)
             throws XMLStreamException
Writes out the header.

Specified by:
writeTo in interface SecurityElementWriter
Throws:
XMLStreamException - if the operation fails for some reason. This leaves the writer to an undefined state.

writeTo

public void writeTo(XMLStreamWriter streamWriter,
                    HashMap props)
             throws XMLStreamException
Specified by:
writeTo in interface SecurityElementWriter
Parameters:
streamWriter -
props -
Throws:
XMLStreamException

writeTo

public void writeTo(OutputStream os)
Specified by:
writeTo in interface SecurityElementWriter
Parameters:
os -

getReferencedSecHeaderElements

public List<String> getReferencedSecHeaderElements()

addReferencedSecHeaderElement

public void addReferencedSecHeaderElement(String id)

refersToSecHdrWithId

public boolean refersToSecHdrWithId(String id)
Specified by:
refersToSecHdrWithId in interface SecurityHeaderElement
Parameters:
id -
Returns:


Copyright © 2005-2015 Oracle Corporation. All Rights Reserved.