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

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

public class Signature
extends Object
implements SecurityHeaderElement, NamespaceContextInfo, SecurityElementWriter, PolicyBuilder

Author:
K.Venugopal@sun.com

Field Summary
static String KEYINFO
           
static int KEYINFO_EVENT
           
static String OBJECT
           
static int OBJECT_EVENT
           
static String SIGNATURE_VALUE
           
static int SIGNATUREVALUE_EVENT
           
static String SIGNED_INFO
           
static int SIGNEDINFO_EVENT
           
 
Constructor Summary
Signature(JAXBFilterProcessingContext jpc, Map<String,String> namespaceList, StreamReaderBufferCreator sbc)
          Creates a new instance of SignatureProcessor
Signature(JAXBFilterProcessingContext jpc, Map<String,String> namespaceList, StreamReaderBufferCreator sbc, boolean cacheSig)
           
 
Method Summary
 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
 ArrayList<Reference> getReferences()
           
 boolean isReady()
           
 boolean isValidated()
           
 void process(XMLStreamReader signature)
           
 void process(XMLStreamReader signature, boolean storeSigConfirmValue)
           
 XMLStreamReader readHeader()
          Reads the header as a XMLStreamReader.
 boolean refersToSecHdrWithId(String id)
           
 Reference removeReferenceWithID(String id)
           
 void setId(String id)
           
 boolean validate()
           
 boolean verifyReferences()
           
 boolean verifySignatureValue()
           
 XMLStreamReader wrapWithDigester(Reference ref, XMLStreamReader message, String bodyPrologue, String bodyEpilogue, TagInfoset bodyTag, HashMap<String,String> parentNS, boolean payLoad)
           
 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
 

Field Detail

SIGNEDINFO_EVENT

public static final int SIGNEDINFO_EVENT
See Also:
Constant Field Values

SIGNATUREVALUE_EVENT

public static final int SIGNATUREVALUE_EVENT
See Also:
Constant Field Values

KEYINFO_EVENT

public static final int KEYINFO_EVENT
See Also:
Constant Field Values

OBJECT_EVENT

public static final int OBJECT_EVENT
See Also:
Constant Field Values

SIGNED_INFO

public static final String SIGNED_INFO
See Also:
Constant Field Values

SIGNATURE_VALUE

public static final String SIGNATURE_VALUE
See Also:
Constant Field Values

KEYINFO

public static final String KEYINFO
See Also:
Constant Field Values

OBJECT

public static final String OBJECT
See Also:
Constant Field Values
Constructor Detail

Signature

public Signature(JAXBFilterProcessingContext jpc,
                 Map<String,String> namespaceList,
                 StreamReaderBufferCreator sbc)
Creates a new instance of SignatureProcessor


Signature

public Signature(JAXBFilterProcessingContext jpc,
                 Map<String,String> namespaceList,
                 StreamReaderBufferCreator sbc,
                 boolean cacheSig)
Method Detail

process

public void process(XMLStreamReader signature)
             throws XWSSecurityException
Throws:
XWSSecurityException

process

public void process(XMLStreamReader signature,
                    boolean storeSigConfirmValue)
             throws XWSSecurityException
Throws:
XWSSecurityException

validate

public boolean validate()
                 throws XWSSecurityException
Throws:
XWSSecurityException

removeReferenceWithID

public Reference removeReferenceWithID(String id)

getReferences

public ArrayList<Reference> getReferences()

isValidated

public boolean isValidated()

isReady

public boolean isReady()
                throws XWSSecurityException
Throws:
XWSSecurityException

verifyReferences

public boolean verifyReferences()

verifySignatureValue

public boolean verifySignatureValue()

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.

wrapWithDigester

public XMLStreamReader wrapWithDigester(Reference ref,
                                        XMLStreamReader message,
                                        String bodyPrologue,
                                        String bodyEpilogue,
                                        TagInfoset bodyTag,
                                        HashMap<String,String> parentNS,
                                        boolean payLoad)
                                 throws XWSSecurityException
Throws:
XWSSecurityException

writeTo

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

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.

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.