com.sun.xml.ws.security.opt.impl.incoming
Class ReferenceListHeader

java.lang.Object
  extended by com.sun.xml.ws.security.opt.impl.incoming.ReferenceListHeader
All Implemented Interfaces:
PolicyBuilder, SecurityElement, SecurityElementWriter, SecurityHeaderElement

public class ReferenceListHeader
extends Object
implements SecurityHeaderElement, SecurityElementWriter, PolicyBuilder

Author:
Ashutosh.Shahi@sun.com

Constructor Summary
ReferenceListHeader(XMLStreamReader reader, JAXBFilterProcessingContext pc)
          Creates a new instance of ReferenceListHeader
 
Method Summary
 String getId()
           
 String getLocalPart()
          Gets the local name of this header element.
 String getNamespaceURI()
           
 List<String> getPendingReferenceList()
           
 WSSPolicy getPolicy()
          returns the WSSPolicy that was created for the SecurityHeaderElement
 List<String> getReferenceList()
           
 XMLStreamReader readHeader()
          Reads the header as a XMLStreamReader.
 boolean refersToSecHdrWithId(String id)
           
 void setId(String id)
           
 void writeTo(OutputStream os)
           
 void writeTo(XMLStreamWriter streamWriter)
          Writes out the header.
 void writeTo(XMLStreamWriter streamWriter, HashMap props)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ReferenceListHeader

public ReferenceListHeader(XMLStreamReader reader,
                           JAXBFilterProcessingContext pc)
                    throws XMLStreamException
Creates a new instance of ReferenceListHeader

Throws:
XMLStreamException
Method Detail

refersToSecHdrWithId

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

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.

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(OutputStream os)
Specified by:
writeTo in interface SecurityElementWriter

writeTo

public void writeTo(XMLStreamWriter streamWriter)
             throws XMLStreamException
Description copied from interface: SecurityElementWriter
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.

getReferenceList

public List<String> getReferenceList()

getPendingReferenceList

public List<String> getPendingReferenceList()

writeTo

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

getPolicy

public WSSPolicy getPolicy()
Description copied from interface: PolicyBuilder
returns the WSSPolicy that was created for the SecurityHeaderElement

Specified by:
getPolicy in interface PolicyBuilder
Returns:
WSSPolicy


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