oracle.security.xmlsec.xkms

Class Result

java.lang.Object

oracle.security.xmlsec.util.XMLNode

oracle.security.xmlsec.util.XMLElement

oracle.security.xmlsec.xkms.Message

oracle.security.xmlsec.xkms.Result

Direct Known Subclasses:

CompoundResult, LocateResult, RecoverResult, RegisterResult, ReissueResult, RevokeResult, StatusResult, ValidateResult

public class Result
extends Message

Abstract base class for XKMS result messages. Represents the xkms:ResultType element.

Field Summary

Fields inherited from class oracle.security.xmlsec.util.XMLNode

node, systemId

Constructor Summary

Constructors

Constructor and Description
Result(org.w3c.dom.Document owner) Creates a new Result instance.
Result(org.w3c.dom.Document owner, java.lang.String systemId) Creates a new Result instance.
Result(org.w3c.dom.Document owner, java.lang.String tagName, java.lang.String systemId) Creates a new Result instance.
Result(org.w3c.dom.Element element) Creates a new Result instance.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getRequestID() Returns the value of the RequestID attribute for this message, or null if none is set.
byte[]	getRequestSignatureBytes() Returns the Request Signature bytes for this message or null if none are present.
org.w3c.dom.Element	getRequestSignatureValue() Returns the xkms:RequestSignatureValue element for this message or null if none are present.
java.lang.String	getResultMajor() Returns the value of the ResultMajor attribute for this message, or null if none is set.
java.lang.String	getResultMinor() Returns the value of the ResultMinor attribute for this message, or null if none is set.
void	setRequestID(java.lang.String requestID) Sets the RequestId attribute for this message.
void	setRequestSignatureValue(byte[] sigBytes, java.lang.String id) Set the RequestSignatureValue element for this message.
void	setResultCode(java.lang.String major, java.lang.String minor) Sets the ResultMajor and ResultMinor attributes for this message.

Methods inherited from class oracle.security.xmlsec.xkms.Message

addMessageExtension, clearSignature, getId, getMessageExtensions, getNonce, getOpaqueClientData, getService, getSignature, insertChild, insertChild, removeChildren, setId, setNonce, setOpaqueClientData, setService, setSignature

Methods inherited from class oracle.security.xmlsec.util.XMLElement

addNSPrefixAttr, addNSPrefixAttr, addNSPrefixAttrDefault, addNSPrefixAttrDefault, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getChildElementsByTagName, getChildElementsByTagName, getChildElementsByTagNameNS, getChildElementsByTagNameNS, getDefaultNSPrefix, getElement, getElementsByTagName, getElementsByTagNameNS, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setDefaultNSPrefix

Methods inherited from class oracle.security.xmlsec.util.XMLNode

appendChild, appendChild, appendTo, cloneNode, getAttributes, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNode, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getSystemId, hasAttributes, hasChildNodes, insertBefore, insertBefore, isSupported, normalize, removeChild, removeChild, replaceChild, replaceChild, setNodeValue, setPrefix, setSystemId, toBytesXML, toStringXML

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Result

public Result(org.w3c.dom.Element element)
       throws org.w3c.dom.DOMException

Creates a new Result instance.

Parameters:

element - An Element node in the XML document.

Throws:

org.w3c.dom.DOMException

Result

public Result(org.w3c.dom.Document owner)
       throws org.w3c.dom.DOMException

Creates a new Result instance.

Parameters:

owner - The owner document of the new Result.

Throws:

org.w3c.dom.DOMException

Result

public Result(org.w3c.dom.Document owner,
              java.lang.String systemId)
       throws org.w3c.dom.DOMException

Creates a new Result instance.

Parameters:

owner - The owner document of the new Result.

systemId - The URI string system ID for the Message.

Throws:

org.w3c.dom.DOMException

Result

public Result(org.w3c.dom.Document owner,
              java.lang.String tagName,
              java.lang.String systemId)
       throws org.w3c.dom.DOMException

Creates a new Result instance.

Parameters:

owner - The owner document of the new Result.

systemId - The URI string system ID for the Message.

tagName - The name of the element to be created; for example, "LocateResult" if this Result is to be a X-KISS LocateResult mesage.

Throws:

org.w3c.dom.DOMException

Method Detail

setResultCode

public void setResultCode(java.lang.String major,
                          java.lang.String minor)
                   throws org.w3c.dom.DOMException

Sets the ResultMajor and ResultMinor attributes for this message.

Parameters:

major - The major component of the result code.

minor - The minor component of the result code.

Throws:

org.w3c.dom.DOMException

getResultMajor

public java.lang.String getResultMajor()

Returns the value of the ResultMajor attribute for this message, or null if none is set.

Returns:

The major component of the response code.

getResultMinor

public java.lang.String getResultMinor()

Returns the value of the ResultMinor attribute for this message, or null if none is set.

Returns:

The minor component of the response code.

setRequestID

public void setRequestID(java.lang.String requestID)
                  throws org.w3c.dom.DOMException

Sets the RequestId attribute for this message.

Parameters:

requestID - A unique identifier generated by the requestor.

Throws:

org.w3c.dom.DOMException

getRequestID

public java.lang.String getRequestID()

Returns the value of the RequestID attribute for this message, or null if none is set.

Returns:

A unique identifier generated by the requestor.

setRequestSignatureValue

public void setRequestSignatureValue(byte[] sigBytes,
                                     java.lang.String id)
                              throws org.w3c.dom.DOMException

Set the RequestSignatureValue element for this message.

Parameters:

sigBytes - A byte array containing the signature.

id - An optional string ID name for this SignatureValue structure.

Throws:

org.w3c.dom.DOMException

getRequestSignatureValue

public org.w3c.dom.Element getRequestSignatureValue()

Returns the xkms:RequestSignatureValue element for this message or null if none are present.

Returns:

The RequestSignatureValue instance.

getRequestSignatureBytes

public byte[] getRequestSignatureBytes()

Returns the Request Signature bytes for this message or null if none are present.

Returns:

The request signature bytes.