com.sun.identity.liberty.ws.authnsvc.protocol
Class SASLResponse

java.lang.Object
  extended bycom.sun.identity.liberty.ws.authnsvc.protocol.SASLResponse

public class SASLResponse
extends java.lang.Object

The SASLResponse class represents SASLResponse element defined in Authentication Service schema.


Field Summary
static java.lang.String ABORT
          Abort status where the server is aborting the authentication exchange.
static java.lang.String CONTINUE
          Continue status where the server expects the client to send another SASLRequest
static java.lang.String OK
          OK status where the server considers the authentication exchange to have successfully completed.
 
Constructor Summary
SASLResponse(org.w3c.dom.Element element)
          This constructor takes a org.w3c.dom.Element.
SASLResponse(java.lang.String statusCode)
          Constructs a SASLResponse instance.
 
Method Summary
 java.util.List getCredentials()
          Returns a list of child Element of 'Credentials' Element
 byte[] getData()
          Returns value of Element 'Data'
 java.lang.String getId()
          Returns value of id attribute.
 java.lang.String getMessageID()
          Returns value of messageID attribute of CorrelationHeader.
 PasswordTransforms getPasswordTransforms()
          Returns child Element 'PasswordTransforms'
 java.lang.String getRefToMessageID()
          Returns value of refToMessageID attribute of CorrelationHeader.
 ResourceOffering getResourceOffering()
          Returns Element ResourceOffering.
 java.lang.String getServerMechanism()
          Returns value of serverMechanism attribute.
 java.lang.String getStatusCode()
          Returns value of attribute 'code' of Element 'Status'
 void setCredentials(java.util.List credentials)
          Sets a list of child Elements of 'Credentials' Element.
 void setData(byte[] data)
          Sets value of Element 'Data'.
 void setId(java.lang.String id)
          Sets value of id attribute.
 void setMessageID(java.lang.String messageID)
          Sets value of messageID attribute of CorrelationHeader.
 void setPasswordTransforms(PasswordTransforms passwordTransforms)
          Sets child Element 'PasswordTransforms'
 void setRefToMessageID(java.lang.String refToMessageID)
          Sets value of refToMessageID attribute of CorrelationHeader.
 void setResourceOffering(ResourceOffering resourceOffering)
          Sets Element ResourceOffering.
 void setServerMechanism(java.lang.String serverMechanism)
          Sets value of mechanism attribute.
 void setStatusCode(java.lang.String statusCode)
          Sets value of attribute 'code' of Element 'Status'.
 org.w3c.dom.Element toElement()
          Returns SASLResponse in org.w3c.dom.Element format.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CONTINUE

public static final java.lang.String CONTINUE
Continue status where the server expects the client to send another SASLRequest

See Also:
Constant Field Values

ABORT

public static final java.lang.String ABORT
Abort status where the server is aborting the authentication exchange.

See Also:
Constant Field Values

OK

public static final java.lang.String OK
OK status where the server considers the authentication exchange to have successfully completed.

See Also:
Constant Field Values
Constructor Detail

SASLResponse

public SASLResponse(java.lang.String statusCode)
Constructs a SASLResponse instance.

Parameters:
statusCode - Status Code.

SASLResponse

public SASLResponse(org.w3c.dom.Element element)
             throws AuthnSvcException
This constructor takes a org.w3c.dom.Element.

Parameters:
element - a SASLResponse element
Throws:
AuthnSvcException - if an error occurs while parsing the SASLResponse element
Method Detail

getStatusCode

public java.lang.String getStatusCode()
Returns value of attribute 'code' of Element 'Status'

Returns:
value of attribute 'code' of Element 'Status'

getPasswordTransforms

public PasswordTransforms getPasswordTransforms()
Returns child Element 'PasswordTransforms'

Returns:
child Element 'PasswordTransforms'

getData

public byte[] getData()
Returns value of Element 'Data'

Returns:
value of Element 'Data'

getResourceOffering

public ResourceOffering getResourceOffering()
Returns Element ResourceOffering.

Returns:
Element ResourceOffering.

getCredentials

public java.util.List getCredentials()
Returns a list of child Element of 'Credentials' Element

Returns:
a list of child Element of 'Credentials' Element

getServerMechanism

public java.lang.String getServerMechanism()
Returns value of serverMechanism attribute.

Returns:
value of serverMechanism attribute

getId

public java.lang.String getId()
Returns value of id attribute.

Returns:
value of id attribute

getMessageID

public java.lang.String getMessageID()
Returns value of messageID attribute of CorrelationHeader.

Returns:
value of messageID attribute

getRefToMessageID

public java.lang.String getRefToMessageID()
Returns value of refToMessageID attribute of CorrelationHeader.

Returns:
value of refToMessageID attribute

setStatusCode

public void setStatusCode(java.lang.String statusCode)
Sets value of attribute 'code' of Element 'Status'.

Parameters:
statusCode - value of attribute 'code' of Element 'Status'

setPasswordTransforms

public void setPasswordTransforms(PasswordTransforms passwordTransforms)
Sets child Element 'PasswordTransforms'

Parameters:
passwordTransforms - Element 'PasswordTransforms'

setData

public void setData(byte[] data)
Sets value of Element 'Data'.

Parameters:
data - value of Element 'Data'

setResourceOffering

public void setResourceOffering(ResourceOffering resourceOffering)
Sets Element ResourceOffering.

Parameters:
resourceOffering - Element ResourceOffering

setCredentials

public void setCredentials(java.util.List credentials)
Sets a list of child Elements of 'Credentials' Element.

Parameters:
credentials - a list of child Elements of 'Credentials' Element

setServerMechanism

public void setServerMechanism(java.lang.String serverMechanism)
Sets value of mechanism attribute.

Parameters:
serverMechanism - value of mechanism attribute

setId

public void setId(java.lang.String id)
Sets value of id attribute.

Parameters:
id - value of id attribute

setMessageID

public void setMessageID(java.lang.String messageID)
Sets value of messageID attribute of CorrelationHeader.

Parameters:
messageID - value of messageID attribute

setRefToMessageID

public void setRefToMessageID(java.lang.String refToMessageID)
Sets value of refToMessageID attribute of CorrelationHeader.

Parameters:
refToMessageID - value of refToMessageID attribute

toElement

public org.w3c.dom.Element toElement()
                              throws AuthnSvcException
Returns SASLResponse in org.w3c.dom.Element format.

Returns:
SASLResponse in org.w3c.dom.Element format.
Throws:
AuthnSvcException - if an error occurs while creating the SASLResponse element


Copyright 2005 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.