javax.security.auth
Interface Refreshable

All Known Implementing Classes:
KerberosTicket sample code for javax.security.auth.kerberos.KerberosTicket definition code for javax.security.auth.kerberos.KerberosTicket

public interface Refreshable

Objects such as credentials may optionally implement this interface to provide the capability to refresh itself. For example, a credential with a particular time-restricted lifespan may implement this interface to allow callers to refresh the time period for which it is valid.

See Also:
Subject sample code for javax.security.auth.Subject definition code for javax.security.auth.Subject

Method Summary
 boolean isCurrent sample code for javax.security.auth.Refreshable.isCurrent() definition code for javax.security.auth.Refreshable.isCurrent() ()
          Determine if this Object is current.
 void refresh sample code for javax.security.auth.Refreshable.refresh() definition code for javax.security.auth.Refreshable.refresh() ()
          Update or extend the validity period for this Object.
 

Method Detail

isCurrent sample code for javax.security.auth.Refreshable.isCurrent() definition code for javax.security.auth.Refreshable.isCurrent()

boolean isCurrent()
Determine if this Object is current.

Returns:
true if this Object is currently current, false otherwise.

refresh sample code for javax.security.auth.Refreshable.refresh() definition code for javax.security.auth.Refreshable.refresh()

void refresh()
             throws RefreshFailedException sample code for javax.security.auth.RefreshFailedException definition code for javax.security.auth.RefreshFailedException 
Update or extend the validity period for this Object.

Throws:
SecurityException sample code for java.lang.SecurityException definition code for java.lang.SecurityException - if the caller does not have permission to update or extend the validity period for this Object.

RefreshFailedException sample code for javax.security.auth.RefreshFailedException definition code for javax.security.auth.RefreshFailedException - if the refresh attempt failed.