Class KeyIdentifier

java.lang.Object
com.sun.xml.ws.security.secext10.AttributedString
com.sun.xml.ws.security.secext10.EncodedString
com.sun.xml.ws.security.secext10.KeyIdentifierType
com.sun.xml.ws.security.opt.impl.reference.KeyIdentifier
All Implemented Interfaces:
KeyIdentifier, Reference, SecurityElement, SecurityElementWriter, SecurityHeaderElement

public class KeyIdentifier extends com.sun.xml.ws.security.secext10.KeyIdentifierType implements KeyIdentifier, SecurityHeaderElement, SecurityElementWriter
Author:
Ashutosh.Shahi@sun.com
  • Constructor Details

    • KeyIdentifier

      public KeyIdentifier(com.sun.xml.ws.api.SOAPVersion sv)
      Creates a new instance of KeyIdentifier
  • Method Details

    • getValueType

      public String getValueType()
      Specified by:
      getValueType in interface KeyIdentifier
      Overrides:
      getValueType in class com.sun.xml.ws.security.secext10.KeyIdentifierType
      Returns:
      the valueType attribute for KeyIdentifier
    • setValueType

      public void setValueType(String valueType)
      Specified by:
      setValueType in interface KeyIdentifier
      Overrides:
      setValueType in class com.sun.xml.ws.security.secext10.KeyIdentifierType
      Parameters:
      valueType - the valueType attribute for KeyIdentifier
    • getEncodingType

      public String getEncodingType()
      Specified by:
      getEncodingType in interface KeyIdentifier
      Overrides:
      getEncodingType in class com.sun.xml.ws.security.secext10.EncodedString
      Returns:
      the encodingType attribute
    • setEncodingType

      public void setEncodingType(String value)
      Specified by:
      setEncodingType in interface KeyIdentifier
      Overrides:
      setEncodingType in class com.sun.xml.ws.security.secext10.EncodedString
      Parameters:
      value - the encodingType attribute
    • getReferenceValue

      public String getReferenceValue()
      Specified by:
      getReferenceValue in interface KeyIdentifier
      Returns:
      the referenced value by this key identifier
    • setReferenceValue

      public void setReferenceValue(String referenceValue)
      Specified by:
      setReferenceValue in interface KeyIdentifier
      Parameters:
      referenceValue - the referenced value by this keyIdentifier
    • 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
      Overrides:
      getId in class com.sun.xml.ws.security.secext10.AttributedString
      Returns:
      id attribute
    • setId

      public void setId(String id)
      Specified by:
      setId in interface SecurityElement
      Overrides:
      setId in class com.sun.xml.ws.security.secext10.AttributedString
      Parameters:
      id -
    • getNamespaceURI

      public String getNamespaceURI()
      Specified by:
      getNamespaceURI in interface SecurityElement
      Returns:
      namespace uri of Keyidentifier.
    • getLocalPart

      public String getLocalPart()
      Gets the local name of this header element.
      Specified by:
      getLocalPart in interface SecurityElement
      Returns:
      this string must be interned.
    • 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 -
    • updateReferenceValue

      public void updateReferenceValue(byte[] kerberosToken) throws com.sun.xml.wss.XWSSecurityException
      Throws:
      com.sun.xml.wss.XWSSecurityException
    • updateReferenceValue

      public void updateReferenceValue(X509Certificate cert) throws com.sun.xml.wss.XWSSecurityException
      Throws:
      com.sun.xml.wss.XWSSecurityException
    • refersToSecHdrWithId

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