Response.
*
* The Response message element is used when a response consists
* of a list of zero or more assertions that satisfy the request. It has the
* complex type ResponseType.
* *
* <complexType name="ResponseType">
* <complexContent>
* <extension base="{urn:oasis:names:tc:SAML:2.0:protocol}StatusResponseType">
* <choice maxOccurs="unbounded" minOccurs="0">
* <element ref="{urn:oasis:names:tc:SAML:2.0:assertion}Assertion"/>
* <element ref="{urn:oasis:names:tc:SAML:2.0:assertion}EncryptedAssertion"/>
* </choice>
* </extension>
* </complexContent>
* </complexType>
*
*/
public class ResponseImpl extends StatusResponseImpl implements Response {
private List assertions = null;
private List encAssertions = null;
private void parseElement(Element element)
throws SAML2Exception {
// make sure that the input xml block is not null
if (element == null) {
if (SAML2SDKUtils.debug.messageEnabled()) {
SAML2SDKUtils.debug.message("ResponseImpl.parseElement: "
+ "element input is null.");
}
throw new SAML2Exception(
SAML2SDKUtils.bundle.getString("nullInput"));
}
// Make sure this is an Response.
String tag = null;
tag = element.getLocalName();
if ((tag == null) || (!tag.equals("Response"))) {
if (SAML2SDKUtils.debug.messageEnabled()) {
SAML2SDKUtils.debug.message("ResponseImpl.parseElement: "
+ "not Response.");
}
throw new SAML2Exception(
SAML2SDKUtils.bundle.getString("wrongInput"));
}
// handle the attributes of Response in
* Element format.
*
* @param element the Document Element.
* @throws SAML2Exception if there is an error.
*/
public ResponseImpl(org.w3c.dom.Element element)
throws SAML2Exception {
parseElement(element);
if (isSigned) {
signedXMLString = XMLUtils.print(element,
"UTF-8");
}
}
/**
* Class constructor with Response in xml string format.
*
* @param xmlString the Response String..
* @throws SAML2Exception if there is an error.
*/
public ResponseImpl(String xmlString)
throws SAML2Exception {
Document doc = XMLUtils.toDOMDocument(xmlString, SAML2SDKUtils.debug);
if (doc == null) {
throw new SAML2Exception(
SAML2SDKUtils.bundle.getString("errorObtainingElement"));
}
parseElement(doc.getDocumentElement());
if (isSigned) {
signedXMLString = xmlString;
}
}
/**
* Returns Assertion(s) of the response.
*
* @return List of Assertion(s) in the response.
* @see #setAssertion(List)
*/
public List getAssertion() {
return assertions;
}
/**
* Sets Assertion(s) of the response.
*
* @param value List of new Assertion(s).
* @throws SAML2Exception if the object is immutable.
* @see #getAssertion()
*/
public void setAssertion(List value)
throws SAML2Exception
{
if (isMutable) {
this.assertions = value;
} else {
throw new SAML2Exception(
SAML2SDKUtils.bundle.getString("objectImmutable"));
}
}
/**
* Returns EncryptedAssertion(s) of the response.
*
* @return List of EncryptedAssertion(s) in the response.
* @see #setEncryptedAssertion(List)
*/
public List getEncryptedAssertion() {
return encAssertions;
}
/**
* Sets EncryptedAssertion(s) of the response.
*
* @param value List of new EncryptedAssertion(s).
* @throws SAML2Exception if the object is immutable.
* @see #getEncryptedAssertion()
*/
public void setEncryptedAssertion(List value)
throws SAML2Exception
{
if (isMutable) {
this.encAssertions = value;
} else {
throw new SAML2Exception(
SAML2SDKUtils.bundle.getString("objectImmutable"));
}
}
/**
* Makes this object immutable.
*/
public void makeImmutable() {
if (isMutable) {
if (assertions != null) {
Iterator iter = assertions.iterator();
while (iter.hasNext()) {
((Assertion) iter.next()).makeImmutable();
}
assertions = Collections.unmodifiableList(assertions);
}
if (encAssertions != null) {
encAssertions = Collections.unmodifiableList(encAssertions);
}
super.makeImmutable();
}
}
/**
* Returns a String representation of this Object.
*
* @return a String representation of this Object.
* @throws SAML2Exception if it could not create String object
*/
public String toXMLString() throws SAML2Exception {
return this.toXMLString(true, false);
}
/**
* Returns a String representation of this Object.
*
* @param includeNSPrefix determines whether or not the namespace
* qualifier is prepended to the Element when converted
* @param declareNS determines whether or not the namespace is declared
* within the Element.
* @throws SAML2Exception if it could not create String object.
* @return a String representation of this Object.
**/
public String toXMLString(boolean includeNSPrefix, boolean declareNS)
throws SAML2Exception {
if (isSigned && signedXMLString != null) {
return signedXMLString;
}
this.validateData();
StringBuffer result = new StringBuffer(1000);
String prefix = "";
String uri = "";
if (includeNSPrefix) {
prefix = SAML2Constants.PROTOCOL_PREFIX;
}
if (declareNS) {
uri = SAML2Constants.PROTOCOL_DECLARE_STR;
}
result.append("<").append(prefix).append("Response").
append(uri).append(" ID=\"").append(responseId).append("\"");
if (inResponseTo != null && inResponseTo.trim().length() != 0) {
result.append(" InResponseTo=\"").append(inResponseTo).append("\"");
}
result.append(" Version=\"").append(version).append("\"").
append(" IssueInstant=\"").
append(DateUtils.toUTCDateFormat(issueInstant)).append("\"");
if (destination != null && destination.trim().length() != 0) {
result.append(" Destination=\"").append(destination).
append("\"");
}
if (consent != null && consent.trim().length() != 0) {
result.append(" Consent=\"").append(consent).append("\"");
}
result.append(">");
if (issuer != null) {
result.append(issuer.toXMLString(includeNSPrefix, declareNS));
}
if (signatureString != null) {
result.append(signatureString);
}
if (extensions != null) {
result.append(extensions.toXMLString(includeNSPrefix, declareNS));
}
result.append(status.toXMLString(includeNSPrefix, declareNS));
if (assertions != null) {
Iterator iter = assertions.iterator();
while (iter.hasNext()) {
result.append(((Assertion) iter.next()).toXMLString(
includeNSPrefix, declareNS));
}
}
if (encAssertions != null) {
Iterator iter1 = encAssertions.iterator();
while (iter1.hasNext()) {
result.append(((EncryptedAssertion) iter1.next()).toXMLString(
includeNSPrefix, declareNS));
}
}
result.append("");
return result.toString();
}
}