|
NIST-SIP: The Reference Implementation for JAIN-SIP 1.2 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AuthenticationHelper
A helper interface that provides useful functionality for clients that need to authenticate with servers.
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 |
---|
ClientTransaction handleChallenge(Response challenge, ClientTransaction challengedTransaction, SipProvider transactionCreator, int cacheTime) throws SipException, NullPointerException
challenge
- the 401/407 challenge responsechallengedTransaction
- the transaction established by the challenged requesttransactionCreator
- 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.
SipException
- if we get an exception white creating the new transaction
NullPointerException
- if an argument or a header is null.void setAuthenticationHeaders(Request request)
request
- - the request for which we attach the authentication headers.void removeCachedAuthenticationHeaders(String callId)
callId
- -- the call Id for which we want to remove the cached headers.
|
NIST-SIP: The Reference Implementation for JAIN-SIP 1.2 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |