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

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

public class KeyIdentifier
extends KeyIdentifierType
implements KeyIdentifier, SecurityHeaderElement, SecurityElementWriter

Author:
Ashutosh.Shahi@sun.com

Field Summary
 
Fields inherited from class com.sun.xml.ws.security.secext10.KeyIdentifierType
valueType
 
Fields inherited from class com.sun.xml.ws.security.secext10.EncodedString
encodingType
 
Fields inherited from class com.sun.xml.ws.security.secext10.AttributedString
id, value
 
Constructor Summary
KeyIdentifier(SOAPVersion sv)
          Creates a new instance of KeyIdentifier
 
Method Summary
 String getAttribute(QName name)
           
 String getAttribute(String nsUri, String localName)
           
 String getEncodingType()
          Gets the value of the encodingType property.
 String getId()
          Gets the value of the id property.
 String getLocalPart()
          Gets the local name of this header element.
 String getNamespaceURI()
           
 String getReferenceValue()
           
 String getType()
           
 String getValueType()
          Gets the value of the valueType property.
 XMLStreamReader readHeader()
          Reads the header as a XMLStreamReader.
 boolean refersToSecHdrWithId(String id)
           
 void setEncodingType(String value)
          Sets the value of the encodingType property.
 void setId(String id)
          Sets the value of the id property.
 void setReferenceValue(String referenceValue)
           
 void setValueType(String valueType)
          Sets the value of the valueType property.
 void updateReferenceValue(byte[] kerberosToken)
           
 void updateReferenceValue(X509Certificate cert)
           
 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.AttributedString
getOtherAttributes, getValue, setValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

KeyIdentifier

public KeyIdentifier(SOAPVersion sv)
Creates a new instance of KeyIdentifier

Method Detail

getValueType

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

Specified by:
getValueType in interface KeyIdentifier
Overrides:
getValueType in class KeyIdentifierType
Returns:
the valueType attribute for KeyIdentifier

setValueType

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

Specified by:
setValueType in interface KeyIdentifier
Overrides:
setValueType in class KeyIdentifierType
Parameters:
valueType - the valueType attribute for KeyIdentifier

getEncodingType

public String getEncodingType()
Description copied from class: EncodedString
Gets the value of the encodingType property.

Specified by:
getEncodingType in interface KeyIdentifier
Overrides:
getEncodingType in class EncodedString
Returns:
the encodingType attribute

setEncodingType

public void setEncodingType(String value)
Description copied from class: EncodedString
Sets the value of the encodingType property.

Specified by:
setEncodingType in interface KeyIdentifier
Overrides:
setEncodingType in class 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()
Description copied from class: AttributedString
Gets the value of the id property.

Specified by:
getId in interface SecurityElement
Overrides:
getId in class AttributedString
Returns:
id attribute

setId

public void setId(String id)
Description copied from class: AttributedString
Sets the value of the id property.

Specified by:
setId in interface SecurityElement
Overrides:
setId in class 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 XWSSecurityException
Throws:
XWSSecurityException

updateReferenceValue

public void updateReferenceValue(X509Certificate cert)
                          throws XWSSecurityException
Throws:
XWSSecurityException

refersToSecHdrWithId

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


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