/**
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2006 Sun Microsystems Inc. All Rights Reserved
*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the License). You may not use this file except in
* compliance with the License.
*
* You can obtain a copy of the License at
* See the License for the specific language governing
* permission and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* Header Notice in each file and include the License file
* at opensso/legal/CDDLv1.0.txt.
* If applicable, add the following below the CDDL Header,
* with the fields enclosed by brackets [] replaced by
* your own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* $Id: FSLogoutResponse.java,v 1.4 2008/06/25 05:46:44 qcheng Exp $
* Portions Copyrighted 2014 ForgeRock AS
*/
/**
* This class has methods to create a Liberty <code>LogoutResponse</code>.
*
* @supported.all.api
* @deprecated since 12.0.0
*/
/**
* Default Constructor.
*/
public FSLogoutResponse() {
try {
setIssueInstant(new Date());
providerId = new String();
relayState = new String();
} catch (SAMLException e){
}
}
/**
* Constructor creates <code>FSLogoutResponse</code> object.
*
* @param responseID the value of <code>ResponseID</code> attribute.
* @param inResponseTo the value of <code>inResponseTo</code> attribute.
* @param status the Logout <code>Status</code> object.
* @param providerId the value of <code>ProviderID</code> attribute.
* @param relayState the value of <code>RelayState</code> attribute.
* @throws <code>FSMsgException</code> if this object cannot be created.
*/
throws FSMsgException {
if (this.responseID == null) {
}
} else {
this.responseID = responseID;
}
if (inResponseTo == null) {
}
this.inResponseTo = inResponseTo;
}
this.providerId = providerId;
this.relayState = relayState;
setIssueInstant(new Date());
}
/**
* Constructor creates <code>FSLogoutResponse</code> object from
* a Document element.
*
* @param root the Document element object.
* @throws FSMsgException if this object cannot be created.
* @throws SAMLException if there is an error.
*/
}
}
// Attribute ResponseID
+ "Reponse doesn't have ResponseID.");
}
}
// Attribute InResponseTo
if (inResponseTo == null) {
+ "Response doesn't have InResponseTo.");
}
}
// Attribute IssueInstant
+ "missing IssueInstant");
} else {
try {
} catch (ParseException e) {
"FSLogoutResponse(Element): could not " +
"parse IssueInstant", e);
}
}
}
for (int i = 0; i < length; i++) {
"FSLogoutResponse: included more"
+ " than one <Status>");
}
}
if (providerId != null) {
"FSLogoutResponse: included more"
+ " than one providerId");
}
}
} else {
+ " element:" + childName);
}
}
} // end if childName != null
} // end for loop
}
if (providerId == null) {
"FSLogoutResponse: missing element providerId.");
}
//check for signature
if (signsSize == 1) {
signed = true;
} else if (signsSize != 0) {
"FSLogoutResponse(Element): included more than"
+ " one Signature element.");
}
}
}
/**
* Returns the value of <code>RelayState</code> attribute.
*
* @return the value of <code>RelayState</code> attribute.
* @see #setRelayState(String)
*/
return relayState;
}
/**
* Set the value of <code>RelayState</code> attribute.
*
* @param relayState the value of <code>RelayState</code> attribute.
* @see #getRelayState()
*/
this.relayState = relayState;
}
/**
* Returns the value of <code>InResponseTo</code> attribute.
*
* @return the value of <code>InResponseTo</code> attribute.
* @see #setResponseTo(String)
*/
return inResponseTo;
}
/**
* Sets the value of <code>InResponseTo</code> attribute.
*
* @param inResponseTo the value of <code>InResponseTo</code> attribute.
* @see #getResponseTo
*/
this.inResponseTo = inResponseTo;
}
/**
* Returns the value of <code>id</code> attribute.
*
* @return the value of <code>id</code> attribute.
* @see #setID(String)
*/
return id;
}
/**
* Sets the value of <code>id</code> attribute.
*
* @param id the value of <code>id</code> attribute.
* @see #getID()
*/
}
/**
* Returns the value of <code>ProviderID</code> attribute.
*
* @return the value of <code>ProviderID</code> attribute.
* @see #setProviderId(String).
*/
return providerId;
}
/**
* Sets the value of <code>ProviderID</code> attribute.
*
* @param providerId the value of <code>ProviderID</code> attribute.
* @see #getProviderId()
*/
this.providerId = providerId;
}
/**
* Returns the Signed <code>LogoutResponse</code> string.
*
* @return signatureString the Signed <code>LogoutResponse</code> string.
*/
return signatureString;
}
/**
* Returns the value of <code>MinorVersion</code> attribute.
*
* @return the value of <code>MinorVersion</code> attribute.
* @see #setMinorVersion(int)
*/
public int getMinorVersion() {
return minorVersion;
}
/**
* Sets the value of <code>MinorVersion</code> attribute.
*
* @param version thevalue of <code>MinorVersion</code> attribute.
* @see #getMinorVersion()
*/
}
/**
* Returns the Logout <code>Status</code>.
*
* @return the Logout <code>Status</code>.
* @see #setStatus(String)
* @see #setStatus(Status)
*/
return status;
}
/**
* Sets the Logout <code>Status</code>.
*
* @param status the Logout <code>Status</code code.
* @see #getStatus
*/
try {
} catch (Exception e) {
+ "set attribute:", e);
}
}
}
/**
* Sets the Logout <code>Status</code>.
*
* @param status the Logout <code>Status</code object.
* @see #getStatus
*/
}
/**
* Sets the <code>MajorVersion</code> by parsing the version string.
*
* @param majorVer a String representing the <code>MajorVersion</code> to
* be set.
* @throws FSMsgException on error.
* @throws SAMLException when the version mismatchs.
*/
throws FSMsgException, SAMLException {
try {
} catch (NumberFormatException e) {
+ "MajorVersion", e);
}
}
+ " the Response is too high.");
}
"responseVersionTooHigh",null);
} else {
+ " the Response is too low.");
}
"responseVersionTooLow",null);
}
}
}
/**
* Sets the <code>MinorVersion</code> by parsing the version string.
*
* @param minorVer a String representing the <code>MinorVersion</code> to
* be set.
* @throws SAMLException when the version mismatchs.
*/
throws FSMsgException, SAMLException {
try {
} catch (NumberFormatException e) {
+ "MinorVersion", e);
}
}
+ " the Response is too high.");
"responseVersionTooHigh",null);
+ " the Response is too low.");
"responseVersionTooLow",null);
}
}
/**
* Returns the <code>FSLogoutResponse</code> object.
*
* @param xml the XML string to be parsed.
* @return <code>FSLogoutResponse</code> object created from the XML string.
* @throws FSMsgException if there is
* error creating the object.
*/
try{
}catch(SAMLException ex){
+ "Error while parsing input xml string");
}
}
return logoutResponse;
}
/**
* Returns a String representation of the <code>LogoutResponse</code>
* object. This method translates the response to an XML string.
*
* @return An XML String representing the logout response.
*/
return this.toXMLString(true, true);
}
/**
* Returns a String representation of the <code>LogoutResponse</code>
* object.
*
* @return An XML String representing the logout response.
* @throws FSMsgException if there is an error converting
* this object ot a string.
*/
throws FSMsgException {
}
/**
* Returns a String representation of the <code>LogoutResponse</code>
* object.
*
* @param includeNS 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.
* @param includeHeader Determines whether the output include the xml
* declaration header.
* @return a string containing the valid XML for this element
* @throws FSMsgException if there is an error converting
* this object ot a string.
*/
boolean includeHeader) throws FSMsgException {
if (includeHeader) {
}
if (includeNS) {
}
if (declareNS) {
} else {
}
}
+ "providerId is null in the response with responseId:"
+ responseID);
}
}
if (responseID != null) {
}
if (inResponseTo != null) {
}
if (signed) {
if (signatureString != null) {
}
}
if (providerId != null) {
}
}
if (relayState != null) {
}
}
/**
* Returns <code>FSLogoutResponse</code> object. The object
* is created by parsing an Base64 encode authentication
* request String.
*
* @param encodedRes the encode string
* @throws FSMsgException if there is an error creating this object.
* @throws SAMLException if there is an error creating this object.
*/
throws FSMsgException, SAMLException {
if (encodedRes != null){
+ "parseBASE64EncodedString: decoded input string: "
}
return parseXML(decodedNameRegRes);
} else {
"FSLogoutResponse.parseBASE64EncodedString"
+ ": null String passed in as argument.");
}
}
}
/**
* Returns a Base64 Encoded String.
*
* @return a Base64 Encoded String.
* @throws FSMsgException if there is an error encoding the string.
*/
if (responseID == null) {
+ "couldn't generate ResponseID.");
}
}
}
/**
* Unsupported operation.
*/
public void signXML() {
}
/**
* Signs the <code>LogoutResponse</code>.
*
* @param certAlias the Certificate Alias.
* @throws XMLSignatureException if this object cannot be signed.
*/
if (signed) {
+ "the assertion is already signed.");
}
"alreadySigned",null);
}
"cannotFindCertAlias",null);
}
try{
this.id, false);
} else if (minorVersion ==
this.getResponseID(), false);
} else {
}
}
signed = true;
xmlString = this.toXMLString(true, true);
} catch (Exception e) {
"signFailed",null);
}
}
/**
* Sets the Signature.
*
* @param elem the Document Element.
* @return true if success otherwise false.
*/
return super.setSignature(elem);
}
/**
* Returns an URL Encoded String.
*
* @return a url encoded query string.
* @throws FSMsgException if there is an error.
*/
+ "toURLEncodedQueryString: providerId is null in "
+ "the response ");
}
if (responseID == null) {
+ "toURLEncodedQueryString: couldn't generate "
+ "responseID.");
}
}
}
if (issueInstant != null) {
} else {
+ "toURLEncodedQueryString: issueInstant missing");
}
}
}
}
return urlEncodedAuthnReq.toString();
}
/**
* Returns <code>FSLogoutResponse</code> object. The
* object is creating by parsing the <code>HttpServletRequest</code>
* object.
*
* @param request the <code>HttpServletRequest</code> object.
* @throws FSMsgException if there is an error creating this object.
* @throws SAMLException if there is an error.
*/
throws FSMsgException, SAMLException {
try {
} catch(NumberFormatException ex){
}
} else {
}
}
try{
} catch (ParseException e){
}
if (providerID != null) {
}
} else {
}
}
if (relayState != null) {
}
}
}
} else {
}
}
return retLogoutResponse;
}
}