org.idoox.wasp.security.http.digest
Interface HttpDigestConfig


public interface HttpDigestConfig

Interface for configuration of HttpDigest provider.

Component:
Security-Providers

Method Summary
 java.lang.String getAlgorithm()
          Returns digest algorithm used by HttpDigest provider.
 long getContextTTL()
          Returns time to live in seconds.
 java.lang.String getQop()
          Returns quality of protection.
 long getSweepInterval()
          Returns the sweep interval.
 void setAlgorithm(java.lang.String algorithm)
          Set algorithm to used by HttpDigest provider.
 void setContextTTL(long contextTTL)
          Sets time to live in seconds to the given value.
 void setQop(java.lang.String qop)
          Sets "quality of protection" of HttpDigest authentication to the given value.
 void setSweepInterval(long sweepInterval)
          Sets sweep interval to the given value.
 

Method Detail

getAlgorithm

public java.lang.String getAlgorithm()
Returns digest algorithm used by HttpDigest provider. Return value may be MD5 or SHA. Default value is MD5.

Returns:
digest algorithm

setAlgorithm

public void setAlgorithm(java.lang.String algorithm)
Set algorithm to used by HttpDigest provider. Digest algorithm may be MD5 or SHA. Default value is MD5.

Parameters:
algorithm - the given value of digest algorithm to set to

getQop

public java.lang.String getQop()
Returns quality of protection. Returned value may be null or "auth".

Returns:
value of "quality of protection"

setQop

public void setQop(java.lang.String qop)
Sets "quality of protection" of HttpDigest authentication to the given value. Value of "quality of protection" may be null or "auth".

Parameters:
qop - the value of "quality of protection" to set to.

getSweepInterval

public long getSweepInterval()
Returns the sweep interval. This is period of cylic checking whether client context is expired. Default value is 3 min.

Returns:
interval to check whether client context is expired.

setSweepInterval

public void setSweepInterval(long sweepInterval)
Sets sweep interval to the given value. This is period of cylic checking whether client context is expired. Default value is 3 min.

Parameters:
sweepInterval -

getContextTTL

public long getContextTTL()
Returns time to live in seconds. This is time that client context is maintained on the server side. After that, client has to authenticate again. Default value is 10 min.

Returns:
time to live in seconds

setContextTTL

public void setContextTTL(long contextTTL)
Sets time to live in seconds to the given value. This is time that client context is maintained on the server side. After that, client has to authenticate again. Default value is 10 min.

Parameters:
contextTTL - value of time to live to set to