|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.sun.identity.saml.protocol.AbstractResponse com.sun.identity.federation.message.FSNameRegistrationResponse
public class FSNameRegistrationResponse
This class has methods to create NameRegistrationResponse
object.
Field Summary | |
---|---|
protected String |
id
|
protected int |
minorVersion
|
protected String |
signatureString
|
protected String |
xmlString
|
Fields inherited from class com.sun.identity.saml.protocol.AbstractResponse |
---|
inResponseTo, issueInstant, majorVersion, recipient, responseID, signature, signed, valid, validationDone |
Constructor Summary | |
---|---|
FSNameRegistrationResponse()
Default Constructor. |
|
FSNameRegistrationResponse(Element root)
Constructor creates the FSNameRegistrationResponse object
from Document Element. |
|
FSNameRegistrationResponse(String responseID,
String inResponseTo,
Status status,
String providerId,
String relayState)
Constructor creates the FSNameRegistrationResponse object. |
Method Summary | |
---|---|
String |
getID()
Returns the value of id attribute. |
int |
getMinorVersion()
Returns the MinorVersion . |
String |
getProviderId()
Returns the value of ProviderID attribute. |
String |
getRelayState()
Returns the value of RelayState attribute. |
String |
getSignatureString()
Returns the signed NameRegistrationResponse string. |
String |
getSignedXMLString()
Returns signed XML representation of this
object. |
Status |
getStatus()
Returns the Response Status . |
static FSNameRegistrationResponse |
parseBASE64EncodedString(String encodedRes)
Returns FSNameRegistrationResponse object. |
static FSNameRegistrationResponse |
parseURLEncodedRequest(HttpServletRequest request)
Returns FSNameRegistrationLogoutResponse object. |
static FSNameRegistrationResponse |
parseXML(String xml)
Returns the FSNameRegistrationResponse object. |
void |
setID(String id)
Sets the value of id attribute. |
void |
setMinorVersion(int version)
Sets the MinorVersion . |
void |
setProviderId(String providerId)
Sets the value of providerID attribute. |
void |
setRelayState(String relayState)
Set the value of RelayState attribute. |
boolean |
setSignature(Element elem)
Sets the Signature. |
void |
setStatus(Status status)
Sets the Response Status . |
void |
signXML()
Unsupported operation. |
void |
signXML(String certAlias)
Signs the Name Registration Response. |
String |
toBASE64EncodedString()
Returns a Base64 Encoded String. |
String |
toURLEncodedQueryString()
Returns an URL Encoded String. |
String |
toXMLString()
Returns the string representation of this object. |
String |
toXMLString(boolean includeNS,
boolean declareNS)
Returns a String representation of the Logout Response. |
String |
toXMLString(boolean includeNS,
boolean declareNS,
boolean includeHeader)
Returns a String representation of the Logout Response. |
Methods inherited from class com.sun.identity.saml.protocol.AbstractResponse |
---|
getInResponseTo, getIssueInstant, getMajorVersion, getRecipient, getResponseID, getSignature, isSignatureValid, isSigned, setInResponseTo, setIssueInstant, setMajorVersion, setRecipient, setResponseID |
Field Detail |
---|
protected String xmlString
protected String signatureString
protected String id
protected int minorVersion
Constructor Detail |
---|
public FSNameRegistrationResponse()
public FSNameRegistrationResponse(String responseID, String inResponseTo, Status status, String providerId, String relayState) throws FSMsgException
FSNameRegistrationResponse
object.
responseID
- the value of ResponseID
attribute.inResponseTo
- the value of InResponseTo
attribute.status
- the Status
object.providerId
- the value of ProviderID
attribute.relayState
- the value of RelayState
attribute.
FSMsgException
- if there is an error creating this object.public FSNameRegistrationResponse(Element root) throws FSMsgException, SAMLException
FSNameRegistrationResponse
object
from Document Element.
root
- the Document Element objec.t
FSMsgException
- if there is an error creating this object.
SAMLException
- if there is an error creating this object.Method Detail |
---|
public String getRelayState()
RelayState
attribute.
RelayState
attribute.FSNameRegistrationResponse.setRelayState(String)
public void setRelayState(String relayState)
RelayState
attribute.
relayState
- the value of RelayState
attribute.FSNameRegistrationResponse.getRelayState()
public String getID()
id
attribute.
id
attribute.FSNameRegistrationResponse.setID(String)
public void setID(String id)
id
attribute.
id
- the value of id
attribute.FSNameRegistrationResponse.getID()
public String getProviderId()
ProviderID
attribute.
ProviderID
attribute.FSNameRegistrationResponse.setProviderId(String).
public void setProviderId(String providerId)
providerId
- the value of providerID attribute.FSNameRegistrationResponse.getProviderId()
public String getSignedXMLString()
XML
representation of this
object.
XML
representation of this
object.public String getSignatureString()
NameRegistrationResponse
string.
NameRegistrationResponse
string.public int getMinorVersion()
MinorVersion
.
getMinorVersion
in class AbstractResponse
MinorVersion
.FSNameRegistrationResponse.setMinorVersion(int)
public void setMinorVersion(int version)
MinorVersion
.
setMinorVersion
in class AbstractResponse
version
- the MinorVersion
.FSNameRegistrationResponse.getMinorVersion()
public Status getStatus()
Status
.
Status
.FSNameRegistrationResponse.setStatus(Status)
public void setStatus(Status status)
Status
.
status
- the Response Status
See Also:FSNameRegistrationResponse.getStatus()
public static FSNameRegistrationResponse parseXML(String xml) throws FSMsgException
FSNameRegistrationResponse
object.
xml
- the XML string to be parsed.
FSNameRegistrationResponsee
object created from
the XML string.
FSMsgException
- if there is error creating the object.public String toXMLString() throws FSMsgException
FSMsgException
- on error.public String toXMLString(boolean includeNS, boolean declareNS) throws FSMsgException
includeNS
- : Determines whether or not the namespace qualifier
is prepended to the Element when converteddeclareNS
- : Determines whether or not the namespace is declared
within the Element.
FSMsgException
- if there is an error converting
this object to a string.public String toXMLString(boolean includeNS, boolean declareNS, boolean includeHeader) throws FSMsgException
includeNS
- Determines whether or not the namespace qualifier
is prepended to the Element when converteddeclareNS
- Determines whether or not the namespace is declared
within the Element.includeHeader
- Determines whether the output include the xml
declaration header.
FSMsgException
- if there is an error converting
this object to a string.public static FSNameRegistrationResponse parseBASE64EncodedString(String encodedRes) throws FSMsgException, SAMLException
FSNameRegistrationResponse
object. The object
is created by parsing an Base64 encode Name Registration Response
string.
encodedRes
- the encoded response string
FSMsgException
- if there is an error
creating this object.
SAMLException
- if there is an error
creating this object.public String toBASE64EncodedString() throws FSMsgException
FSMsgException
- if there is an error encoding
the string.public void signXML(String certAlias) throws SAMLException
certAlias
- the Certificate Alias.
SAMLException
- if this object cannot be signed.public void signXML() throws SAMLException
signXML
in class AbstractResponse
SAMLException
- if could not sign the object.public boolean setSignature(Element elem)
setSignature
in class AbstractResponse
elem
- the Document Element.
public String toURLEncodedQueryString() throws FSMsgException
FSMsgException
- if there is an error.public static FSNameRegistrationResponse parseURLEncodedRequest(HttpServletRequest request) throws FSMsgException, SAMLException
FSNameRegistrationLogoutResponse
object. The
object is creating by parsing the HttpServletRequest
object.
request
- the HttpServletRequest
object.
FSMsgException
- if there is an error
creating this object.
SAMLException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |