BasicExpiringJWKCredential (Shibboleth IdP :: Plugins :: OIDC Common :: Crypto API 2.2.0 API)

java.lang.Object
- org.opensaml.security.credential.AbstractCredential
- - org.opensaml.security.credential.BasicCredential
  - - net.shibboleth.oidc.security.credential.BasicJWKCredential
    - - net.shibboleth.oidc.security.credential.BasicExpiringJWKCredential

All Implemented Interfaces:

ExpiringJWKCredential, JWKCredential, Credential, MutableCredential
```
public class BasicExpiringJWKCredential
extends BasicJWKCredential
implements ExpiringJWKCredential
```
Basic implementation of an ExpiringJWKCredential.

Since:

2.2.0

Field Summary

Fields
Modifier and Type Field Description

private Duration credentialExpiresAt
When the credential expires in seconds since 1970-01-01T0:0:0Z.

Constructor Summary

Constructors
Constructor Description

BasicExpiringJWKCredential()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Duration`	`getCredentialExpiresAt()`	Time at which the client_secret will expire or 0 if it will not expire.
`void`	`setCredentialExpiresAt(Duration expiresAt)`	Set the expiry in seconds since 1970-01-01T0:0:0Z.

Methods inherited from class net.shibboleth.oidc.security.credential.BasicJWKCredential
getAlgorithm, getKid, setAlgorithm, setKid

Methods inherited from class org.opensaml.security.credential.BasicCredential
getCredentialType, setEntityId, setPrivateKey, setPublicKey, setSecretKey, setUsageType

Methods inherited from class org.opensaml.security.credential.AbstractCredential
getCredentialContextSet, getEntityId, getKeyNames, getPrivateKey, getPublicKey, getSecretKey, getUsageType

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensaml.security.credential.Credential
getCredentialContextSet, getCredentialType, getEntityId, getKeyNames, getPrivateKey, getPublicKey, getSecretKey, getUsageType

Methods inherited from interface net.shibboleth.oidc.security.credential.JWKCredential
getAlgorithm, getKid

- Field Detail
  - credentialExpiresAt
```
@Nullable
private Duration credentialExpiresAt
```
    When the credential expires in seconds since 1970-01-01T0:0:0Z. 0 seconds represents no expiry.
- Constructor Detail
  - BasicExpiringJWKCredential
```
public BasicExpiringJWKCredential()
```
- Method Detail
  - getCredentialExpiresAt
```
public Duration getCredentialExpiresAt()
```
    Description copied from interface: ExpiringJWKCredential
    
    Time at which the client_secret will expire or 0 if it will not expire. Its value represents the number of seconds from 1970-01-01T0:0:0Z.
    
    Specified by:
    
    getCredentialExpiresAt in interface ExpiringJWKCredential
    
    Returns:
    
    the expiry duration
  - setCredentialExpiresAt
```
public void setCredentialExpiresAt(@Nonnull
                                   Duration expiresAt)
```
    Set the expiry in seconds since 1970-01-01T0:0:0Z.
    
    Parameters:
    
    expiresAt - the expiry.