NIST-SIP: The Reference Implementation for JAIN-SIP 1.2

gov.nist.javax.sip.clientauthutils
Interface AuthenticationHelper

All Known Implementing Classes:
AuthenticationHelperImpl

public interface AuthenticationHelper

A helper interface that provides useful functionality for clients that need to authenticate with servers.

Since:
2.0
Author:
Emil Ivov, Jeroen van Bemmel, M. Ranganathan

Method Summary
 ClientTransaction handleChallenge(Response challenge, ClientTransaction challengedTransaction, SipProvider transactionCreator, int cacheTime)
          Uses securityAuthority to determinie a set of valid user credentials for the specified Response (Challenge) and appends it to the challenged request so that it could be retransmitted.
 void removeCachedAuthenticationHeaders(String callId)
          Remove cached entry.
 void setAuthenticationHeaders(Request request)
          Attach authentication headers to the given request.
 

Method Detail

handleChallenge

ClientTransaction handleChallenge(Response challenge,
                                  ClientTransaction challengedTransaction,
                                  SipProvider transactionCreator,
                                  int cacheTime)
                                  throws SipException,
                                         NullPointerException
Uses securityAuthority to determinie a set of valid user credentials for the specified Response (Challenge) and appends it to the challenged request so that it could be retransmitted.

Parameters:
challenge - the 401/407 challenge response
challengedTransaction - the transaction established by the challenged request
transactionCreator - the JAIN SipProvider that we should use to create the new transaction.
cacheTimeout - The amount of time (seconds ) for which the authentication helper will keep a reference to the generated credentials in a cache. If you specify -1, then the authentication credentials are cached until you remove them from the cache. If you choose this option, make sure you remove the cached headers or you will have a memory leak.
Returns:
a transaction containing a reoriginated request with the necessary authorization header.
Throws:
SipException - if we get an exception white creating the new transaction
NullPointerException - if an argument or a header is null.

setAuthenticationHeaders

void setAuthenticationHeaders(Request request)
Attach authentication headers to the given request. This looks up the credential cache and picks up any stored authentication headers for the given call ID and attaches it to the request.

Parameters:
request - - the request for which we attach the authentication headers.

removeCachedAuthenticationHeaders

void removeCachedAuthenticationHeaders(String callId)
Remove cached entry.

Parameters:
callId - -- the call Id for which we want to remove the cached headers.

NIST-SIP: The Reference Implementation for JAIN-SIP 1.2

A product of the NIST/ITL Advanced Networking Technologies Division.
See conditions of use.
Submit a bug report or feature request.