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

java.lang.Object
  extended by com.sun.xml.ws.security.opt.impl.incoming.KerberosBinarySecurityToken
All Implemented Interfaces:
BinarySecurityToken, KerberosBinarySecurityToken, Token, NamespaceContextInfo, PolicyBuilder, SecurityElement, SecurityElementWriter, SecurityHeaderElement, TokenValidator

public class KerberosBinarySecurityToken
extends Object
implements KerberosBinarySecurityToken, SecurityHeaderElement, PolicyBuilder, TokenValidator, NamespaceContextInfo, SecurityElementWriter

Author:
ashutosh.shahi@sun.com

Constructor Summary
KerberosBinarySecurityToken(XMLStreamReader reader, StreamReaderBufferCreator creator, HashMap nsDecl, XMLInputFactory staxIF)
          Creates a new instance of KerberosBinarySecurityToken
 
Method Summary
 String getEncodingType()
           
 String getId()
           
 HashMap<String,String> getInscopeNSContext()
          map of all inscope namespace declarations.
 String getLocalPart()
          Gets the local name of this header element.
 String getNamespaceURI()
           
 WSSPolicy getPolicy()
          returns the WSSPolicy that was created for the SecurityHeaderElement
 byte[] getTokenValue()
           
 String getValueType()
           
 XMLStreamReader readHeader()
          Reads the header as a XMLStreamReader.
 boolean refersToSecHdrWithId(String id)
           
 void setId(String id)
           
 void validate(ProcessingContext context)
          Peforms token validation , eg: In case BinarySecurityToken checks if the token is valid.
 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

KerberosBinarySecurityToken

public KerberosBinarySecurityToken(XMLStreamReader reader,
                                   StreamReaderBufferCreator creator,
                                   HashMap nsDecl,
                                   XMLInputFactory staxIF)
                            throws XMLStreamException,
                                   XMLStreamBufferException
Creates a new instance of KerberosBinarySecurityToken

Throws:
XMLStreamException
XMLStreamBufferException
Method Detail

getValueType

public String getValueType()
Specified by:
getValueType in interface BinarySecurityToken

getEncodingType

public String getEncodingType()
Specified by:
getEncodingType in interface BinarySecurityToken

getTokenValue

public byte[] getTokenValue()
Specified by:
getTokenValue in interface BinarySecurityToken

getId

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

refersToSecHdrWithId

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

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

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

validate

public void validate(ProcessingContext context)
              throws XWSSecurityException
Description copied from interface: TokenValidator
Peforms token validation , eg: In case BinarySecurityToken checks if the token is valid.

Specified by:
validate in interface TokenValidator
Throws:
XWSSecurityException

getInscopeNSContext

public HashMap<String,String> getInscopeNSContext()
Description copied from interface: NamespaceContextInfo
map of all inscope namespace declarations.

Specified by:
getInscopeNSContext in interface NamespaceContextInfo
Returns:
HashMap of all inscope namespaces.

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.

writeTo

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

writeTo

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


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