Packagecom.kaazing.gateway.client.security
Classpublic class ChallengeResponse

A challenge response contains a byte array representing the response to the server, and a reference to the next challenge handler to handle any further challenges for the request.



Public Properties
 PropertyDefined by
  credentials : ByteArray
Return a set of credentials to send to the server in an 'Authorization:' header.
ChallengeResponse
  nextChallengeHandler : ChallengeHandler
ChallengeResponse
Public Methods
 MethodDefined by
  
ChallengeResponse(credentials:ByteArray, nextChallengeHandler:ChallengeHandler)
Constructor from a set of credentials to send to the server in an 'Authorization:' header and the next challenge handler responsible for handling any further 401 challenges for the request.
ChallengeResponse
  
Clear the credentials of this response.
ChallengeResponse
  
getCredentials():ByteArray
Return a set of credentials to send to the server in an 'Authorization:' header.
ChallengeResponse
  
Return the next challenge handler responsible for handling any further 401 challenges for the request.
ChallengeResponse
  
setCredentials(credentials:ByteArray):void
Establish the credentials for this response.
ChallengeResponse
  
setNextChallengeHandler(nextChallengeHandler:ChallengeHandler):void
Establish the next challenge handler responsible for handling any further 401 challenges for the request.
ChallengeResponse
Property detail
credentialsproperty
credentials:ByteArray  [read-write]

Return a set of credentials to send to the server in an 'Authorization:' header.

Implementation
    public function get credentials():ByteArray
    public function set credentials(value:ByteArray):void
nextChallengeHandlerproperty 
nextChallengeHandler:ChallengeHandler  [read-write]Implementation
    public function get nextChallengeHandler():ChallengeHandler
    public function set nextChallengeHandler(value:ChallengeHandler):void
Constructor detail
ChallengeResponse()constructor
public function ChallengeResponse(credentials:ByteArray, nextChallengeHandler:ChallengeHandler)

Constructor from a set of credentials to send to the server in an 'Authorization:' header and the next challenge handler responsible for handling any further 401 challenges for the request.

Parameters
credentials:ByteArray — a set of credentials to send to the server in an 'Authorization:' header
 
nextChallengeHandler:ChallengeHandler — the next challenge handler responsible for handling any further 401 challenges for the request.
Method detail
clearCredentials()method
public function clearCredentials():void

Clear the credentials of this response.

Calling this method once the credentials have been communicated to the network layer protects credentials in memory.

getCredentials()method 
public function getCredentials():ByteArray

Return a set of credentials to send to the server in an 'Authorization:' header.

Returns
ByteArray — a set of credentials to send to the server in an 'Authorization:' header.
getNextChallengeHandler()method 
public function getNextChallengeHandler():ChallengeHandler

Return the next challenge handler responsible for handling any further 401 challenges for the request.

Returns
ChallengeHandler — the next challenge handler responsible for handling any further 401 challenges for the request.
setCredentials()method 
public function setCredentials(credentials:ByteArray):void

Establish the credentials for this response.

Parameters
credentials:ByteArray — the credentials to be used for this challenge response.
setNextChallengeHandler()method 
public function setNextChallengeHandler(nextChallengeHandler:ChallengeHandler):void

Establish the next challenge handler responsible for handling any further 401 challenges for the request.

Parameters
nextChallengeHandler:ChallengeHandler — the next challenge handler responsible for handling any further 401 challenges for the request.